我們先給大家介紹什么是命令行界面(CLI)：

通過(guò)創(chuàng)建命令行界面(CLI)，可以使程序功能強(qiáng)大并具有交互性。CLI允許您接受命令行參數(shù)(操作系統(tǒng)命令行中程序名稱后面的信息)，以便向程序添加其他特性，使代碼易于使用和靈活。根據(jù)程序的不同，這些參數(shù)可用于添加其他特性，如查看幫助文檔、指定輸出文件或啟用測(cè)試特性，這些特性在正常使用時(shí)可能會(huì)出現(xiàn)問(wèn)題。

[[329645]]

當(dāng)我們剛開(kāi)始用Python編程時(shí)，我們大多數(shù)只收集用戶輸入，交互方式是這樣的：

def main(): 
    first = input(“Enter your first name:”) 
    last = input(“Enter your last name:”) 
    print(first + ' ' + last) 

雖然這段代碼對(duì)于簡(jiǎn)單的腳本來(lái)說(shuō)很好，但是這段代碼不夠靈活。當(dāng)用戶運(yùn)行這個(gè)程序時(shí)，它們被限制為一組定義的規(guī)則。例如，如果我想將輸出記錄到文本文件中，該怎么辦?作為一個(gè)用戶，您可以創(chuàng)建一個(gè)命令行界面來(lái)提供這些問(wèn)題的解決方案。

最佳方式" src="http://p3.pstatp.com/large/pgc-image/5b4f9a79a6624f63b433053d0c17c16c" _fcksavedurl="http://p3.pstatp.com/large/pgc-image/5b4f9a79a6624f63b433053d0c17c16c" _fcksavedurl="http://p3.pstatp.com/large/pgc-image/5b4f9a79a6624f63b433053d0c17c16c" width="640" height="387">

重要的注意事項(xiàng)

在創(chuàng)建CLI時(shí)，重要的是要考慮以下幾點(diǎn)：

• 必需參數(shù):為了程序的運(yùn)行，哪些參數(shù)是絕對(duì)必需的?
• 文檔:寫(xiě)出每個(gè)選項(xiàng)和參數(shù)的函數(shù)是很重要的，這樣新用戶就可以知道你的程序是如何工作的。
• 處理錯(cuò)誤情況:讓用戶確切地知道哪里出了問(wèn)題
• 運(yùn)行時(shí)狀態(tài):如果任務(wù)沒(méi)有立即完成，您應(yīng)該打印出當(dāng)前的進(jìn)度

使用argparse讀取參數(shù)

Argparse是一個(gè)用于解析命令行參數(shù)的Python標(biāo)準(zhǔn)庫(kù)模塊。作為程序員，您可以定義要接受的參數(shù)，而argparse將知道如何從sys中解析這些參數(shù)。當(dāng)用戶給程序提供無(wú)效參數(shù)時(shí)，Argparse還會(huì)自動(dòng)生成幫助和使用消息，并輸出錯(cuò)誤。它使用起來(lái)非常簡(jiǎn)單，并且可以很容易地編寫(xiě)直觀的CLI。

首先，創(chuàng)建一個(gè)名為test_cl .py的新文件，導(dǎo)入模塊并初始化一個(gè)新的解析器：

import argparse 
parser = argparse.ArgumentParser() 
parser.parse_args() 

現(xiàn)在使用--help選項(xiàng)運(yùn)行代碼：

python3 test_cli.py --help 

你應(yīng)該會(huì)收到一個(gè)很好的默認(rèn)幫助信息，像這樣：

usage: test_cli.py [-h] 
optional arguments: 
    -h, --help  show this help message and exit 

祝賀您創(chuàng)建了第一個(gè)命令行界面!

現(xiàn)在讓我們添加一個(gè)歡迎消息，簡(jiǎn)要地讓您的用戶知道這個(gè)程序是做什么的：

welcome = "Practicing creating interactive command-line interfaces" 
parser = argparse.ArgumentParser(description=welcome) 
parser.parse_args() 

現(xiàn)在用-h標(biāo)志運(yùn)行程序。你應(yīng)該可以看到你的歡迎信息。

添加參數(shù)

假設(shè)我們正在編寫(xiě)一個(gè)程序來(lái)爬一個(gè)網(wǎng)頁(yè)。我們可能需要的一些參數(shù)是網(wǎng)頁(yè)的域-domain或-d，日志輸出到一個(gè)輸出文件-ofile或-o的選項(xiàng)，可能還需要輸出到控制臺(tái)的特定行數(shù)-lines或-l的選項(xiàng)。對(duì)于這個(gè)例子，我們將域參數(shù)設(shè)置為必需的，而ofile和lines參數(shù)將是可選的。

通過(guò)使用.add_argument，我們可以很容易地向argparse CLI添加額外的參數(shù)，該參數(shù)允許我們定義使用細(xì)節(jié)。我們可以添加必要的參數(shù)——域，如：

parser.add_argument('--domain', '-d', required=True, help='domain name of the website you want to scrape. i.e. “https://ahadsheriff.com"') 

現(xiàn)在運(yùn)行帶有-h參數(shù)的程序，查看您編寫(xiě)的文檔!

因?yàn)?mdash;—domain是一個(gè)必需的參數(shù)，嘗試運(yùn)行不帶任何標(biāo)志的程序，您將收到以下消息：

usage: test_cli.py [-h] --domain DOMAIN 
test_cli.py: error: the following arguments are required: --domain/-d 

成功了!

現(xiàn)在使用argparse添加額外的參數(shù)。如果沒(méi)有指定需要哪些參數(shù)，argparse將假定它們是可選的。你也可以設(shè)置參數(shù)的類(lèi)型，對(duì)于——lines，我們?nèi)∫粋€(gè)整數(shù)。您還可以為.add_argument設(shè)置其他有用的選項(xiàng)——比如action=

parser.add_argument('--ofile', '-o', help='define output file to save results of stdout. i.e. "output.txt"') 
parser.add_argument('--lines', '-l', help='number of lines of output to print to the console"', type=int) 

現(xiàn)在測(cè)試您的代碼，以確保一切正常運(yùn)行。一種簡(jiǎn)單的方法是將參數(shù)的值存儲(chǔ)為變量，然后打印這些值。

args = parser.parse_args() 
domain = args.domain 
ofile = args.ofile 
lines = args.lines 
print("domain:", domain) 
print("output file:", ofile) 
print("lines:", lines) 

原文：

https://medium.com/@ahadsheriff/the-best-way-to-make-command-line-interfaces-in-python-e00e8b9d10c9