Python 中用於生成命令列介面（Command Line Interfaces, CLIs）的工具已經有一些了，例如已經成為 Python 標準庫的 argparse 和第三方的 click ，這些都是很不錯的工具。但是這些工具為 Python 程式生成 CLIs 的時候稍顯麻煩，需要增加的地方比較多，過程稍顯繁瑣。今天介紹的這個工具，幾乎可以不改變原始程式碼就可以生成 CLIs，是 Google 於 今年（2017 年）3 月 2 日宣佈在 GitHub 上開源的。

文中的三個程式檔案可以在 這裡 打包下載。

更新

這裡我會列出對本文的更新。

• 2017 年 10 月 18 日：優化排版，與其他博文保持風格統一。

簡介

大致的簡介我在上面簡單說了下，下面我引用下官方簡介：

Python Fire is a library for creating command line interfaces (CLIs) from absolutely any Python object.

• Python Fire is a simple way to create a CLI in Python.
• Python Fire is a helpful tool for developing and debugging Python code.
• Python Fire helps with exploring existing code or turning other people’s code into a CLI.
• Python Fire makes transitioning between Bash and Python easier.
• Python Fire makes using a Python REPL easier by setting up the REPL with the modules and variables you’ll need already imported and created.

可以看出來，Fire 不僅僅是一個生成 CLIs 的工具，而且還可以除錯 Python 程式，互動式的使用 Fire 。

安裝

在命令列中執行 pip install fire

用法

使用 fire 生成 CLIs 的基本用法就是使用 fire.Fire()，可以傳入任意引數，用官方的說法就是 any Python object 。下面我舉三個例子簡單的說明一下用法，更多的用法大家可以參考 The Python Fire Guide 和 Using a Fire CLI 。

下面的例子均是以計算時間差（兩個日期之間相差的天數）的程式為例。

單個函式

檔案 test-fire.py

import fire
import datetime

def cal_days(date_str1, date_str2):
    '''計算兩個日期之間的天數'''

    date_str1 = str(date_str1)
    date_str2 = str(date_str2)
    d1 = datetime.datetime.strptime(date_str1, '%Y%m%d')
    d2 = datetime.datetime.strptime(date_str2, '%Y%m%d')
    delta = d1 - d2
    return delta.days


if __name__ == '__main__':
    fire.Fire(cal_days)

這個程式中只有一個函式 cal_days，最後使用 fire.Fire(cal_days) 來生成 CLIs。

我們可以先用下面的語句檢視幫助資訊：

$ python test-fire.py
Fire trace:
1. Initial component
2. ('The function received no value for the required argument:', 'date_str1')

Type:        function
String form: <function cal_days at 0x000002F0099B7F28>
File:        d:\masterfiles\notebook\test-fire.py
Line:        4
Docstring:   計算兩個日期之間的天數

Usage:       test-fire.py DATE_STR1 DATE_STR2
             test-fire.py --date-str1 DATE_STR1 --date-str2 DATE_STR2

我們可以看到傳給 fire.Fire() 的引數型別（function）、檔案路徑、文件字串、引數用法等資訊。

現在我們試著計算一下 2017 年 4 月 21 號和 2017 年 4 月 1 號差了多少天：

$ python test-fire.py 20170421 20170401
20

當然，你也可以使用 python test-fire.py --date-str1 20170421 --date-str2 20170401。

此外，對於這種單個函式的情況，程式的最後一行 fire.Fire(cal_days) 可以改為 fire.Fire()，結果完全一樣，fire.Fire() 會預設使用 cal_days() 函式。

多個函式

檔案 test-fire-2func.py

import fire
import datetime

def cal_days(date_str1, date_str2):
    '''計算兩個日期之間的天數'''

    date_str1 = str(date_str1)
    date_str2 = str(date_str2)
    d1 = datetime.datetime.strptime(date_str1, '%Y%m%d')
    d2 = datetime.datetime.strptime(date_str2, '%Y%m%d')
    delta = d1 - d2
    return delta.days


def days2today(date_str):
    '''計算某天距離今天的天數'''

    date_str = str(date_str)
    d = datetime.datetime.strptime(date_str, '%Y%m%d')
    delta = datetime.datetime.now() - d
    return delta.days


if __name__ == '__main__':
    fire.Fire()

這個程式比 test-fire.py 多了一個函式，但是結尾處仍然使用 fire.Fire() 來生成 CLIs。我們先不輸任何引數：

$ python test-fire-2func.py 20170401
Fire trace:
1. Initial component
2. ('Cannot find target in dict', '20170401', {'__name__': '__main__', 'datetime': <module 'datetime' from 'C:\\Users\\secsi\\Anaconda3\\lib\\datetime.py'>, 'cal_days': <function cal_days at 0x0000027A855E7F28>, 'days2today': <function days2today at 0x0000027A86EC6B70>, '__loader__': <_frozen_importlib_external.SourceFileLoader object at 0x0000027A85655A90>, '__file__': 'test-fire-2func.py', '__cached__': None, 'fire': <module 'fire' from 'C:\\Users\\secsi\\Anaconda3\\lib\\site-packages\\fire\\__init__.py'>, '__package__': None, '__builtins__': <module 'builtins' (built-in)>, '__doc__': None, '__spec__': None})

Type:        dict
String form: {'__name__': '__main__', 'datetime': <module 'datetime' from 'C:\\Users\\secsi\\Anaconda3\\lib\\d <...> kage__': None, '__builtins__': <module 'builtins' (built-in)>, '__doc__': None, '__spec__': None}
Length:      12

Usage:       test-fire-2func.py
             test-fire-2func.py datetime
             test-fire-2func.py cal-days
             test-fire-2func.py days2today
             test-fire-2func.py fire

程式中有個兩個函式，而我們執行 python test-fire-2func.py 20170401 的時候卻沒有指定使用哪個函式，所以會報錯。

正確的寫法應該是這樣的：

$ python test-fire-2func.py days2today 20170401
21
$ python test-fire-2func.py cal_days 20170422 20170401
21

也就是說在後面跟上要使用的函式名。

物件（類）

Fire 既然能夠 fire 任何 Python 物件，那麼給 fire.Fire() 傳一個類也是完全可以的。下面是一個例子：

檔案 test-fire-class.py

import fire
import datetime


class DateStr(object):

    def cal_days(self, date_str1, date_str2):
        '''計算兩個日期之間的天數'''
        date_str1 = str(date_str1)
        date_str2 = str(date_str2)
        d1 = datetime.datetime.strptime(date_str1, '%Y%m%d')
        d2 = datetime.datetime.strptime(date_str2, '%Y%m%d')
        delta = d1 - d2
        return delta.days

    def days2today(self, date_str):
        '''計算某天距離今天的天數'''
        date_str = str(date_str)
        d = datetime.datetime.strptime(date_str, '%Y%m%d')
        delta = datetime.datetime.now() - d
        return delta.days


if __name__ == '__main__':
    fire.Fire(DateStr)

這裡我定義了一個 DateStr 類，有兩個類方法 cal_days 和 days2today ，那麼我只需 fire.Fire(DateStr) 就可以呼叫這兩個類方法。

$  python test-fire-class.py days2today 20170401
21
$ python test-fire-class.py cal-days 20170422 20170401
21

還有幾點

• fire 預設使用 - 作為引數分隔符，所以如果你要在命令列傳入類似 2017-04-22 的引數時，那麼程式接收到的引數就肯定不是 2017-04-22 了，你需要使用 --separator 來改變分隔符，參考 Changing the Separator
• fire 會自動區分你在命令列傳入的引數的型別，例如 20170422 會自動識別成 int，hello 會自動識別成 str，'(1,2)' 會自動識別成 tuple，'{"name": "Alan Lee"}' 會自動識別成 dict。但是你如果想要傳入一個字串型別的 20170422 怎麼辦？那就需要這樣寫：'"20170422"' 或者 "'20170422'" 或者 \"20170422\"，總之呢，就是加一個轉義，因為命令列預設會吃掉你的引號。參考 Argument Parsing

END