在Python中創(chuàng)建命令行界面的最佳方式

前言:

我們先給大家介紹什么是命令行界面(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ǔ)為變量炒事,然后打印這些值。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子肖方,更是在濱河造成了極大的恐慌,老刑警劉巖未状,帶你破解...
    沈念sama閱讀 219,188評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件窥妇,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡娩践,警方通過查閱死者的電腦和手機(jī)活翩,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,464評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來翻伺,“玉大人材泄,你說我怎么就攤上這事《至耄” “怎么了拉宗?”我有些...
    開封第一講書人閱讀 165,562評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)辣辫。 經(jīng)常有香客問我旦事,道長(zhǎng),這世上最難降的妖魔是什么急灭? 我笑而不...
    開封第一講書人閱讀 58,893評(píng)論 1 295
  • 正文 為了忘掉前任姐浮,我火速辦了婚禮,結(jié)果婚禮上葬馋,老公的妹妹穿的比我還像新娘卖鲤。我一直安慰自己,他們只是感情好畴嘶,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,917評(píng)論 6 392
  • 文/花漫 我一把揭開白布蛋逾。 她就那樣靜靜地躺著,像睡著了一般窗悯。 火紅的嫁衣襯著肌膚如雪区匣。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,708評(píng)論 1 305
  • 那天蒋院,我揣著相機(jī)與錄音亏钩,去河邊找鬼。 笑死悦污,一個(gè)胖子當(dāng)著我的面吹牛铸屉,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播切端,決...
    沈念sama閱讀 40,430評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼彻坛,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了踏枣?” 一聲冷哼從身側(cè)響起昌屉,我...
    開封第一講書人閱讀 39,342評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎茵瀑,沒想到半個(gè)月后间驮,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,801評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡马昨,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,976評(píng)論 3 337
  • 正文 我和宋清朗相戀三年竞帽,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了扛施。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,115評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡屹篓,死狀恐怖疙渣,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情堆巧,我是刑警寧澤妄荔,帶...
    沈念sama閱讀 35,804評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站谍肤,受9級(jí)特大地震影響啦租,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜荒揣,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,458評(píng)論 3 331
  • 文/蒙蒙 一篷角、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧乳附,春花似錦内地、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,008評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至举农,卻和暖如春荆针,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背颁糟。 一陣腳步聲響...
    開封第一講書人閱讀 33,135評(píng)論 1 272
  • 我被黑心中介騙來泰國(guó)打工航背, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人棱貌。 一個(gè)月前我還...
    沈念sama閱讀 48,365評(píng)論 3 373
  • 正文 我出身青樓玖媚,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親婚脱。 傳聞我的和親對(duì)象是個(gè)殘疾皇子今魔,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,055評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容

  • 對(duì) Python 程序來說,完備的命令行界面可以提升團(tuán)隊(duì)的工作效率障贸,減少調(diào)用時(shí)可能碰到的困擾错森。今天,我們就來教大家...
    妄心xyx閱讀 5,304評(píng)論 1 51
  • 摘要:本文翻譯自 PythonPlumbum開源庫的官方文檔Plumbum CLI部分篮洁,主要介紹如何使用Plumb...
    派派森森閱讀 616評(píng)論 0 0
  • 用node.js創(chuàng)建一個(gè)cli(命令行接口) 本文將帶你一步一步完成一個(gè)cli涩维,跟隨本文操作下來,你將了解如何去創(chuàng)...
    pipu閱讀 1,285評(píng)論 1 2
  • 久違的晴天袁波,家長(zhǎng)會(huì)瓦阐。 家長(zhǎng)大會(huì)開好到教室時(shí)蜗侈,離放學(xué)已經(jīng)沒多少時(shí)間了。班主任說已經(jīng)安排了三個(gè)家長(zhǎng)分享經(jīng)驗(yàn)垄分。 放學(xué)鈴聲...
    飄雪兒5閱讀 7,523評(píng)論 16 22
  • 創(chuàng)業(yè)是很多人的夢(mèng)想宛篇,多少人為了理想和不甘選擇了創(chuàng)業(yè)來實(shí)現(xiàn)自我價(jià)值,我就是其中一個(gè)薄湿。 創(chuàng)業(yè)后,我由女人變成了超人偷卧,什...
    亦寶寶閱讀 1,812評(píng)論 4 1