當(dāng)前位置：首頁 > > HelloGitHub

Google 開源的 Python 命令行庫：深入 fire（二）

時間：2024-12-13 21:19:13
手機看文章

掃描二維碼
隨時隨地手機看文章


一、前言

在上一篇文章中我們介紹了 fire的子命令、嵌套命令和屬性訪問等內(nèi)容，今天我們將繼續(xù)深入了解 fire的其他功能。 

本系列文章默認使用 Python 3 作為解釋器進行講解。
若你仍在使用 Python 2，請注意兩者之間語法和庫的使用差異哦~

二、功能

2.1 最簡命令實現(xiàn)

在上一節(jié)中，我們介紹了只要定義一個函數(shù)就可以實現(xiàn)命令行程序。比如： 

import fire def english(): return 'Hello, fire!' def chinese(): return '你好，fire！' if __name__ == '__main__':
  fire.Fire()

但這還不是最簡單的實現(xiàn)方式，fire甚至允許你通過定義變量的方式來實現(xiàn)命令行！上面的例子可以寫成下面這種形式： 

import fire

english = 'Hello, fire!' chinese = '你好，fire！' if __name__ == '__main__':
  fire.Fire()

2.2 鏈式調(diào)用

在 Fire CLI中，你可以通過鏈式調(diào)用不斷地對上一個結(jié)果進行處理。

想做到這一點也很簡單，就是在實例方法中返回 self即可。

在下面的示例中，我們實現(xiàn)了一個簡單的四則運算命令，可鏈式調(diào)用 add、sub、mul和 div。 

import fire class Calculator: def __init__(self): self.result = 0 self.express = '0' def __str__(self): return f'{self.express} = {self.result}' def add(self, x): self.result += x
    self.express = f'{self.express}+{x}' return self def sub(self, x): self.result -= x
    self.express = f'{self.express}-{x}' return self def mul(self, x): self.result *= x
    self.express = f'({self.express})*{x}' return self def div(self, x): self.result /= x
    self.express = f'({self.express})/{x}' return self if __name__ == '__main__':
  fire.Fire(Calculator)

上述代碼中的 add、sub、mul、div分別對應(yīng)加、減、乘、除的邏輯，每個方法都接受 x參數(shù)作為參與運算的數(shù)字，返回值均為 self，這樣就可以無限次地鏈式調(diào)用。在命令行中鏈式調(diào)用結(jié)束后，會最終調(diào)用到 __str__方法將結(jié)果打印出來。

其中，__str__在 fire中用來完成自定義序列化。如果不提供這個方法，在鏈式調(diào)用完成后將會打印幫助內(nèi)容。

比如，我們可以這么調(diào)用： 

$ python calculator.py add 1 sub 2 mul 3 div 4
((+1-2)*3)/4 = -0.75

$ python calculator.py add 1 sub 2 mul 3 div 4 add 4 sub 3 mul 2 div 1
((((0+1-2)*3)/4+4-3)*2)/1 = 0.5

2.3 位置參數(shù)和選項參數(shù)

通過前面的介紹我們也都清楚了在 fire中不必顯式的定義位置參數(shù)或選項參數(shù)。

通過下面的例子，我們將細化兩類參數(shù)的使用： 

import fire class Building(object): def __init__(self, name, stories=1): self.name = name
    self.stories = stories def __str__(self): return f'name: {self.name}, stories: {self.stories}' def climb_stairs(self, stairs_per_story=10): yield self.name for story in range(self.stories): for stair in range(1, stairs_per_story): yield stair yield 'Phew!' yield 'Done!' if __name__ == '__main__':
  fire.Fire(Building)
  • 構(gòu)造函數(shù)中定義的參數(shù)（如 name和 stories）在命令行中僅為選項參數(shù)（如 --name和 --stories）。我們可以這么調(diào)用： 
$ python example.py --name="Sherrerd Hall" --stories=3
  • 構(gòu)造函數(shù)中定義的參數(shù)可在命令中放于任意位置。比如下面兩個調(diào)用都是可以的： 
$ python example.py --name="Sherrerd Hall" climb-stairs --stairs-per-story 10
$ python example.py climb-stairs --stairs-per-story 10 --name="Sherrerd Hall"
  • 構(gòu)造函數(shù)和普通方法中定義的默認參數(shù)（如 stories），在命令行中是可選的。我們可以這么調(diào)用： 
$ python example.py --name="Sherrerd Hall"
  • 普通方法中定義的參數(shù)（如 stairs_per_story）在命令行中即可以是位置參數(shù)，也可以是選項參數(shù)。我們可以這么調(diào)用： 
# 作為位置參數(shù) $ python example.py --name="Sherrerd Hall" climb_stairs 10 # 作為選項參數(shù) $ python example.py --name="Sherrerd Hall" climb_stairs --stairs_per_story=10
  • 選項參數(shù)中的橫杠（-）和下劃線（_）是等價的。因此也可以這么調(diào)用： 
# 作為選項參數(shù) $ python example.py --name="Sherrerd Hall" climb_stairs --stairs-per-story=10

此外，fire還支持在函數(shù)中定義 *args和 **kwargs。 

import fire def fargs(*args): return str(args) def fkwargs(**kwargs): return str(kwargs) if __name__ == '__main__':
  fire.Fire()
  • 函數(shù)中的 *args在命令行中為位置參數(shù)。我們可以這么調(diào)用： 
$ python example.py fargs a b c
  • 函數(shù)中的 **kwargs在命令行中為選項參數(shù)。我們可以這么調(diào)用： 
$ python example.py fargs --a a1 --b b1 --c c1
  • 通過分隔符 -可顯式告知分隔符后的為子命令，而非命令的參數(shù)。且看下面的示例： 
# 沒有使用分隔符，upper 被作為位置參數(shù) $ python example.py fargs a b c upper
('a', 'b', 'c', 'upper') # 使用了分隔符，upper 被作為子命令 $ python example.py fargs a b c - upper
('A', 'B', 'C')
  • 通過 fire內(nèi)置的 --separator可以自定義分隔符，此選項參數(shù)需要跟在單獨的 --后面： 
$ python example.py a b c X upper -- --separator=X
('A', 'B', 'C')

2.4 參數(shù)類型

在 fire中，參數(shù)的類型由其值決定，通過下面的簡單代碼，我們可以看到給不同的值時，fire會解析為什么類型： 

import fire
fire.Fire(lambda obj: type(obj).__name__)
$ python example.py 10
int
$ python example.py 10.0 float $ python example.py hello
str
$ python example.py '(1,2)' tuple
$ python example.py [1,2]
list
$ python example.py True
bool
$ python example.py {name: David}
dict

如果想傳遞字符串形式的數(shù)字，那就需要小心引號了，要么把引號引起來，要么轉(zhuǎn)義引號： 

# 數(shù)字 10 $ python example.py 10
int # 沒有對引號處理，仍然是數(shù)字10 $ python example.py "10" int # 把引號引起來，所以是字符串“10” $ python example.py '"10"' str # 另一種把引號引起來的形式 $ python example.py "'10'" str # 轉(zhuǎn)義引號 $ python example.py \"10\"
str

考慮下更復(fù)雜的場景，如果傳遞的是字典，在字典中有字符串，那么也是要小心引號的： 

# 推薦做法 $ python example.py '{"name": "David Bieber"}' dict # 也是可以的 $ python example.py {"name":'"David Bieber"'}
dict # 錯誤，會被解析為字符串 $ python example.py {"name":"David Bieber"}
str # 錯誤，不會作為單個參數(shù)（因為中間有空格），報錯 $ python example.py {"name": "David Bieber"}

如果值為 True或 False將為視為布爾值，fire還支持通過 --name將 name設(shè)為 True，或通過 --noname將 name設(shè)為 False： 

$ python example.py --obj=True
bool
$ python example.py --obj=False
bool
$ python example.py --obj
bool
$ python example.py --noobj
bool

2.5 Fire 內(nèi)置選項參數(shù)

Fire 內(nèi)置了一些選項參數(shù)，以幫助我們更容易地使用命令行程序。若想使用內(nèi)置的選項功能，需要將選項參數(shù)跟在 --后，在上文中，我們介紹了 --separator參數(shù)，除了它，fire還支持以下選項參數(shù)：

  • command -- --help列出詳細的幫助信息
  • command -- --interactive進入交互式模式
  • command -- --completion [shell]生成 CLI 程序的自動補全腳本，以支持自動補全
  • command -- --trace獲取命令的 Fire 追蹤以了解調(diào)用 Fire 后究竟發(fā)生了什么
  • command -- --verbose獲取包含私有成員在內(nèi)的詳情

三、小結(jié)

fire讓命令行程序的實現(xiàn)變得特別簡單，本文著重介紹了它的鏈式調(diào)用、選項參數(shù)、位置參數(shù)、參數(shù)類型以及內(nèi)置選項參數(shù)。fire的概念并不多，真正踐行了“把簡單留給他人，把復(fù)雜留給自己”的理念。

本站聲明： 本文章由作者或相關(guān)機構(gòu)授權(quán)發(fā)布，目的在于傳遞更多信息，并不代表本站贊同其觀點，本站亦不保證或承諾內(nèi)容真實性等。需要轉(zhuǎn)載請聯(lián)系該專欄作者，如若文章內(nèi)容侵犯您的權(quán)益，請及時聯(lián)系本站刪除。
關(guān)閉