cli 模块

基于已定义 API 的简单 CLI 生成器

AsDict

基于键/值对的 argparse 操作

函数

add_base

添加应始终可用的基本参数

add_base(parser)

参数

parser

add_func_args

将函数签名转换为 argparse 参数

这会使用 python 类型注释来通知 argparse 参数的创建方式。

add_func_args(parser, impl)

参数

parser
impl

add_funcs

在实现层添加函数

add_funcs(inst, subparser)

参数

inst
subparser

add_nested

以 argparse 子命令的形式递归给定类实例中的对象

add_nested(main_parser, parent_parser, inst, api_types, level=0)

参数

main_parser
parent_parser
inst
api_types
level
默认值: 0

arg_bool

验证指定的参数为 true 或 false

arg_bool(arg)

参数

arg

arg_dir

验证指定的参数是否为目录

arg_dir(arg)

参数

arg

arg_file

验证指定的参数是否为文件

arg_file(arg)

参数

arg

build_arg_parser

顶级参数创建

build_arg_parser(inst, api_types, version)

参数

inst
api_types
version

call_func

获取指定函数的参数并调用它

call_func(func, args)

参数

func
args

execute_api

通过轻型 CLI 公开 API

execute_api(api, api_types, version)

参数

api
api_types
version

get_arg_names

获取函数参数名称

get_arg_names(func)

参数

func

get_help_text

获取基于 pydoc 字符串的帮助文本

get_help_text(impl)

参数

impl

print_help

从子分析器查找适当的帮助

print_help(parser, args)

参数

parser
args

set_logging

设置日志详细程度

set_logging(api, verbose)

参数

api
verbose