Python 處理指令碼的命令列引數(二)：使用click

阿里瓜瓜發表於2019-01-03
Python指令碼命令列

安裝click

pip install click

使用步驟

  1. 使用@click.command() 裝飾一個函式，使之成為命令列介面
  2. 使用@click.option() 等裝飾函式，為其新增命令列選項

example:

import click
 
@click.command()
@click.option('--count', default=1, help='Number of greetings.')
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def hello(count, name):
    """Simple program that greets NAME for a total of COUNT times."""  # 會當作help資訊進行輸出
    for x in range(count):
        click.echo('Hello %s!' % name)
 
if __name__ == '__main__':
    hello()

在上面的例子中，函式hello接受兩個引數，分別是count和name，他們的取值從命令列中獲取，這裡我們使用了click模組中的command、option、echo，他們的作用如下：

  • command：使函式hello成為命令列介面
  • option：增加命令列選項
  • echo：輸出結果，使用echo進行輸出是為了更好的相容性，因為python 2中的print是個語句，python 3中的print 是一個函式

執行上面的指令碼，可以通過命令指定--name,--count的值，由於我們在option中指定了prompt選項，那麼如果我們執行指令碼沒有傳遞name這個引數時，Click會提示我們在互動模式下輸入

PS：與argparse模組一樣，click也會為我們自動生成提示資訊

************python  clicktest.py --help
Usage: clicktest.py [OPTIONS]
 
  Simple program that greets NAME for a total of COUNT times.
 
Options:
  --count INTEGER  Number of greetings.
  --name TEXT      The person to greet.
  --help           Show this message and exit.

其它引數：

option最基本的用法就是通過指定命令列選項的名稱，從命令列讀取引數值，再將其傳遞給函式。option常用的引數含義：

  • default： 設定命令列引數的預設值
  • help：引數說明
  • type：引數型別，可以是string、int、float等
  • prompt：當在命令列中沒有輸入相應的引數時，會更具prompt提示使用者輸入
  • nargs：指定命令列引數接受的值的個數
  • required：是否為必填引數

Click 2.0還加入了ANSI colors支援，如果輸出結果到檔案中還會自動去處ANSI codes。

要使用ANSI colors我們需要colorama包配合操作：

pip install colorama

示例：

click.echo(click.style("Hello World!", fg='green')) # click.secho('Hello World!', fg='green')

 

相關文章