python命令行工具_python命令行工具Click快速掌握
前言
寫(xiě) Python 的經(jīng)常要寫(xiě)一些命令行工具，雖然標(biāo)準(zhǔn)庫(kù)提供有命令行解析工具 Argparse，但是寫(xiě)起來(lái)非常麻煩，我很少會(huì)使用它。命令行工具中用起來(lái)最爽的就是 Click，它是 Flask 的團(tuán)隊(duì) pallets 的開(kāi)源項(xiàng)目。Click 只要很少的代碼就可以優(yōu)雅地創(chuàng)造一個(gè)命令行工具，它致力于將創(chuàng)建命令行工具的過(guò)程變的快速而有趣。
百聞不如一試
安裝
pip install Click
使用
創(chuàng)建 click_demo.py ，寫(xiě)一個(gè)最簡(jiǎn)單的函數(shù)
import click
@click.command()
def hello():
click.echo('Hello World!')
if __name__ == '__main__':
hello()
運(yùn)行：
python click_demo.py
Hello World!
裝飾器 click.command() 使函數(shù)秒變命令行工具，echo 函數(shù)的作用等同于 print 函數(shù)。
參數(shù)
裝飾器 click.option()可以給命令行函數(shù)指定參數(shù)
import click
@click.command()
@click.option("--count", default=1, help="打印次數(shù)", type=int)
def hello(count):
"""
這是一個(gè)簡(jiǎn)單示例
"""
for i in range(count):
click.echo('Hello World!')
if __name__ == '__main__':
hello()
--count：count是參數(shù)的名字
default ： 參數(shù)的默認(rèn)值
type：給參數(shù)指定類型
help： 說(shuō)明文檔
執(zhí)行腳本的時(shí)候后面加上參數(shù) --help 就可以查看說(shuō)明文檔。
$ python click_demo.py --help
Usage: click_demo.py [OPTIONS]
這是一個(gè)簡(jiǎn)單示例
Options:
--count INTEGER 打印次數(shù)
--help Show this message and exit.
指定參數(shù)：
>python click_demo.py --count 3
Hello World!
Hello World!
Hello World!
prompt
有些命令行工具在運(yùn)行的時(shí)候要求用戶輸入信息，可以給 option 裝飾器指定 prompt 參數(shù)
import click
@click.command()
@click.option("--count", default=1, help="打印次數(shù)", type=int)
@click.option("--name", prompt="請(qǐng)輸入名字", help="姓名")
def hello(count, name):
"""
這是一個(gè)簡(jiǎn)單示例
"""
for i in range(count):
click.echo(f'Hello {name}!')
if __name__ == '__main__':
hello()
$ python click_demo.py
請(qǐng)輸入名字: lzjun
Hello lzjun!
Group
Click 很重要的一個(gè)特性就是它的分組功能，當(dāng)一個(gè)命令行工具的邏輯已經(jīng)非常復(fù)雜的時(shí)候，為了解耦，我們需要將不同的邏輯放在不同的命令中，這樣既可以避免單個(gè)命令行工具函數(shù)臃腫。來(lái)看個(gè)例子：
# db.py
import click
@click.group()
def db():
pass
@click.command()
@click.option("--name", help="用戶名")
def add(name):
"""
添加用戶
:param name:
:return:
"""
click.echo(f'add user {name}')
@click.command()
@click.option("--id", help="用戶名")
def delete(id):
"""
刪除用戶
:param id:
:return:
"""
click.echo(f'delete user {id}')
db.add_command(delete)
db.add_command(add)
if __name__ == '__main__':
db()
這是一個(gè)操作數(shù)據(jù)庫(kù)DB的命令行工具，提供了添加用戶和刪除用戶的命令行等其它操作，如果所有的業(yè)務(wù)邏輯全部寫(xiě)在一個(gè)函數(shù)，維護(hù)變得異常困難。
@click.group 裝飾器把函數(shù)裝飾成為一個(gè)Group對(duì)象，通過(guò) Group 可以添加很多子命令。
python db.py --help
Usage: db.py [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
add 添加用戶 :param name: :return:
delete 刪除用戶 :param id: :return:
從幫助文檔中我們看到 add 和 delete 就是兩個(gè)子命令。 Flask 框架的 flask 命令也是一個(gè) Group 命令。
$ flask
Usage: flask [OPTIONS] COMMAND [ARGS]...
A general utility script for Flask applications.
Provides commands from Flask, extensions, and the application. Loads the
application defined in the FLASK_APP environment variable, or from a
wsgi.py file. Setting the FLASK_ENV environment variable to 'development'
will enable debug mode.
$ export FLASK_APP=hello.py
$ export FLASK_ENV=development
$ flask run
Options:
--version Show the flask version
--help Show this message and exit.
Commands:
add_user 添加賬號(hào) :param name: :param username: :param password:...
init_invite_code 添加邀請(qǐng)碼
recommend_account 更新推薦賬號(hào)
routes Show the routes for the app.
run Runs a development server.
shell Runs a shell in the app context.
提供了幾個(gè)預(yù)定義的子命令和自定義的命令。
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
總結(jié)
以上是生活随笔為你收集整理的python命令行工具_python命令行工具Click快速掌握的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇： 奇瑞星途瑶光“内部渠道员工购车”优惠更大
- 下一篇： pythonpil模块安装_centos