實現 Python 指令碼生成命令列

有時候我們會有這樣的一個需求：

我們定義了一個 Python 的方法，方法接收一些引數，但是呼叫的時候想將這些引數用命令列暴露出來。

比如說這裡有個爬取方法：

import requests
def scrape(url, timeout=10):
    response = requests.get(url, timeout=timeout)
    print(response.text)

這裡定義了一個 scrape 方法，第一個引數接收 url，即爬取的網址，第二個引數接收 timeout，即指定超時時間。

呼叫的時候我們可能這麼呼叫：

scrape('https:///www.baidu.com', 10)

如果我們想改引數換 url，那就得改程式碼對吧。

所以有時候我們就想把這些引數用命令列暴露出來，這時候我們可能就用上了 argparse 等等的庫，挨個宣告各個引數是幹嘛的，非常繁瑣，

程式碼如下：

parser = argparse.ArgumentParser(description='Scrape Function')
parser.add_argument('url', type=str,
                    help='an integer for the accumulator')
parser.add_argument('timeout',  type=int,
                    help='sum the integers (default: find the max)')
if __name__ == '__main__':
    args = parser.parse_args()
    scrape(args.url, args.timeout)

這樣我們才能順利地使用命令列來呼叫這個指令碼：

python3 main.py https://www.baidu.com 10

是不是感覺非常麻煩？argparse 寫起來又臭又長，想想就費勁。

Fire

但接下來我們要介紹一個庫，用它我們只需要兩行程式碼就可以做到如上操作。

這個庫的名字叫做Fire，它可以快速為某個 Python 方法或者類新增命令列的引數支援。

先看看安裝方法，使用 pip3 安裝即可：

pip3 install fire

這樣我們就安裝好了。

使用方法

下面我們來看幾個例子。

方法支援

第一個程式碼範例如下：

import fire
def hello(name="World"):
  return "Hello %s!" % name
if __name__ == '__main__':
  fire.Fire(hello)

這裡我們定義了一個 hello 方法，然後接收一個 name 引數，預設值是 World，接著輸出了 Hello 加 name 這個字串。

然後接著我們匯入了 fire 這個庫，呼叫它的 Fire 方法並傳入 hello 這個方法宣告，會發生什麼事情呢？

我們把這段程式碼儲存為 demo1.py，接著用 Python3 來執行一下：

python3 demo1.py

執行結果如下：

Hello World!

看起來並沒有什麼不同。

但我們這時候如果執行如下命令，就可以看到一些神奇的事情了：

python3 demo1.py --help

執行結果如下：

NAME
    demo1.py
SYNOPSIS
    demo1.py <flags>
FLAGS
    --name=NAME
        Default: 'World'

可以看到，這裡它將 name 這個引數轉化成了命令列的一個可選引數，我們可以通過 —-name 來替換 name 引數。

我們來試下：

python3 demo1.py --name 123

這裡我們傳入了一個 name 引數是 123，這時候我們就發現執行結果就變成了如下內容：

Hello 123!

是不是非常方便？我們沒有藉助 argparse 就輕鬆完成了命令列引數的支援和替換。

那如果我們將 name 這個引數的預設值取消呢？程式碼改寫如下：

import fire
def hello(name):
  return "Hello %s!" % name
if __name__ == '__main__':
  fire.Fire(hello)

這時候重新執行：

python3 demo1.py --help

就可以看到結果變成了如下內容：

NAME
    demo1.py
SYNOPSIS
    demo1.py NAME
POSITIONAL ARGUMENTS
    NAME
NOTES
    You can also use flags syntax for POSITIONAL ARGUMENTS

這時候我們發現 name 這個引數就變成了必傳引數，我們必須在命令列裡指定這個引數內容，呼叫就會變成如下命令：

python3 demo1.py 123

執行結果還是一樣的。

類支援

當然 fire 這個庫不僅僅支援給方法新增命令列的支援，還支援給一個類新增命令列的支援。

下面我們再看一個例子：

import fire
class Calculator(object):    
    def double(self, number):
        return 2 * number
if __name__ == '__main__':
    fire.Fire(Calculator)

我們把這個程式碼儲存為 demo2.py，然後執行：

python3 demo2.py

執行結果如下：

NAME
    demo2.py

SYNOPSIS
    demo2.py COMMAND

COMMANDS
    COMMAND is one of the following:

     double

可以看到，這裡它將 Calculator 這個類中的方法識別出來了，COMMAND 之一就是 double，我們試著呼叫下：

python3 demo2.py double

執行結果如下：

ERROR: The function received no value for the required argument: number
Usage: demo2.py double NUMBER

For detailed information on this command, run:
  demo2.py double --help

這裡就說了，這裡必須要指定另外一個引數，叫做 NUMBER，同時這個引數還是必填引數，我們試著加下：

python3 demo2.py double 4

執行結果如下：

8

這時候就可以達到正確結果了。

所以說，綜合來看，fire 可以為一個類命令列，每個命令都對應一個方法的名稱，同時在後面新增額外的可選或必選引數，加到命令列引數的後面。

重新改寫

最後，讓我們回過頭來，給我們一開始定義的 scrape 方法新增命令列的引數支援：

import requests
import fire
def scrape(url, timeout=10):
    response = requests.get(url, timeout=timeout)
    print(response.text)
if __name__ == '__main__':
    fire.Fire(scrape)

這樣就可以了！省去了冗長的 argparse 的程式碼，是不是非常方便？

呼叫就是如下形式：

NAME
    main.py
SYNOPSIS
    main.py URL <flags>

POSITIONAL ARGUMENTS
    URL
FLAGS
    --timeout=TIMEOUT
        Default: 10

這裡說了，URL 是必傳引數，timeout 是可選引數。

最後呼叫下：

python3 main.py https://www.baidu.com 

這樣我們就可以輕鬆將 url 通過命令列傳遞過去了。

當然 timeout 還是可選值，我們可以通過 —-timeout 來指定 timeout 引數：

python3 main.py https://www.baidu.com --timeout 5

這樣兩個引數就都能順利賦值了，最後效果就是爬取百度，5 秒超時。

到此這篇關於實現 Python 指令碼生成命令列的文章就介紹到這了,更多相關 Python 命令列內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！