使用click進(jìn)行python下命令行工具的編寫以及編碼問題解決

用原生的參數(shù)解析工具非常繁瑣,而click工具入手就非常簡單了毁靶,而且直觀。建立以下這個程序a.py[1], cli會有子命令make,make有選項--work:

  1 import click
  2 
  3 @click.group()
  4 def cli():
  5     print("cli")
  6 
  7 @cli.command()
  8 @click.option('--work', default=None)
  9 def make(work):
 10     print(type(work))
 11     print(work)
 12 
 13 if __name__ == '__main__':
 14     cli()

a.py在bash下執(zhí)行:

$ python a.py
Usage: a.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  make

在bash下執(zhí)行:

$ python a.py make
cli
<type 'NoneType'>
None

a.py在bash下執(zhí)行:

$ python a.py make --work='我'
cli
<type 'unicode'>
我

a.py修改, 增加make的參數(shù)name:

  7 @cli.command()
  8 @click.option('--work', default=None)
  9 @click.argument('name')
 10 def make(work, name):
 11     print(u'work: {}, type: {}'.format(work, type(work)))
 12     print(u'name: {}'.format(name))

在bash下執(zhí)行:

$ python a.py make --work='我'
cli
Usage: a.py make [OPTIONS] NAME
Try "a.py make --help" for help.

Error: Missing argument "NAME".

注意執(zhí)行時提示:Error: Missing argument "NAME"哆姻。 表示需要參數(shù)NAME。我們重新執(zhí)行:

$ python a.py make --work='我' '張三'
cli
work: 我, type: <type 'unicode'>
name: 張三

可以用click.Choice限定參數(shù)或者選項的取值范圍玫膀,修改代碼:

  7 @cli.command()
  8 @click.option('--work', default=None, type=click.Choice(['全職', '兼職']))
  9 @click.argument('name')
 10 def make(work, name):
 11     print(u'work: {}, type: {}'.format(work, type(work)))
 12     print(u'name: {}'.format(name))

我們重新執(zhí)行:

$ python a.py make --work='全' '張三'
cli
/home/jzhou/env/wf/lib/python2.7/site-packages/click/types.py:156: UnicodeWarning: Unicode equal comparison failed to convert both arguments to Unicode - interpreting them as being unequal
 if value in self.choices:
/home/jzhou/env/wf/lib/python2.7/site-packages/click/types.py:176: UnicodeWarning: Unicode equal comparison failed to convert both arguments to Unicode - interpreting them as being unequal
 if normed_value in normed_choices:
Traceback (most recent call last):
 File "a.py", line 16, in <module>
   cli()
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 764, in __call__
   return self.main(*args, **kwargs)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 717, in main
   rv = self.invoke(ctx)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 1135, in invoke
   sub_ctx = cmd.make_context(cmd_name, args, parent=ctx)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 641, in make_context
   self.parse_args(ctx, args)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 940, in parse_args
   value, args = param.handle_parse_result(ctx, opts, args)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 1469, in handle_parse_result
   value = self.full_process_value(ctx, value)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 1790, in full_process_value
   return Parameter.full_process_value(self, ctx, value)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 1438, in full_process_value
   value = self.process_value(ctx, value)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 1428, in process_value
   return self.type_cast_value(ctx, value)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 1417, in type_cast_value
   return _convert(value, (self.nargs != 1) + bool(self.multiple))
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/core.py", line 1415, in _convert
   return self.type(value, self, ctx)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/types.py", line 39, in __call__
   return self.convert(value, param, ctx)
 File "/home/jzhou/env/wf/lib/python2.7/site-packages/click/types.py", line 180, in convert
   (value, ', '.join(self.choices)), param, ctx)
UnicodeDecodeError: 'ascii' codec can't decode byte 0xe5 in position 16: ordinal not in range(128)

這個是因為click在python 2環(huán)境下沒有考慮把參數(shù)或者選項轉(zhuǎn)化為unicode矛缨,下載click_patch[2], clone后在目錄下安裝:

$ git clone https://github.com/fininfotech/click_patch.git
Cloning into 'click_patch'...
remote: Enumerating objects: 11, done.
remote: Counting objects: 100% (11/11), done.
remote: Compressing objects: 100% (8/8), done.
remote: Total 11 (delta 1), reused 8 (delta 1), pack-reused 0
Unpacking objects: 100% (11/11), done.
$ cd click_patch
$ python setup.py install
running install
....

修改a.py:

  1 # -*- coding:utf-8 -*-
  2 import click
  3 import click_patch
  4 
  5 @click.group()
  6 def cli():
  7     print("cli")
  8 
  9 @cli.command()
 10 @click.option('--work', default=None, type=click.Choice([u'全職', u'兼職']))
 11 @click.argument('name')
 12 def make(work, name):
 13     print(u'work: {}, type: {}'.format(work, type(work)))
 14     print(u'name: {}'.format(name))
 15 
 16 if __name__ == '__main__':
 17     cli()

繼續(xù)執(zhí)行:

$ python a.py make --work='全' '張三'
cli
Usage: a.py make [OPTIONS] NAME
Try "a.py make --help" for help.

Error: Invalid value for "--work": invalid choice: 全. (choose from 全職, 兼職)
$ python a.py make --work='全職' '張三'
cli
work: 全職, type: <type 'unicode'>
name: 張三

總的來說,click用來做命令行工具非常方便帖旨,但是在python 2.7環(huán)境下還存在一些字符編碼上的問題箕昭,可以使用click_patch來改正。


  1. 本文所有代碼在fedora 27環(huán)境下測試解阅,python 2.7.15落竹。 ?

  2. click_patch目前只是參考實現(xiàn),不建議在生產(chǎn)上使用货抄,如果要在生產(chǎn)上用述召,請務(wù)必自己確認(rèn)和測試代碼。 ?

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末蟹地,一起剝皮案震驚了整個濱河市积暖,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌锈津,老刑警劉巖呀酸,帶你破解...
    沈念sama閱讀 221,430評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異琼梆,居然都是意外死亡性誉,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,406評論 3 398
  • 文/潘曉璐 我一進(jìn)店門茎杂,熙熙樓的掌柜王于貴愁眉苦臉地迎上來错览,“玉大人,你說我怎么就攤上這事煌往∏悴福” “怎么了?”我有些...
    開封第一講書人閱讀 167,834評論 0 360
  • 文/不壞的土叔 我叫張陵刽脖,是天一觀的道長羞海。 經(jīng)常有香客問我,道長曲管,這世上最難降的妖魔是什么却邓? 我笑而不...
    開封第一講書人閱讀 59,543評論 1 296
  • 正文 為了忘掉前任,我火速辦了婚禮院水,結(jié)果婚禮上腊徙,老公的妹妹穿的比我還像新娘简十。我一直安慰自己,他們只是感情好撬腾,可當(dāng)我...
    茶點故事閱讀 68,547評論 6 397
  • 文/花漫 我一把揭開白布螟蝙。 她就那樣靜靜地躺著,像睡著了一般民傻。 火紅的嫁衣襯著肌膚如雪胰默。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,196評論 1 308
  • 那天饰潜,我揣著相機與錄音初坠,去河邊找鬼。 笑死彭雾,一個胖子當(dāng)著我的面吹牛碟刺,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播薯酝,決...
    沈念sama閱讀 40,776評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼半沽,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了吴菠?” 一聲冷哼從身側(cè)響起者填,我...
    開封第一講書人閱讀 39,671評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎做葵,沒想到半個月后占哟,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,221評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡酿矢,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,303評論 3 340
  • 正文 我和宋清朗相戀三年榨乎,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片瘫筐。...
    茶點故事閱讀 40,444評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡蜜暑,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出策肝,到底是詐尸還是另有隱情肛捍,我是刑警寧澤,帶...
    沈念sama閱讀 36,134評論 5 350
  • 正文 年R本政府宣布之众,位于F島的核電站拙毫,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏棺禾。R本人自食惡果不足惜缀蹄,卻給世界環(huán)境...
    茶點故事閱讀 41,810評論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧袍患,春花似錦、人聲如沸竣付。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,285評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽古胆。三九已至肆良,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間逸绎,已是汗流浹背惹恃。 一陣腳步聲響...
    開封第一講書人閱讀 33,399評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留棺牧,地道東北人巫糙。 一個月前我還...
    沈念sama閱讀 48,837評論 3 376
  • 正文 我出身青樓,卻偏偏與公主長得像颊乘,于是被迫代替她去往敵國和親参淹。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,455評論 2 359

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