keystoneauth1.loading 包

子模块

模块内容

class keystoneauth1.loading.BaseFederationLoader

基类: BaseV3Loader[V3FederationPluginT]

联邦插件的基本选项处理。

此类定义了应该与 V3 身份联邦 API 共通的选项和处理。它提供了 keystoneauth1.identity.v3.FederationBaseAuth 类所期望的选项。

__abstractmethods__ = frozenset({})
__annotations__ = {}
__doc__ = '联邦插件的基本选项处理。\n\n    此类定义了应该与 V3 身份联邦 API 共通的选项和处理。它提供了\n    :py:class:`keystoneauth1.identity.v3.FederationBaseAuth` 类所期望的选项。\n    '
__module__ = 'keystoneauth1.loading.identity'
__orig_bases__ = (keystoneauth1.loading.identity.BaseV3Loader[~V3FederationPluginT],)
__parameters__ = (~V3FederationPluginT,)
_abc_impl = <_abc._abc_data object>
get_options() → list[Opt]

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

class keystoneauth1.loading.BaseGenericLoader

基类: BaseIdentityLoader[GenericPluginT]

通用插件的基本选项处理。

此类定义了应该与通用插件共通的选项和处理。这些插件针对 OpenStack 身份服务，但设计为独立于 API 版本。它提供了 keystoneauth1.identity.generic.base.BaseGenericPlugin 类所期望的选项。

__abstractmethods__ = frozenset({})
__annotations__ = {}
__doc__ = '通用插件的基本选项处理。\n\n    此类定义了应该与通用插件共通的选项和处理。这些插件针对 OpenStack 身份服务，但设计为\n    独立于 API 版本。它提供了\n    :py:class:`keystoneauth1.identity.generic.base.BaseGenericPlugin` 类所期望的选项。\n    '
__module__ = 'keystoneauth1.loading.identity'
__orig_bases__ = (keystoneauth1.loading.identity.BaseIdentityLoader[~GenericPluginT],)
__parameters__ = (~GenericPluginT,)
_abc_impl = <_abc._abc_data object>
get_options() → list[Opt]

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

class keystoneauth1.loading.BaseIdentityLoader

基类: BaseLoader[PluginT]

身份插件的基本选项处理。

此类定义了应该与针对 OpenStack 身份服务开发的插件共通的选项和处理。它提供了 keystoneauth1.identity.BaseIdentityPlugin 类所期望的选项。

__abstractmethods__ = frozenset({})
__annotations__ = {}
__doc__ = '身份插件的基本选项处理。\n\n    此类定义了应该与针对 OpenStack 身份服务开发的插件共通的选项和处理。它\n    提供了\n    :py:class:`keystoneauth1.identity.BaseIdentityPlugin` 类所期望的选项。\n    '
__module__ = 'keystoneauth1.loading.identity'
__orig_bases__ = (keystoneauth1.loading.base.BaseLoader[~PluginT],)
__parameters__ = (~PluginT,)
_abc_impl = <_abc._abc_data object>
get_options() → list[Opt]

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

class keystoneauth1.loading.BaseLoader

基类: _BaseLoader[BaseAuthPluginT]

__abstractmethods__ = frozenset({'get_options'})
__annotations__ = {}
__doc__ = None
__module__ = 'keystoneauth1.loading.base'
__orig_bases__ = (keystoneauth1.loading.base._BaseLoader[+BaseAuthPluginT],)
__parameters__ = (+BaseAuthPluginT,)
_abc_impl = <_abc._abc_data object>
class keystoneauth1.loading.BaseV2Loader

基类: BaseIdentityLoader[V2PluginT]

身份插件的基本选项处理。

此类定义了应该与 V2 身份 API 共通的选项和处理。它提供了 keystoneauth1.identity.v2.Auth 类所期望的选项。

__abstractmethods__ = frozenset({})
__annotations__ = {}
__doc__ = '身份插件的基本选项处理。\n\n    此类定义了应该与 V2 身份 API 共通的选项和处理。它提供了\n    :py:class:`keystoneauth1.identity.v2.Auth` 类所期望的选项。\n    '
__module__ = 'keystoneauth1.loading.identity'
__orig_bases__ = (keystoneauth1.loading.identity.BaseIdentityLoader[~V2PluginT],)
__parameters__ = (~V2PluginT,)
_abc_impl = <_abc._abc_data object>
get_options() → list[Opt]

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

class keystoneauth1.loading.BaseV3Loader

基类: BaseIdentityLoader[V3PluginT]

身份插件的基本选项处理。

此类定义了应该与 V3 身份 API 共通的选项和处理。它提供了 keystoneauth1.identity.v3.Auth 类所期望的选项。

__abstractmethods__ = frozenset({})
__annotations__ = {}
__doc__ = '身份插件的基本选项处理。\n\n    此类定义了应该与 V3 身份 API 共通的选项和处理。它提供了\n    :py:class:`keystoneauth1.identity.v3.Auth` 类所期望的选项。\n    '
__module__ = 'keystoneauth1.loading.identity'
__orig_bases__ = (keystoneauth1.loading.identity.BaseIdentityLoader[~V3PluginT],)
__parameters__ = (~V3PluginT,)
_abc_impl = <_abc._abc_data object>
get_options() → list[Opt]

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

load_from_options(**kwargs: Any) → V3PluginT

从从 get_options 获取的参数创建插件。

客户端可以覆盖此函数以进行参数验证或处理注册选项与创建插件所需的选项之间的差异。

class keystoneauth1.loading.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) – 如果可以通过提示请求该选项（在适当的情况下），则设置应用于提示的字符串。

__dict__ = mappingproxy({'__module__': 'keystoneauth1.loading.opts', '__doc__': "一个 由 身份验证 插件 要求的 选项。\n\n    Opts 提供了一种 机制 ，用于 即将 动态 加载的 身份验证 插件 来 指定 要传递给 插件的 参数。\n\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: 如果需要该选项才能加载插件。 如果缺少必需的选项，则加载应失败。\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\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    "
__eq__(other: Any) → bool

定义选项参数上的相等运算符。

__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_args: list[str]
property argparse_default: Any
property argparse_envvars: list[str]
keystoneauth1.loading.get_adapter_conf_options(include_deprecated: bool = True, deprecated_opts: dict[str, list[cfg.DeprecatedOpt]] | None = None) → list[cfg.Opt]
keystoneauth1.loading.get_auth_common_conf_options() → list[cfg.Opt]

获取所有身份验证插件通用的 oslo_config 选项。

这些可能对配置文件的生成或用于在注册它们之前操作选项很有用，而无需注册。

设置的选项是
auth_type:

要加载的插件的名称。

auth_section:

要从中加载选项的配置文件部分。

返回值:

一个 oslo_config 选项列表。

keystoneauth1.loading.get_auth_plugin_conf_options(plugin: BaseLoader[BaseAuthPluginT] | str) → list[cfg.Opt]

获取特定插件的 oslo_config 选项。

这将是注册并由指定插件加载的配置选项列表。

参数：

plugin (str 或 keystoneauth1.loading.BaseLoader) – 插件加载器的名称或插件加载器对象

返回值:

一个 oslo_config 选项列表。

keystoneauth1.loading.get_available_plugin_loaders() → dict[str, BaseLoader[BaseAuthPluginT]]

检索系统上所有可用的插件类。

返回值:

一个字典，其中插件入口点名称作为键，插件加载器作为值。

返回类型:

dict

keystoneauth1.loading.get_available_plugin_names() → frozenset[str]

获取系统上所有可用插件的名称。

这对于帮助和错误文本特别有用，例如提示用户他们可以指定哪些插件。

返回值:

一个名称列表。

返回类型:

frozenset

keystoneauth1.loading.get_plugin_loader(name: str) → BaseLoader[BaseAuthPluginT]

通过入口点名称检索插件类。

参数：

name (str) – 要获取的对象的名称。

返回值:

一个认证插件类。

返回类型:

keystoneauth1.loading.BaseLoader

引发:

keystoneauth1.exceptions.auth_plugins.NoMatchingPlugin – 如果无法创建插件。

keystoneauth1.loading.get_plugin_options(name: str) → list[opts.Opt]

获取特定插件的选项。

这将是指定插件注册和加载的选项列表。

返回值:

一个 keystoneauth1.loading.Opt 选项列表。

引发:

keystoneauth1.exceptions.auth_plugins.NoMatchingPlugin – 如果无法创建插件。

keystoneauth1.loading.get_session_conf_options(deprecated_opts: dict[str, list[cfg.DeprecatedOpt]] | None = None) → list[cfg.Opt]
keystoneauth1.loading.load_adapter_from_conf_options(conf: cfg.ConfigOpts, group: str, **kwargs: Any) → Adapter
keystoneauth1.loading.load_auth_from_argparse_arguments(namespace: Namespace, **kwargs: Any) → plugin.BaseAuthPluginT | None

从完成的 argparse 结果中检索创建的插件。

从 argparse 解析的命令行信息加载并创建认证插件。

参数：

namespace (Namespace) – CLI 解析的结果。

返回值:

一个认证插件，或者如果没有提供名称则为 None。

返回类型:

keystoneauth1.plugin.BaseAuthPlugin

引发:

keystoneauth1.exceptions.auth_plugins.NoMatchingPlugin – 如果无法创建插件。

keystoneauth1.loading.load_auth_from_conf_options(conf: cfg.ConfigOpts, group: str, **kwargs: Any) → keystoneauth1.plugin.BaseAuthPlugin | None

从 oslo_config CONF 对象加载插件。

每个插件都会注册他们自己需要的选项，因此没有标准的列表，应该咨询插件。

在调用此函数之前，基本选项应该使用 register_conf_options 注册。

参数：
返回值:

一个认证插件，或者如果没有提供名称则为 None

返回类型:

keystoneauth1.plugin.BaseAuthPlugin

引发:

keystoneauth1.exceptions.auth_plugins.NoMatchingPlugin – 如果无法创建插件。

keystoneauth1.loading.load_session_from_argparse_arguments(namespace: Namespace, **kwargs: Any) → Session
keystoneauth1.loading.load_session_from_conf_options(conf: cfg.ConfigOpts, group: str, **kwargs: Any) → Session
keystoneauth1.loading.register_adapter_argparse_arguments(parser: ArgumentParser, service_type: str | None = None) → None
keystoneauth1.loading.register_adapter_conf_options(conf: cfg.ConfigOpts, group: str, include_deprecated: bool = True, deprecated_opts: dict[str, list[cfg.DeprecatedOpt]] | None = None) → list[cfg.Opt]
keystoneauth1.loading.register_auth_argparse_arguments(parser: ArgumentParser, argv: list[str], default: Any = None) → BaseLoader[plugin.BaseAuthPluginT] | None

注册创建插件所需的 CLI 选项。

该函数检查提供的参数，以便如果可用，它还可以注册该特定插件所需的选项。

参数：

  • parser (argparse.ArgumentParser) – 要附加 argparse 选项的解析器。

  • argv (list) – 提供给应用程序的参数。

  • default (str/class) – 如果 CLI 中未指定，则使用的默认插件名称或插件对象。默认值：None。

返回值:

将要加载的插件类或未提供时为 None。

返回类型:

keystoneauth1.loader.BaseLoader

引发:

keystoneauth1.exceptions.auth_plugins.NoMatchingPlugin – 如果无法创建插件。

keystoneauth1.loading.register_auth_conf_options(conf: cfg.ConfigOpts, group: str) → None

注册插件所需的 oslo_config 选项。

这仅注册所有插件共享的基本选项。插件特定的选项在读取它们之前才加载。

定义的选项是

  • auth_type: 将使用的身份验证插件的名称

    身份验证的身份验证插件的名称。

  • auth_section：应从中获取进一步的身份验证插件选项的组。

    如果未提供 section，则身份验证插件选项将从参数中提供的组中获取。

参数：
keystoneauth1.loading.register_service_adapter_argparse_arguments(parser: ArgumentParser, service_type: str) → None
keystoneauth1.loading.register_session_argparse_arguments(parser: ArgumentParser) → None
keystoneauth1.loading.register_session_conf_options(conf: cfg.ConfigOpts, group: str, deprecated_opts: dict[str, list[cfg.DeprecatedOpt]] | None = None) → list[cfg.Opt]