快捷導(dǎo)航

Python命令行庫click的具體使用

更新時(shí)間：2022年06月29日 09:50:54 作者：編程學(xué)習(xí)網(wǎng)

本文主要介紹了Python命令行庫click的具體使用，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

一、前言

今天要介紹的 click 則是用一種你很熟知的方式來玩轉(zhuǎn)命令行。命令行程序本質(zhì)上是定義參數(shù)和處理參數(shù)，而處理參數(shù)的邏輯一定是與所定義的參數(shù)有關(guān)聯(lián)的。那可不可以用函數(shù)和裝飾器來實(shí)現(xiàn)處理參數(shù)邏輯與定義參數(shù)的關(guān)聯(lián)呢？而 click 正好就是以這種方式來使用的。

本系列文章默認(rèn)使用 Python 3 作為解釋器進(jìn)行講解。
若你仍在使用 Python 2，請(qǐng)注意兩者之間語法和庫的使用差異哦~

二、介紹

click 是一個(gè)以盡可能少的代碼、以組合的方式創(chuàng)建優(yōu)美的命令行程序的 Python 包。它有很高的可配置性，同時(shí)也能開箱即用。

它旨在讓編寫命令行工具的過程既快速又有趣，還能防止由于無法實(shí)現(xiàn)預(yù)期的 CLI API 所產(chǎn)生挫敗感。它有如下三個(gè)特點(diǎn)：

任意嵌套命令
自動(dòng)生成幫助
支持運(yùn)行時(shí)延遲加載子命令

三、快速開始

3.1 業(yè)務(wù)邏輯

首先定義業(yè)務(wù)邏輯，是不是感覺到有些難以置信呢？

不論是 argparse 還是 docopt，業(yè)務(wù)邏輯都是被放在最后一步，但 click 卻是放在第一步。細(xì)想想 click 的這種方式才更符合人的思維吧？不論用什么命令行框架，我們最終關(guān)心的就是實(shí)現(xiàn)業(yè)務(wù)邏輯，其它的能省則省。

我們以官方示例為例，來介紹 click 的用法和哲學(xué)。假設(shè)命令行程序的輸入是 name 和 count，功能是打印指定次數(shù)的名字。

那么在 hello.py 中，很容易寫出如下代碼：

def hello(count, name):
    """Simple program that greets NAME for a total of COUNT times."""
    for x in range(count):
        click.echo('Hello %s!' % name)

這段代碼的邏輯很簡(jiǎn)單，就是循環(huán) count 次，使用 click.echo 打印 name。其中，click.echo 和 print 的作用相似，但功能更加強(qiáng)大，能處理好 Unicode 和二進(jìn)制數(shù)據(jù)的情況。

3.2 定義參數(shù)

很顯然，我們需要針對(duì) count 和 name 來定義它們所對(duì)應(yīng)的參數(shù)信息。

count 對(duì)應(yīng)為命令行選項(xiàng) --count，類型為數(shù)字，我們希望在不提供參數(shù)時(shí)，其默認(rèn)值是 1

name 對(duì)應(yīng)為命令行選項(xiàng) --name，類型為字符串，我們希望在不提供參數(shù)時(shí)，能給人提示
使用 click，就可以寫成下面這樣：

from click 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): ...

在上面的示例中：

使用裝飾器的方式，即定義了參數(shù)，又將之與處理邏輯綁定，這真是優(yōu)雅。和 argparse、docopt 比起來，就少了一步綁定過程
使用 click.command 表示 hello 是對(duì)命令的處理
使用 click.option 來定義參數(shù)選項(xiàng)
對(duì)于 --count 來說，使用 default 來指定默認(rèn)值。而由于默認(rèn)值是數(shù)字，進(jìn)而暗示 --count 選項(xiàng)的類型為數(shù)字
對(duì)于 --name 來說，使用 prompt 來指定未輸入該選項(xiàng)時(shí)的提示語
使用 help 來指定幫助信息

不論是裝飾器的方式、還是各種默認(rèn)行為，click 都是像它的介紹所說的那樣，讓人盡可能少地編寫代碼，讓整個(gè)過程變得快速而有趣。

3.3 代碼梳理

使用 click 的方式非常簡(jiǎn)單，我們將上文的代碼匯總下，以有一個(gè)更清晰的認(rèn)識(shí)：

# hello.py
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."""
    for x in range(count):
        click.echo('Hello %s!' % name)

if __name__ == '__main__':
    hello()

若我們指定次數(shù)和名字：

$ python3 hello.py --count 2 --name Eric
Hello Eric!
Hello Eric!

若我們什么都不指定，則會(huì)提示輸入名字，并默認(rèn)輸出一次：

$ python3 hello.py
Your name: Eric
Hello Eric!

我們還可以通過 --help 參數(shù)查看自動(dòng)生成的幫助信息：

Usage: hello.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.