keystoneauth1.loading.opts 模块¶
- class keystoneauth1.loading.opts.Opt(name: str, type: type[~typing.Any] = <class 'str'>, help: str | None = None, secret: bool = False, dest: str | None = None, deprecated: list[~keystoneauth1.loading.opts.Opt] | None = None, default: ~typing.Any = None, metavar: str | None = None, required: bool = False, prompt: str | None = None)
基类:
object身份验证插件所需的选项。
Opt 提供了一种机制，用于动态加载的身份验证插件来指定要传递给插件初始化器的参数。
Opt 指定有关插件参数在不同加载机制中表示方式的信息。
定义带有 - 的 Opt 时，- 应该存在于 name 参数中。这将在传递给插件初始化器时自动转换为 _。例如，您应该指定
Opt('user-domain-id')
这将把值作为 user_domain_id 传递给插件的初始化器。
- 参数：
name (str) – 选项的名称。
type (callable) – 选项的类型。这是一个可调用对象，它传递了加载的原始选项（通常是字符串），并且需要以 __init__ 期望的类型返回参数。
help (str) – 与选项一起显示的帮助文本。
secret (bool) – 如果参数是秘密，则不应在调试输出中打印或记录它。
dest (str) – 将传递给 __init__ 的参数的名称。这允许您在加载中使用与 __init__ 函数不同的名称。默认为 name 的值。
deprecated (keystoneauth1.loading.Opt) – 一个列表，其中包含已被此选项弃用的其他选项。这确保了旧选项仍然被注册。
default – 如果未提供，则可以使用默认值。
metavar (str) – CLI 帮助文本中应打印的 <metavar>。
required (bool) – 加载插件是否需要该选项。如果缺少必需的选项，则加载应失败。
prompt (str) – 如果可以通过提示请求该选项（在适当的情况下），请设置应用于提示的字符串。
- __annotations__ = {}
- __dict__ = mappingproxy({'__module__': 'keystoneauth1.loading.opts', '__doc__': "一个 身份验证插件所需的选项。\n\n Opt 提供了一种机制，用于动态加载的身份验证插件来指定要传递给插件初始化器的参数。\n\n Opt 指定有关插件参数在不同加载机制中表示方式的信息。\n\n 定义带有 - 的 Opt 时，- 应该存在于 name 参数中。这将在传递给插件初始化器时自动转换为 _。例如，您应该指定::\n\n Opt('user-domain-id')\n\n 这将把值作为 `user_domain_id` 传递给插件的初始化器。\n\n :param str name: 选项的名称。\n :param callable type: 选项的类型。这是一个可调用对象，它传递了加载的原始选项（通常是字符串），并且需要以 __init__ 期望的类型返回参数。\n :param str help: 与选项一起显示的帮助文本。\n :param bool secret: 如果参数是秘密，则不应在调试输出中打印或记录它。\n :param str dest: 将传递给 __init__ 的参数的名称。这允许您在加载中使用与 __init__ 函数不同的名称。默认为 name 的值。\n :param keystoneauth1.loading.Opt deprecated: 一个列表，其中包含已被此选项弃用的其他选项。这确保了旧选项仍然被注册。\n :type opt: list(Opt)\n :param default: 如果未提供，则可以使用默认值。\n :param str metavar: CLI 帮助文本中应打印的 <metavar>。\n :param bool required: 加载插件是否需要该选项。如果缺少必需的选项，则加载应失败。\n :param str prompt: 如果可以通过提示请求该选项（在适当的情况下），请设置应用于提示的字符串。\n ", '__init__': <function Opt.__init__>, '__repr__': <function Opt.__repr__>, '_to_oslo_opt': <function Opt._to_oslo_opt>, '__eq__': <function Opt.__eq__>, '_all_opts': <property object>, 'argparse_args': <property object>, 'argparse_envvars': <property object>, 'argparse_default': <property object>, '__dict__': <attribute '__dict__' of 'Opt' objects>, '__weakref__': <attribute '__weakref__' of 'Opt' objects>, '__hash__': None, '__annotations__': {}})
- __doc__ = "身份验证插件所需的选项。\n\n Opts 为 将要动态加载的身份验证插件提供了一种指定要传递给插件的参数的方式。\n Opt 指定了插件参数在不同加载机制中表示方式的信息。\n\n 在定义带有 - 的 Opt 时， - 应存在于名称参数中。这将在传递给插件初始化时自动转换为 _。\n 例如，您应该指定::\n\n Opt('user-domain-id')\n\n 这将把值作为 `user_domain_id` 传递给插件的初始化。\n\n :param str name: 选项的名称。\n :param callable type: 选项的类型。这是一个可调用对象，它将接收加载的原始选项（通常是字符串），并且需要以 __init__ 期望的类型返回参数。\n :param str help: 与选项一起显示的帮助文本。\n :param bool secret: 如果参数是机密的，则不应在调试输出中打印或记录。\n :param str dest: 将传递给 __init__ 的参数的名称。这允许您在加载时使用与 __init__ 函数使用的不同的名称。\n 默认值为 name 的值。\n :param keystoneauth1.loading.Opt deprecated: 一个列表，包含其他已被此选项淘汰的选项。这确保了旧选项仍然被注册。\n :type opt: list(Opt)\n :param default: 如果未提供，则可以使用默认值。\n :param str metavar: 应在 CLI 帮助文本中打印的 <metavar>。\n :param bool required: 如果加载插件需要该选项，则为 True。如果缺少必需的选项，则加载应失败。\n :param str prompt: 如果可以通过提示请求该选项（在适当的情况下），则设置应用于提示的字符串。\n "
- __hash__ = None
- __init__(name: str, type: type[~typing.Any] = <class 'str'>, help: str | None = None, secret: bool = False, dest: str | None = None, deprecated: list[~keystoneauth1.loading.opts.Opt] | None = None, default: ~typing.Any = None, metavar: str | None = None, required: bool = False, prompt: str | None = None)
- __module__ = 'keystoneauth1.loading.opts'
- __repr__() str
返回选项名称的字符串表示形式。
- __weakref__
对该对象的弱引用列表
- property _all_opts: chain[Opt]
- _to_oslo_opt() cfg.Opt
- property argparse_default: Any
