click包一般用于帶參數(shù)的python腳本運(yùn)行,是通過裝飾器來把一個(gè)函數(shù)方法裝飾成命令行接口的，
常見的裝飾器有：
1. @click.command()：將其下面的函數(shù)方法裝飾為命令行接口選項(xiàng)，(我們稱為一個(gè)command實(shí)例或子命令)，實(shí)現(xiàn)在命令行運(yùn)行時(shí)可選
2. @click.option(’--xxx’, '-x', default=1,prompt=‘Your name’,type=int,nargs=1,help=‘Number of greetings)
? ? 參數(shù)釋義：--xxx：即下列函數(shù)的形參
? ? ? ? ? ? ? ? ? ? ? -x：形參在命令行里的縮寫
? ? ? ? ? ? ? ? ? ? ? default：默認(rèn)值
? ? ? ? ? ? ? ? ? ? ? prompt：若未輸入，就提示該內(nèi)容
? ? ? ? ? ? ? ? ? ? ? type：參數(shù)類型
? ? ? ? ? ? ? ? ? ? ? nargs：指定命令行參數(shù)接收的值的個(gè)數(shù), -1 表示可以接收多個(gè)參數(shù)
? ? ? ? ? ? ? ? ? ? ? help：編輯該參數(shù)的幫助

例：

import click@click.command() # 將函數(shù)裝飾為命令 @click.option('--n', '-nn', default=1) # 設(shè)置函數(shù)執(zhí)行時(shí)的參數(shù) def dots_n(n):click.echo('.' * n)if __name__ == '__main__':dots_n()

3. @click.group()：裝飾器把主函數(shù)裝飾為可以擁有多個(gè)子命令的?Group?對(duì)象，即腳本文件里有多個(gè)函數(shù)方法(可裝飾為command實(shí)例)，不同的 command?實(shí)例可以關(guān)聯(lián)到group中。group下綁定的命令就成為了它的子命令。

例:

import click @click.group() # 將主函數(shù)封裝到一個(gè)group對(duì)象 def main():pass @main.command() # 將函數(shù)裝飾為命令，并將該命令自動(dòng)關(guān)聯(lián)到main這一group對(duì)象下，成為子命令 @click.option('--n', '-nn', default=1) # 設(shè)置函數(shù)執(zhí)行時(shí)的參數(shù) def dots_n(n):click.echo('.' * n)@main.command() @click.option('--name', '-a', default='ZJW', type=str, prompt='Your Name') def your_name(name):click.echo(name) if __name__ == '__main__':main()

這里，不使用'main.command()'自動(dòng)關(guān)聯(lián)，可以使用main.add_command()手動(dòng)關(guān)聯(lián)，例：

import click @click.group() # 將main函數(shù)裝飾為一個(gè)group對(duì)象 def main():pass @click.command() # 將下列函數(shù)裝飾為命令 @click.option('--n', '-nn', default=1) # 設(shè)置函數(shù)參數(shù) def dots_n(n):click.echo('.' * n)@click.command() @click.option('--a', '-aa', default='ZJW', type=str, prompt='Your Name') def your_name(a):click.echo(a) main.add_command(dots_n) # 將命令關(guān)聯(lián)到main這一group對(duì)象下 main.add_command(your_name) if __name__ == '__main__':main()

運(yùn)行:

python test.py dots-n --n 5 或 python test.py dots-n -n 5 python test.py your-name --name zjw 或 python test.py your-name -a zjw

這里值得注意的時(shí)，函數(shù)名里的下劃線‘_’要在輸入時(shí)變?yōu)椤?’，否則函數(shù)會(huì)報(bào)參數(shù)不對(duì)的錯(cuò)誤。
并且我們?nèi)绻惠斎隿ommand的話，會(huì)報(bào)下列錯(cuò)誤：

Usage: test.py [OPTIONS] COMMAND [ARGS]...Options:--help Show this message and exit.Commands:dots-nyour-name

參考：https://www.cnblogs.com/alexkn/p/6980400.html?

總結(jié)

以上是生活随笔為你收集整理的python 之 click 包，设置命令行参数的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。