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

例：

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

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

例:

import click @click.group() # 將主函數封裝到一個group對象 def main():pass @main.command() # 將函數裝飾為命令，并將該命令自動關聯到main這一group對象下，成為子命令 @click.option('--n', '-nn', default=1) # 設置函數執行時的參數 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()'自動關聯，可以使用main.add_command()手動關聯，例：

import click @click.group() # 將main函數裝飾為一個group對象 def main():pass @click.command() # 將下列函數裝飾為命令 @click.option('--n', '-nn', default=1) # 設置函數參數 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) # 將命令關聯到main這一group對象下 main.add_command(your_name) if __name__ == '__main__':main()

運行:

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

這里值得注意的時，函數名里的下劃線‘_’要在輸入時變為‘-’，否則函數會報參數不對的錯誤。
并且我們如果不輸入command的話，會報下列錯誤：

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?

總結

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

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。