watcherclient.common.utils 模块

class watcherclient.common.utils.HelpFormatter(prog, indent_increment=2, max_help_position=24, width=None)[源代码]

基础: HelpFormatter

start_section(heading)[源代码]
watcherclient.common.utils.args_array_to_dict(kwargs, key_to_convert)[源代码]
watcherclient.common.utils.args_array_to_patch(op, attributes, exclude_fields=[])[源代码]
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 中的命令。

watcherclient.common.utils.import_versioned_module(version, submodule=None)[源代码]
watcherclient.common.utils.is_uuid_like(val)[源代码]

返回一个值是否为 UUID 的验证。

对于我们的目的,UUID 是一个规范形式的字符串:aaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa

watcherclient.common.utils.serialize_file_to_dict(filename)[源代码]
watcherclient.common.utils.split_and_deserialize(string, exclude_fields=[])[源代码]

分割并尝试 JSON 反序列化字符串。

获取具有 KEY=VALUE 格式的字符串,使用 ‘=’ 作为分隔符进行分割,并尝试 JSON 反序列化 VALUE。

返回值:

一个 (key, value) 元组。