[Python]尺度库argparse剖析下令行参数利用先容

媒介

argparse 是python尺度库中用于剖析下令行参数的模块。
根本利用

1. import argparse
3. # 创建解析器
4. ## description: 程序说明
5. ## prog: 程序名, 默认为脚本名
6. ## epilog: 帮助信息末尾附加文本
7. ## formatter_class: 控制帮助信息的展示样式
8. parser = argparse.ArgumentParser(
9.     prog="/my_tool",
10.     description="A simple command-line tool.",
11.     epilog="Example usage: /my_tool 'Hello World' --verbose"
12. )
14. # 使用add_argument() 添加参数
15. # echo1和echo2为位置参数，使用时必需按顺序提供
16. # type 指定类型转换函数
17. # help 设置帮助说明
18. parser.add_argument("echo1", type=str, help="echo something")
19. parser.add_argument("echo2", type=str, help="echo something")
21. # -x 或 --xx 为可选参数
22. # default 设置默认值
23. parser.add_argument("--sftp_ip",type=str,default="127.0.0.1", help="sftp服务的IP地址")
25. # 自动转换类型成int
26. # metavar 修改帮助信息中显示的占位名
27. parser.add_argument("--sftp_port", metavar="PORT", type=int, default="22")
29. # dest 指定解析后属性名, 解析后使用 args.username 访问
30. parser.add_argument("--user-name", dest="username")
32. # required 让可选参数变成必须提供
33. # required 只适用于可选参数
34. parser.add_argument("--name", required=True)
36. # choice 限制可选值范围
37. parser.add_argument("-H","--host",type=str, choices=["127.0.0.1", "192.168.0.10"])
39. # nargs 控制参数个数
40. ## nargs=2, 必须 2 个参数
41. ## nargs='*', 0个或多个参数
42. ## nargs='+', 1个或多个参数
43. ## nargs='?', 0个或1个参数
44. parser.add_argument('--nums', nargs=3, type=int)
46. # 创建互斥组，-v和-q不能同时使用
47. group = parser.add_mutually_exclusive_group()
48. # action 定义参数行为
49. group.add_argument("-v", "--verbose", action="store_true")
50. group.add_argument("-q", "--quiet", action="store_true")
52. # 解析参数
53. # 返回的是一个 Namespace 对象
54. args = parser.parse_args()
56. # 使用命令参数
57. print(f"echo1: {args.echo1}, echo2: {args.echo2}")
58. print(f"sftp服务的IP为: {args.sftp_ip}, 端口号: {args.sftp_port}")
59. print(f"host is {args.host}")

复制代码

argparse会主动天生资助选项-h和--help。
action参数

add_argument() 中的 action 参数用来界说参数活动。默认值为store.

• action='store_true', 常用于布尔开关,  不传则为 False
  

1. parser.add_argument('--verbose', action='store_true')
3. # 运行 python app.py --verbose
4. # 解析后
5. args.verbose == True

复制代码

• action='store_false', 反向布尔开关
  
• action='append', 每出现一次就追加到列表
  

1. parser.add_argument('--tag', action='append')
3. # 使用
4. python app.py --tag a --tag b
6. # 得到
7. args.tag == ['a', 'b']

复制代码

• action='count', 统计出现次数
  

1. parser.add_argument('-v', '--verbose', action='count', default=0)
3. # 使用
4. python app.py -vvv
6. # 得到
7. args.verbose == 3

复制代码

• action='version', 打印版本
  

1. parser.add_argument('--version', action='version', version='v1.0.0', default=0)
3. # 使用
4. python app.py --version
5. # 输出 v1.0.0
7. # 也可以写个函数来动态获取
8. def get_version() -> str:
9.     return "v1.0.0"
11. # help 不传的话默认为 show program's version number and exit
12. parser.add_argument(
13.     "--version",
14.     action="version",
15.     version=get_version(),
16.     # help="Show the version of the tool and exit.",
17. )

复制代码

• action='store_const', 设置为指定值
  

1. parser.add_argument('--json', action='store_const', const='json', dest='format')
3. # 运行
4. python app.py --json
6. # 得到
7. args.format == 'json'

复制代码

互斥参数

创建互斥组：group = parser.add_mutually_exclusive_group()
利用group.add_argument设置的下令行选项将互斥，不能同时利用
简朴例子:

1. import argparse
3. parser = argparse.ArgumentParser()
5. # 创建互斥组
6. # 传入 required=True 的话，用户必须从互斥组参数中选一个; 默认用户可以不选可选组参数
7. group = parser.add_mutually_exclusive_group()
9. group.add_argument('--verbose', action='store_true')
10. group.add_argument('--quiet', action='store_true')
12. args = parser.parse_args()
13. print(args)
15. # 这样同时调用会报错
16. python app.py --verbose --quiet

复制代码

子下令

当下令行工具包罗多种操纵时大概就会须要子下令了，比方：

1. python tool.py add user1
2. python tool.py delete user1
3. python tool.py list

复制代码

这里add, delete, list 都是子下令, 这时间最适当用 parser.add_subparsers()
add_subparsers() 用来给一个下令行步伐添加多个子剖析器（subparsers），每个子剖析器对应一个子下令。
根本用法

1. import argparse
3. parser = argparse.ArgumentParser(prog='usercli', description='用户管理工具')
4. # required=True, 强制用户使用子命令
5. # 建议总是显式写 dest='command'
6. subparsers = parser.add_subparsers(dest='command', required=True)
8. # add 子命令
9. parser_add = subparsers.add_parser('add', help='添加用户')
10. parser_add.add_argument('username', help='用户名')
11. parser_add.add_argument('--age', type=int, default=18, help='年龄')
13. # delete 子命令
14. parser_delete = subparsers.add_parser('delete', help='删除用户')
15. parser_delete.add_argument('username', help='用户名')
17. # list 子命令
18. parser_list = subparsers.add_parser('list', help='列出用户')
19. parser_list.add_argument('--verbose', action='store_true', help='显示详细信息')
21. args = parser.parse_args()
23. if args.command == 'add':
24.     print(f'添加用户: {args.username}, 年龄: {args.age}')
25. elif args.command == 'delete':
26.     print(f'删除用户: {args.username}')
27. elif args.command == 'list':
28.     print(f'列出用户, verbose={args.verbose}')

复制代码

子下令绑定处置惩罚函数

上面根本用法中用if/elif 来分发逻辑，简朴场景下还拼集，但是当下令多，功能复杂时，代码会显得非常杂乱，这种情况下就可以为子下令绑定处置惩罚函数。
示例代码：

1. import argparse
3. def handle_add(args):
4.     print(f'添加用户: {args.username}, 年龄: {args.age}')
6. def handle_delete(args):
7.     print(f'删除用户: {args.username}')
9. def handle_list(args):
10.     print(f'列出用户, verbose={args.verbose}')
12. def create_parser() -> argparse.ArgumentParser:
13.     parser = argparse.ArgumentParser(prog='usercli')
14.     subparsers = parser.add_subparsers(dest='command', required=True)
16.     parser_add = subparsers.add_parser('add', help='添加用户')
17.     parser_add.add_argument('username')
18.     parser_add.add_argument('--age', type=int, default=18)
19.     parser_add.set_defaults(func=handle_add)
21.     parser_delete = subparsers.add_parser('delete', help='删除用户')
22.     parser_delete.add_argument('username')
23.     parser_delete.set_defaults(func=handle_delete)
25.     parser_list = subparsers.add_parser('list', help='列出用户')
26.     parser_list.add_argument('--verbose', action='store_true')
27.     parser_list.set_defaults(func=handle_list)
28.     return parser
30. def main() -> None:
31.     parser = create_parser()
32.     args = parser.parse_args()
33.     # 如果用了 args.func(args)
34.     # 一定要确保每个子命令都执行了 parser_xxx.set_defaults(func=...)
35.     # 否则报错: AttributeError: 'Namespace' object has no attribute 'func'
36.     args.func(args)
38. if __name__ == "__main__":
39.     main()

复制代码

子下令共享公共参数

如果多个子下令都须要同一组参数，可以抽一个“父剖析器”。

1. import argparse
3. def main():
4.     common_parser = argparse.ArgumentParser(add_help=False)
5.     common_parser.add_argument('--config', help='配置文件路径')
7.     parser = argparse.ArgumentParser(prog='tool')
8.     subparsers = parser.add_subparsers(dest='command', required=True)
10.     parser_a = subparsers.add_parser('start', parents=[common_parser])
11.     parser_a.add_argument('--port', type=int)
13.     parser_b = subparsers.add_parser('stop', parents=[common_parser])
14.     parser_b.add_argument('--force', action='store_true')
16.     # 解析命令行参数
17.     # common_parser 是一个共享参数模板, 不需要参与参数解析
18.     args = parser.parse_args()
19.     if args.command == 'start':
20.         print(f"Starting with config: {args.config} on port: {args.port}")
21.     elif args.command == 'stop':
22.         print(f"Stopping with config: {args.config} {'forcefully' if args.force else ''}")
23.     else:
24.         print("Unknown command")
26. if __name__ == "__main__":
27.     main()

复制代码

子下令设置别名

1. parser_remove = subparsers.add_parser('remove', aliases=['rm'])

复制代码

如许两种下令都可以

1. python tool.py remove file.txt
2. python tool.py rm file.txt

复制代码

嵌套子下令

复杂 CLI 大概有多级下令，好比：

1. tool user add alice
2. tool user delete bob

复制代码

可以嵌套 add_subparsers()：

1. import argparse
3. parser = argparse.ArgumentParser(prog='tool')
4. subparsers = parser.add_subparsers(dest='entity', required=True)
6. user_parser = subparsers.add_parser('user')
7. user_subparsers = user_parser.add_subparsers(dest='action', required=True)
9. user_add = user_subparsers.add_parser('add')
10. user_add.add_argument('name')
12. user_delete = user_subparsers.add_parser('delete')
13. user_delete.add_argument('name')
15. args = parser.parse_args()
16. print(args)

复制代码

运行：

1. python tool.py user add alice

复制代码

得到：

1. Namespace(entity='user', action='add', name='alice')

复制代码