python命令行工具_python命令行工具Click快速掌握
前言
写 Python 的经常要写一些命令行工具,虽然标准库提供有命令行解析工具 Argparse,但是写起来非常麻烦,我很少会使用它。命令行工具中用起来最爽的就是 Click,它是 Flask 的团队 pallets 的开源项目。Click 只要很少的代码就可以优雅地创造一个命令行工具,它致力于将创建命令行工具的过程变的快速而有趣。
百闻不如一试
安装
pip install Click
使用
创建 click_demo.py ,写一个最简单的函数
import click
@click.command()
def hello():
click.echo('Hello World!')
if __name__ == '__main__':
hello()
运行:
python click_demo.py
Hello World!
装饰器 click.command() 使函数秒变命令行工具,echo 函数的作用等同于 print 函数。
参数
装饰器 click.option()可以给命令行函数指定参数
import click
@click.command()
@click.option("--count", default=1, help="打印次数", type=int)
def hello(count):
"""
这是一个简单示例
"""
for i in range(count):
click.echo('Hello World!')
if __name__ == '__main__':
hello()
--count:count是参数的名字
default : 参数的默认值
type:给参数指定类型
help: 说明文档
执行脚本的时候后面加上参数 --help 就可以查看说明文档。
$ python click_demo.py --help
Usage: click_demo.py [OPTIONS]
这是一个简单示例
Options:
--count INTEGER 打印次数
--help Show this message and exit.
指定参数:
>python click_demo.py --count 3
Hello World!
Hello World!
Hello World!
prompt
有些命令行工具在运行的时候要求用户输入信息,可以给 option 装饰器指定 prompt 参数
import click
@click.command()
@click.option("--count", default=1, help="打印次数", type=int)
@click.option("--name", prompt="请输入名字", help="姓名")
def hello(count, name):
"""
这是一个简单示例
"""
for i in range(count):
click.echo(f'Hello {name}!')
if __name__ == '__main__':
hello()
$ python click_demo.py
请输入名字: lzjun
Hello lzjun!
Group
Click 很重要的一个特性就是它的分组功能,当一个命令行工具的逻辑已经非常复杂的时候,为了解耦,我们需要将不同的逻辑放在不同的命令中,这样既可以避免单个命令行工具函数臃肿。来看个例子:
# 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()
这是一个操作数据库DB的命令行工具,提供了添加用户和删除用户的命令行等其它操作,如果所有的业务逻辑全部写在一个函数,维护变得异常困难。
@click.group 装饰器把函数装饰成为一个Group对象,通过 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 就是两个子命令。 Flask 框架的 flask 命令也是一个 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 添加账号 :param name: :param username: :param password:...
init_invite_code 添加邀请码
recommend_account 更新推荐账号
routes Show the routes for the app.
run Runs a development server.
shell Runs a shell in the app context.
提供了几个预定义的子命令和自定义的命令。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。
python命令行工具_python命令行工具Click快速掌握相关推荐
- python的pip指令_python的pip工具命令有哪些
python的pip工具命令有:1.install命令,用于安装库:2.download命令,用于下载库:3.uninstall命令,用于卸载库:4.freeze命令,用以requirements格式 ...
- python 命令行 参数_Python命令行参数
python 命令行 参数 Python Command line arguments are input parameters passed to the script when executing ...
- python自然语言处理库_Python自然语言处理工具库(含中文处理)
自然语言处理(Natural Language Processing,简称 NLP),是研究计算机处理人类语言的一门技术.随着深度学习在图像识别.语音识别领域的大放异彩,人们对深度学习在 NLP 的价 ...
- python代码覆盖率工具_Python代码覆盖率分析工具Coverage
简介 在测试中,为了度量产品质量,代码覆盖率被作为一种测试结果的评判依据,在Python代码中用来分析代码覆盖率的工具当属Coverage.代码覆盖率是由特定的测试套件覆盖被测源代码的程度来度量,Co ...
- python处理多行字符串_python多行字符串
Python中如何处理长代码格式化问题,如何提高格式化输出的长字符串的可读性? 当我们需要格式化输出一个很长的字符串的时候,都写在一行显得很难看,而且可读性也很差:当我们使用链式的语法写代码的时候常常 ...
- python命令行解析_python命令行解析函数
sys.argv 在终端运行python 1.py hahah importsysprint(sys.argv) #['1.py', 'hahah'] argparse Python的命令行解析模块, ...
- python 命令行解析函数_python命令行解析之parse_known_args()函数和parse_args()使用区别介绍...
在python中,命令行解析的很好用, 首先导入命令行解析模块 import argparse import sys 然后创建对象 parse=argparse.ArgumentParser() 然后 ...
- python 命令行参数_Python 命令行参数介绍
Python 提供了 getopt 模块来获取命令行参数. Python 中也可以所用 sys 的 sys.argv 来获取命令行参数: sys.argv 是命令行参数列表. len(sys.argv ...
- python显示控制台行情_python命令行查看股票基本行情数据
写了一个Python版本的小工具,可以在上班的时候刷一下你关注的股票信息.Python版本用的是3.4.1的,代码如下: #!/usr/bin/env python # -*- coding:utf- ...
最新文章
- shell 脚本 抽取指定数量的随机学生
- Andorid开发学习---ubuntu 12.04下搭建超好用的安卓模拟器genymotion 安装卸载virtualbox 4.3...
- android百度地图sdk定位权限,Android:使用百度地图SDK实现定位:下载SDK、申请密钥、动态获得Android权限...
- java面试题九 数组初始化
- docker entrypoint入口文件详解
- android slidingmenu框架,常用框架之SlidingMenu的使用(基于AndroidStudio)
- java 多线程 day06 threadLocal
- 云计算只是云存储的一个子问题
- 西门子step7安装注册表删除_不用重装系统就能完全卸载西门子PLC编程软件STEP 7...
- 中国各地区工业COD排放量面板数据(1998-2017年)
- 2022年计算机保研记录(计算所、浙大、华科、东南、北航)
- 择一城终老,遇一人白首
- 冰箱味道很臭?那你真的该学学这些除臭妙招
- 蓝桥杯web:3.【功能实现】封装函数实现个人所得税计算器
- Geek 设计师们疯狂的桌面
- uni.navigateBack直接返回到首页
- Power Query 系列 (11) - 函数基础
- 链路追踪-SkyWalking
- 盘点拿些出身最奇特的程序员是什么样的?
- 浅谈MOSFET驱动电路
热门文章
- flask post json_【python:flask-SocketIO】网络通信框架简单了解
- 3dmax高版本转低版本插件_视频编辑干货资料:低版本打开高版本pr文件
- Android 数据库制作APP,在Android 中使用Anko框架制作一个完整的App,第二集
- http抓包实战 pdf_实战 Wireshark https 抓包 2, 再抓 Moka 蹭 OurATS 的小尾巴
- win10启动项_科普:为什么重装Win7系统后,速度比Win10系统慢很多?
- linux7电脑配置要求,安装win7系统电脑配置有何要求--win10专业版
- centos7 xampp启动mysql数据库_mysql主从配置,用win xampp和centos7环境下测试
- python中vstack_Python numpy实现数组合并实例(vstack,hstack)
- 20220209-CTF MISC-BUUCTF-qr-被嗅探的流量(查找POST包)
- cap流程图_化工工艺流程图制图图例汇编.pdf