Python中怎么創(chuàng )建一個(gè)命令行界面

這篇文章將為大家詳細講解有關(guān)Python中怎么創(chuàng )建一個(gè)命令行界面，文章內容質(zhì)量較高，因此小編分享給大家做個(gè)參考，希望大家閱讀完這篇文章后對相關(guān)知識有一定的了解。

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

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

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

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

• import argparse 

• parser = argparse.ArgumentParser() 

• parser.parse_args() 

現在使用--help選項運行代碼：

python3 test_cli.py --help

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

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

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

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

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

現在用-h標志運行程序。你應該可以看到你的歡迎信息。

添加參數

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

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

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

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

因為——domain是一個(gè)必需的參數，嘗試運行不帶任何標志的程序，您將收到以下消息：

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

成功了!

現在使用argparse添加額外的參數。如果沒(méi)有指定需要哪些參數，argparse將假定它們是可選的。你也可以設置參數的類(lèi)型，對于——lines，我們取一個(gè)整數。您還可以為.add_argument設置其他有用的選項——比如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)

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

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