前言:
我們先給大家介紹什么是命令行界面(CLI):
通過創(chuàng)建命令行界面(CLI)近她,可以使程序功能強大并具有交互性。CLI允許您接受命令行參數(shù)(操作系統(tǒng)命令行中程序名稱后面的信息)赘阀,以便向程序添加其他特性炒嘲,使代碼易于使用和靈活。根據(jù)程序的不同秧秉,這些參數(shù)可用于添加其他特性帕棉,如查看幫助文檔针肥、指定輸出文件或啟用測試特性,這些特性在正常使用時可能會出現(xiàn)問題笤昨。
當我們剛開始用Python編程時,我們大多數(shù)只收集用戶輸入握恳,交互方式是這樣的:
雖然這段代碼對于簡單的腳本來說很好瞒窒,但是這段代碼不夠靈活。當用戶運行這個程序時乡洼,它們被限制為一組定義的規(guī)則崇裁。例如,如果我想將輸出記錄到文本文件中束昵,該怎么辦?作為一個用戶拔稳,您可以創(chuàng)建一個命令行界面來提供這些問題的解決方案。
重要的注意事項:
在創(chuàng)建CLI時锹雏,重要的是要考慮以下幾點:
1.必需參數(shù):為了程序的運行巴比,哪些參數(shù)是絕對必需的?
2.文檔:寫出每個選項和參數(shù)的函數(shù)是很重要的,這樣新用戶就可以知道你的程序是如何工作的。
3.處理錯誤情況:讓用戶確切地知道哪里出了問題
4.運行時狀態(tài):如果任務沒有立即完成轻绞,您應該打印出當前的進度
使用argparse讀取參數(shù):
Argparse是一個用于解析命令行參數(shù)的Python標準庫模塊采记。作為程序員,您可以定義要接受的參數(shù)政勃,而argparse將知道如何從sys中解析這些參數(shù)唧龄。當用戶給程序提供無效參數(shù)時,Argparse還會自動生成幫助和使用消息奸远,并輸出錯誤既棺。它使用起來非常簡單,并且可以很容易地編寫直觀的CLI懒叛。
首先丸冕,創(chuàng)建一個名為test_cl .py的新文件,導入模塊并初始化一個新的解析器:
現(xiàn)在使用--help選項運行代碼:
你應該會收到一個很好的默認幫助信息芍瑞,像這樣:
祝賀您創(chuàng)建了第一個命令行界面!
現(xiàn)在讓我們添加一個歡迎消息晨仑,簡要地讓您的用戶知道這個程序是做什么的:
現(xiàn)在用-h標志運行程序。你應該可以看到你的歡迎信息拆檬。
添加參數(shù):
假設我們正在編寫一個程序來爬一個網(wǎng)頁洪己。我們可能需要的一些參數(shù)是網(wǎng)頁的域-domain或-d,日志輸出到一個輸出文件-ofile或-o的選項竟贯,可能還需要輸出到控制臺的特定行數(shù)-lines或-l的選項答捕。對于這個例子,我們將域參數(shù)設置為必需的屑那,而ofile和lines參數(shù)將是可選的拱镐。
通過使用.add_argument,我們可以很容易地向argparse CLI添加額外的參數(shù)持际,該參數(shù)允許我們定義使用細節(jié)沃琅。我們可以添加必要的參數(shù)——域,如:
現(xiàn)在運行帶有-h參數(shù)的程序蜘欲,查看您編寫的文檔!
因為——domain是一個必需的參數(shù)益眉,嘗試運行不帶任何標志的程序,您將收到以下消息:
Python作為一門不斷發(fā)展與普及的語言姥份,還在不斷更新中郭脂。在學習時,建議找一些學習伙伴一起來學習和討論澈歉,效果更佳展鸡。如果想學習Python,歡迎加入Python學習交流群(627012464)埃难,一起督促莹弊,一起學習涤久。里面有開發(fā)工具,很多干貨和技術(shù)資料分享箱硕!
成功了拴竹!
現(xiàn)在使用argparse添加額外的參數(shù)。如果沒有指定需要哪些參數(shù)剧罩,argparse將假定它們是可選的栓拜。你也可以設置參數(shù)的類型,對于——lines惠昔,我們?nèi)∫粋€整數(shù)幕与。您還可以為.add_argument設置其他有用的選項——比如action=
現(xiàn)在測試您的代碼,以確保一切正常運行镇防。一種簡單的方法是將參數(shù)的值存儲為變量啦鸣,然后打印這些值。