前言:
我們先給大家介紹什么是命令行界面(CLI):
通過創(chuàng)建命令行界面(CLI)混移,可以使程序功能強(qiáng)大并具有交互性装哆。CLI允許您接受命令行參數(shù)(操作系統(tǒng)命令行中程序名稱后面的信息)圾叼,以便向程序添加其他特性袱吆,使代碼易于使用和靈活巧颈。根據(jù)程序的不同,這些參數(shù)可用于添加其他特性兜粘,如查看幫助文檔申窘、指定輸出文件或啟用測(cè)試特性,這些特性在正常使用時(shí)可能會(huì)出現(xiàn)問題孔轴。
當(dāng)我們剛開始用Python編程時(shí)剃法,我們大多數(shù)只收集用戶輸入,交互方式是這樣的:
雖然這段代碼對(duì)于簡(jiǎn)單的腳本來說很好路鹰,但是這段代碼不夠靈活贷洲。當(dāng)用戶運(yùn)行這個(gè)程序時(shí),它們被限制為一組定義的規(guī)則晋柱。例如优构,如果我想將輸出記錄到文本文件中,該怎么辦?作為一個(gè)用戶雁竞,您可以創(chuàng)建一個(gè)命令行界面來提供這些問題的解決方案钦椭。
重要的注意事項(xiàng):
在創(chuàng)建CLI時(shí),重要的是要考慮以下幾點(diǎn):
1.必需參數(shù):為了程序的運(yùn)行碑诉,哪些參數(shù)是絕對(duì)必需的?
2.文檔:寫出每個(gè)選項(xiàng)和參數(shù)的函數(shù)是很重要的彪腔,這樣新用戶就可以知道你的程序是如何工作的。
3.處理錯(cuò)誤情況:讓用戶確切地知道哪里出了問題
4.運(yùn)行時(shí)狀態(tài):如果任務(wù)沒有立即完成联贩,您應(yīng)該打印出當(dāng)前的進(jìn)度
使用argparse讀取參數(shù):
Argparse是一個(gè)用于解析命令行參數(shù)的Python標(biāo)準(zhǔn)庫模塊漫仆。作為程序員,您可以定義要接受的參數(shù)泪幌,而argparse將知道如何從sys中解析這些參數(shù)盲厌。當(dāng)用戶給程序提供無效參數(shù)時(shí),Argparse還會(huì)自動(dòng)生成幫助和使用消息祸泪,并輸出錯(cuò)誤吗浩。它使用起來非常簡(jiǎn)單,并且可以很容易地編寫直觀的CLI没隘。
首先懂扼,創(chuàng)建一個(gè)名為test_cl .py的新文件,導(dǎo)入模塊并初始化一個(gè)新的解析器:
現(xiàn)在使用--help選項(xiàng)運(yùn)行代碼:
你應(yīng)該會(huì)收到一個(gè)很好的默認(rèn)幫助信息右蒲,像這樣:
祝賀您創(chuàng)建了第一個(gè)命令行界面!
現(xiàn)在讓我們添加一個(gè)歡迎消息阀湿,簡(jiǎn)要地讓您的用戶知道這個(gè)程序是做什么的:
現(xiàn)在用-h標(biāo)志運(yùn)行程序。你應(yīng)該可以看到你的歡迎信息瑰妄。
添加參數(shù):
假設(shè)我們正在編寫一個(gè)程序來爬一個(gè)網(wǎng)頁陷嘴。我們可能需要的一些參數(shù)是網(wǎng)頁的域-domain或-d,日志輸出到一個(gè)輸出文件-ofile或-o的選項(xiàng)间坐,可能還需要輸出到控制臺(tái)的特定行數(shù)-lines或-l的選項(xiàng)灾挨。對(duì)于這個(gè)例子邑退,我們將域參數(shù)設(shè)置為必需的,而ofile和lines參數(shù)將是可選的劳澄。
通過使用.add_argument地技,我們可以很容易地向argparse CLI添加額外的參數(shù),該參數(shù)允許我們定義使用細(xì)節(jié)秒拔。我們可以添加必要的參數(shù)——域莫矗,如:
現(xiàn)在運(yùn)行帶有-h參數(shù)的程序,查看您編寫的文檔!
因?yàn)椤猟omain是一個(gè)必需的參數(shù)溯警,嘗試運(yùn)行不帶任何標(biāo)志的程序趣苏,您將收到以下消息:
Python作為一門不斷發(fā)展與普及的語言,還在不斷更新中梯轻。在學(xué)習(xí)時(shí)食磕,建議找一些學(xué)習(xí)伙伴一起來學(xué)習(xí)和討論,效果更佳喳挑。如果想學(xué)習(xí)Python彬伦,歡迎加入Python學(xué)習(xí)交流群(627012464),一起督促伊诵,一起學(xué)習(xí)单绑。里面有開發(fā)工具,很多干貨和技術(shù)資料分享曹宴!
成功了搂橙!
現(xiàn)在使用argparse添加額外的參數(shù)。如果沒有指定需要哪些參數(shù)笛坦,argparse將假定它們是可選的区转。你也可以設(shè)置參數(shù)的類型,對(duì)于——lines,我們?nèi)∫粋€(gè)整數(shù)。您還可以為.add_argument設(shè)置其他有用的選項(xiàng)——比如action=
現(xiàn)在測(cè)試您的代碼惧辈,以確保一切正常運(yùn)行。一種簡(jiǎn)單的方法是將參數(shù)的值存儲(chǔ)為變量炒事,然后打印這些值。