keystoneauth1.loading.adapter 模块

class keystoneauth1.loading.adapter.Adapter

基类: _BaseLoader[Adapter]

__abstractmethods__ = frozenset({})
__annotations__ = {}
__doc__ = None
__module__ = 'keystoneauth1.loading.adapter'
__orig_bases__ = (keystoneauth1.loading.base._BaseLoader[keystoneauth1.adapter.Adapter],)
__parameters__ = ()
_abc_impl = <_abc._abc_data object>
static get_conf_options(include_deprecated: bool = True, deprecated_opts: dict[str, list[cfg.DeprecatedOpt]] | None = None) → list[cfg.Opt]

获取 Adapter 所需的 oslo_config 选项。

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

设置的选项是
service_type:

URL 发现的默认 service_type。

service_name:

URL 发现的默认 service_name。

interface:

URL 发现的默认接口。（已弃用）

valid_interfaces:

URL 发现的可接受接口列表。可以是 ‘public’、‘internal’ 或 ‘admin’ 中的任何列表。

region_name:

URL 发现的默认 region_name。

endpoint_override:

始终为此客户端使用此端点 URL 进行请求。

version:

限制给定主要 API 的最低版本。与 min_version 和 max_version 互斥。

min_version:

给定 API 的最低主要版本，旨在与 max_version 一起用作范围的下限。与 version 互斥。如果提供 min_version 而没有 max_version，则 max 版本就像 ‘latest’ 一样。

max_version:

给定 API 的最大主版本，旨在用作与 min_version 范围的上限。与 version 互斥。

参数：

  • include_deprecated – 如果为 True（默认，为了向后兼容），则结果中包含弃用的选项。如果为 False，则排除它们。

  • deprecated_opts (dict) –

    应包含在新选项定义中的弃用选项。这应该是一个从新选项名称到对应于新选项的 oslo.DeprecatedOpts 列表的字典。（可选）

    例如，为了支持将 api_endpoint 选项指向新的 endpoint_override 选项名称

    old_opt = oslo_cfg.DeprecatedOpt('api_endpoint', 'old_group')
deprecated_opts = {'endpoint_override': [old_opt]}

返回值:

一个 oslo_config 选项列表。

get_options() → list[opts.Opt]

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

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

返回值:

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

返回类型:

列表

load_from_conf_options(conf: cfg.ConfigOpts, group: str, **kwargs: Any) → Adapter

从 oslo_config 对象创建 Adapter 对象。

这些选项必须先前使用 register_conf_options 注册。

参数：

  • conf (oslo_config.Cfg) – 要注册的配置对象。

  • group (string) – 注册选项的 ini 组。

  • kwargs (dict) – 传递给 Adapter 构造函数的其他参数。

返回值:

一个新的 Adapter 对象。

返回类型:

Adapter

property plugin_class: type[Adapter]
register_conf_options(conf: cfg.ConfigOpts, group: str, include_deprecated: bool = True, deprecated_opts: dict[str, list[cfg.DeprecatedOpt]] | None = None) → list[cfg.Opt]

注册 Adapter 所需的 oslo_config 选项。

设置的选项是
service_type:

URL 发现的默认 service_type。

service_name:

URL 发现的默认 service_name。

interface:

URL 发现的默认接口。（已弃用）

valid_interfaces:

URL 发现的可接受接口列表。可以是 ‘public’、‘internal’ 或 ‘admin’ 中的任何列表。

region_name:

URL 发现的默认 region_name。

endpoint_override:

始终为此客户端使用此端点 URL 进行请求。

version:

限制给定主要 API 的最低版本。与 min_version 和 max_version 互斥。

min_version:

给定 API 的最低主要版本，旨在与 max_version 一起用作范围的下限。与 version 互斥。如果提供 min_version 而没有 max_version，则 max 版本就像 ‘latest’ 一样。

max_version:

给定 API 的最大主版本，旨在用作与 min_version 范围的上限。与 version 互斥。

connect_retries:

应尝试的连接错误的重试次数上限。

status_code_retries:

应尝试的可重试 HTTP 状态代码的重试次数上限。

参数：

  • conf (oslo_config.Cfg) – 要注册的配置对象。

  • group (string) – 注册选项的 ini 组。

  • include_deprecated – 如果为 True（默认，为了向后兼容），则注册弃用的选项。如果为 False，则排除它们。

  • deprecated_opts (dict) –

    应包含在新选项定义中的弃用选项。这应该是一个从新选项名称到对应于新选项的 oslo.DeprecatedOpts 列表的字典。（可选）

    例如，为了支持将 api_endpoint 选项指向新的 endpoint_override 选项名称

    old_opt = oslo_cfg.DeprecatedOpt('api_endpoint', 'old_group')
deprecated_opts = {'endpoint_override': [old_opt]}

返回值:

已注册的选项列表。

keystoneauth1.loading.adapter.get_conf_options(include_deprecated: bool = True, deprecated_opts: dict[str, list[cfg.DeprecatedOpt]] | None = None) → list[cfg.Opt]
keystoneauth1.loading.adapter.load_from_conf_options(conf: cfg.ConfigOpts, group: str, **kwargs: Any) → Adapter
keystoneauth1.loading.adapter.process_conf_options(confgrp: cfg.OptGroup, kwargs: dict[str, Any]) → None

根据配置选项设置 Adapter 构造函数 kwargs。

参数：

  • confgrp (oslo_config.cfg.OptGroup) – 包含要检查选项的配置对象组。

  • kwargs (dict) – 适用于 keystoneauth1.adapter.Adapter 构造函数的关键字参数。此方法将修改已设置的值保持不变。

引发:

TypeError – 如果发现无效的配置选项值或组合。

keystoneauth1.loading.adapter.register_argparse_arguments(parser: ArgumentParser, service_type: str | None = None) → None
keystoneauth1.loading.adapter.register_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.adapter.register_service_argparse_arguments(parser: ArgumentParser, service_type: str) → None