Python Cli 编写指南

python实现cli

环境:

  • python 3.8

  • python自带argparse

指南

简单示例 : cli.py

import argparse

def cli():
parser = argparse.ArgumentParser(description='CLI描述')
subparsers = parser.add_subparsers(metavar='子命令') # 添加子命令,演示没有参数
one_parser = subparsers.add_parser('one', help='第一个命令')
one_parser.set_defaults(handle=handle_one) # 解析命令
args = parser.parse_args()
# 1.第一个命令会解析成handle,使用args.handle()就能够调用
if hasattr(args, 'handle'):
args.handle(args)
# 2.如果没有handle属性,则表示未输入子命令,则打印帮助信息
else:
parser.print_help() def handle_one(args):
print('handle_one') if __name__ == '__main__':
cli()

调用:

$ python cli.py
usage: cli_1.py [-h] 子命令 ... CLI描述 positional arguments:
子命令
one 第一个命令 optional arguments:
-h, --help show this help message and exit $ python cli.py one
handle_one

增加第二个命令

import argparse

def cli():
parser = argparse.ArgumentParser(description='CLI描述')
subparsers = parser.add_subparsers(metavar='子命令') # 添加子命令,演示没有参数
one_parser = subparsers.add_parser('one', help='第一个命令')
one_parser.set_defaults(handle=handle_one) # 添加子命令,演示有参数
two_parser = subparsers.add_parser('two', help='第二个命令')
# 参数(简写,全称,类型,是否必填,帮助说明)
two_parser.add_argument('-s', '--str', type=str, required=True,
help='一个字符串类型参数')
# 参数(简写,全称,类型,默认值,帮助说明)
two_parser.add_argument('-d', '--default', type=str, default='默认值',
help='这个命令有默认值')
# 参数(简写,全称,类型,帮助说明)
two_parser.add_argument('-ts', '--the-str', type=str,
help='当全称有横线时,属性名转换为下划线,即 the_str')
two_parser.set_defaults(handle=handle_two) # 解析命令
args = parser.parse_args()
# 1.第一个命令会解析成handle,使用args.handle()就能够调用
if hasattr(args, 'handle'):
# 1.1.其他参数会被解析成args的属性,以命令全称为属性名
args.handle(args)
# 2.如果没有handle属性,则表示未输入子命令
else:
parser.print_help() def handle_one(args):
# 无参数
print('handle_one') def handle_two(args):
print('handle_two')
print(f'str:{args.str}')
print(f'default:{args.default}')
print(f'the-str:{args.the_str}') if __name__ == '__main__':
cli()
  • 调用:
$ python cli.py
usage: cli.py [-h] 子命令 ... CLI描述 positional arguments:
子命令
one 第一个命令
two 第二个命令 optional arguments:
-h, --help show this help message and exit
  • 调用one不受影响
$ python cli.py one
handle_one
  • 调用two会显示需要必填项-s
$ python cli.py two
usage: cli.py two [-h] -s STR [-d DEFAULT] [-ts THE_STR]
cli.py two: error: the following arguments are required: -s/--str
  • 输入-h查看帮助
$ python cli.py two -h
usage: cli.py two [-h] -s STR [-d DEFAULT] [-ts THE_STR] optional arguments:
-h, --help show this help message and exit
-s STR, --str STR 一个字符串类型参数
-d DEFAULT, --default DEFAULT
这个命令有默认值
-ts THE_STR, --the-str THE_STR
当全称有横线时,属性名转换为下划线,即 the_str
  • 输入-s参数(或全称--str)

    • 可以看到加了默认值的会显示默认值
    • 没默认值且非必填项值为None
$ python cli.py two -s 哈哈
handle_two
str:哈哈
default:默认值
the-str:None
  • 输入有默认值的参数-d (或全称--default)

    • 输入的值会覆盖默认值
$ python cli.py two -s 哈哈 --default 改了
handle_two
str:哈哈
default:改了
the-str:None
  • 输入所有参数
$ python cli.py two -s 哈哈 --default 改了 -ts 赋值了
handle_two
str:哈哈
default:改了
the-str:赋值了

其他代码使用

在"setup.py"文件中

import setuptools

setuptools.setup(
# 省略其他参数
entry_points={
'console_scripts': [
'my-cli = my.cli:cli'
]
}
)
  • 'my-cli = my.cli:cli'就是替换内容

    • 'my-cli'

      • 上传pypi后,拉取这个库,就能够使用'my-cli'来调用cli
      • 如'my-cli one' / 'my-cli two -h'
    • 'my.cli:cli'
      • '完整类名:方法名'
      • 目录结构如下方结构
      • cli命令需要放在模块下
      • 不能放在根目录下,否则会报错找不到模块

文件目录结构:

root

  • my

    • __init__.py
    • cli.py

参考资料:

https://zhuanlan.zhihu.com/p/79710598

Python Cli 编写指南的更多相关文章

  1. python 函数编写指南

    #函数编写指南:1.给函数指定描述性名称,且只在其中是用小写字母和下划线 2.每个函数都应包含简要的阐述其功能的注释,该注释应紧跟在函数定义后面,且采用文档字符串格式 3.给形参指定默认值时,等号两边 ...

  2. SecureCRT中python脚本编写

    SecureCRT中python脚本编写学习指南 SecureCRT python 引言 在测试网络设备中,通常使用脚本对设备端进行配置和测试以及维护:对于PE设备的测试维护人员来说使用较多是Secu ...

  3. 基于Asterisk的VoIP开发指南——(2)Asterisk AGI程序编写指南

    原文:基于Asterisk的VoIP开发指南--(2)Asterisk AGI程序编写指南 5. Asterisk AGI程序编写指南 5.1概述 很多时候,我们需要在拨号方案中做某些业务逻辑的判断或 ...

  4. Python 内编写类的各种技巧和方法

    Python 内编写类的各种技巧和方法 简介 有关 Python 内编写类的各种技巧和方法(构建和初始化.重载操作符.类描述.属性访问控制.自定义序列.反射机制.可调用对象.上下文管理.构建描述符对象 ...

  5. PEP 8 - Python代码样式指南

    PEP 8 - Python代码样式指南 PEP: 8 标题: Python代码风格指南 作者: Guido van Rossum <python.org上的guido>,Barry Wa ...

  6. Python 编码风格指南

    原文:http://python.jobbole.com/84618/ 本文超出 PEP8 的范畴以涵盖我认为优秀的 Python 风格.本文虽然坚持己见,却不偏执.不仅仅涉及语法.模块布局等问题,同 ...

  7. Effective Python之编写高质量Python代码的59个有效方法

                                                         这个周末断断续续的阅读完了<Effective Python之编写高质量Python代码 ...

  8. Python中编写类的各种技巧和方法

    简介 有关 Python 内编写类的各种技巧和方法(构建和初始化.重载操作符.类描述.属性访问控制.自定义序列.反射机制.可调用对象.上下文管理.构建描述符对象.Pickling). 你可以把它当作一 ...

  9. Python开发人员指南

    本指南是一个全面的资源贡献 给Python的 -为新的和经验丰富的贡献者.这是 保持由维护的Python同一社区.我们欢迎您对Python的贡献! 快速参考 这是设置和添加补丁所需的基本步骤.了解基础 ...

  10. PEP8中文版 -- Python编码风格指南

    Python部落组织翻译, 禁止转载 目录      缩进      制表符还是空格?      行的最大长度      空行      源文件编码      导入      无法忍受的      其 ...

随机推荐

  1. Angular单页应用程式 (SPA)+Azure AD重新导向登入

    一.app.module.ts中设定应用程式 1.将MSAL Angular相关设置封装为auth.module.ts import { NgModule } from '@angular/core' ...

  2. PostgreSQL权限管理

    一旦一个对象被创建,它会被分配一个所有者.所有者通常是执行创建语句的角色.对于大部分类型的对象,初始状态下只有所有者(或者超级用户)能够对该对象做任何事情.为了允许其他角色使用它,必须分配权限. 1 ...

  3. Python_基础_Print_输出函数

    输出函数print() print()函数: 功能:向目的地输出内容 输出的内容:数字.字符串.表达式 目的地:IDLE.控制台.文件 print()函数可以输出些什么内容? 数字 字符串(用单引号和 ...

  4. 【坑】 centos 7.6 使用ssh 秘钥登录遇到的问题

    问题: 我在master1上面创建了一个ssh的秘钥文件,通过ssh-copy-id 传送四台主机,然后使用ansible all -m ping 发现有台机器就是有问题 这是怎么回事???一样的配置 ...

  5. idea等工具网盘下载地址

    1.idea2020 下载地址:https://caiyun.139.com/m/i?1E5C2SkIZbJH4 ,下载密码微信 搜索 "白菜拼吧" 回复 idea2020 获取 ...

  6. CH583 是集成 BLE 无线通讯的 RISC-V MCU 微控制器

    CH583 是集成 BLE 无线通讯的 RISC-V MCU 微控制器.片上集成 2Mbps 低功耗蓝牙 BLE 通讯模块.2 个全速 USB 主机和设备控制器及收发器.2 个 SPI.4 个串口.1 ...

  7. JS脱敏姓名、身份证、电话、邮箱

    一.姓名脱敏 handleName(name) { let arr = Array.from(name) let result = '' if (arr.length === 2) { result ...

  8. 在 Vue 项目中使用 MQTT

    Vue 是一款由尤雨溪及其团队开发的渐进式 Javascript 前端框架.该框架具备数据双向绑定.组件化.响应式和轻量等特点,搭配其脚手架 Vue CLI 使得开发者更加容易上手,大大减少了学习成本 ...

  9. MinGW、Linux GNU、MSVC编译和链接动态库的分析

    这几天研究CMake跨平台项目嘛,用了以下几种编译器: VS2019(MSVC) Linux GNU MinGW 编译之后发现链接动态库发现以下问题: VS2019中如果直接链接CMakeLists. ...

  10. RepVGG:一个结构重参数化网络

    ​  本文来自公众号"AI大道理" ResNet.DenseNet 等复杂的多分支网络可以增强模型的表征能力,使得训练效果更好.但是多分支的结构在推理的时候效率严重不足. 看起来二 ...