watcherclient.common.utils 模块¶
- class watcherclient.common.utils.HelpFormatter(prog, indent_increment=2, max_help_position=24, width=None)[源代码]¶
基础:
HelpFormatter
- watcherclient.common.utils.common_filters(limit=None, sort_key=None, sort_dir=None, marker=None)[源代码]¶
生成任何列表请求的通用过滤器。
- 参数:
limit – 返回的最大实体数量。
sort_key – 用于排序的字段。
sort_dir – 排序方向:‘asc’ 或 ‘desc’。
marker – 上一页的最后一个 actionplan UUID。
- 返回值:
字符串过滤器列表。
- watcherclient.common.utils.common_params_for_list(args, fields, field_labels)[源代码]¶
生成传递给客户端方法的通用 ‘params’ 字典,适用于每个 ‘list’ 命令。
- 参数:
args – 命令行参数。
fields – 排序的可能字段。
field_labels – 排序的可能字段标签。
- 返回值:
一个包含传递给客户端方法参数的字典。
- watcherclient.common.utils.define_command(subparsers, command, callback, cmd_mapper)[源代码]¶
在 subparsers 集合中定义一个命令。
- 参数:
subparsers – 命令将进入的 subparsers 集合
command – 命令名称
callback – 用于处理命令的函数
- watcherclient.common.utils.define_commands_from_module(subparsers, command_module, cmd_mapper)[源代码]¶
将模块中的 do_ 方法添加为 subparsers 中的命令。