keystoneauth1.loading.session 模块¶
- class keystoneauth1.loading.session.Session
基类:
_BaseLoader[Session]- __abstractmethods__ = frozenset({})
- __annotations__ = {}
- __doc__ = None
- __module__ = 'keystoneauth1.loading.session'
- __orig_bases__ = (keystoneauth1.loading.base._BaseLoader[keystoneauth1.session.Session],)
- __parameters__ = ()
- _abc_impl = <_abc._abc_data object>
- get_conf_options(deprecated_opts: dict[str, list[cfg.DeprecatedOpt]] | None = None) list[cfg.Opt]
获取
Session所需的 oslo_config 选项。这些可能对配置文件的生成或用于在注册它们之前操作选项很有用，而无需注册。
- 设置的选项是
- cafile:
证书颁发机构文件名。
- certfile:
要提供的客户端证书文件。
- keyfile:
客户端证书的密钥。
- insecure:
是否忽略 SSL 验证。
- timeout:
HTTP 连接的最大等待时间。
- collect-timing:
是否收集 API 定时信息。
- split-loggers:
是否将请求记录到多个记录器。
- 参数：
deprecated_opts (dict) –
应包含在新选项定义中的弃用选项。这应该是一个从新选项名称到对应于新选项的 oslo.DeprecatedOpts 列表的字典。（可选）
例如，为了支持
ca_file选项指向新的cafile选项名称old_opt = oslo_cfg.DeprecatedOpt('ca_file', 'old_group') deprecated_opts = {'cafile': [old_opt]}
- 返回值:
一个 oslo_config 选项列表。
- get_options() list[opts.Opt]
返回与身份验证插件关联的参数列表。
此列表可用于生成 CLI 或配置文件参数。
- 返回值:
描述可用插件参数的 Param 对象列表。
- 返回类型:
- load_from_conf_options(conf: cfg.ConfigOpts, group: str, **kwargs: Any) Session
从 oslo_config 对象创建一个会话对象。
这些选项必须先前使用 register_conf_options 注册。
- 参数：
conf (oslo_config.Cfg) – 要注册的配置对象。
group (string) – 注册选项的 ini 组。
kwargs (dict) – 传递给会话构造函数的附加参数。
- 返回值:
一个新的会话对象。
- 返回类型:
Session
- load_from_options(insecure: bool = False, verify: bool | str | None = None, cacert: str | None = None, cert: str | None = None, key: str | None = None, **kwargs: Any) Session
使用单独的证书参数创建会话。
一些用于创建会话的参数不适合从配置/CLI 等加载。通过将这些参数转换为会话 __init__ 参数来创建会话。
- property plugin_class: type[Session]
- register_argparse_arguments(parser: ArgumentParser) None
- register_conf_options(conf: cfg.ConfigOpts, group: str, deprecated_opts: dict[str, list[cfg.DeprecatedOpt]] | None = None) list[cfg.Opt]
注册会话所需的 oslo_config 选项。
- 设置的选项是
- cafile:
证书颁发机构文件名。
- certfile:
要提供的客户端证书文件。
- keyfile:
客户端证书的密钥。
- insecure:
是否忽略 SSL 验证。
- timeout:
HTTP 连接的最大等待时间。
- collect-timing:
是否收集 API 定时信息。
- split-loggers:
是否将请求记录到多个记录器。
- 参数：
conf (oslo_config.Cfg) – 要注册的配置对象。
group (string) – 注册选项的 ini 组。
deprecated_opts (dict) –
应包含在新选项定义中的弃用选项。这应该是一个从新选项名称到对应于新选项的 oslo.DeprecatedOpts 列表的字典。（可选）
例如，为了支持
ca_file选项指向新的cafile选项名称old_opt = oslo_cfg.DeprecatedOpt('ca_file', 'old_group') deprecated_opts = {'cafile': [old_opt]}
- 返回值:
已注册的选项列表。
- keystoneauth1.loading.session.get_conf_options(deprecated_opts: dict[str, list[cfg.DeprecatedOpt]] | None = None) list[cfg.Opt]
- keystoneauth1.loading.session.load_from_argparse_arguments(namespace: Namespace, **kwargs: Any) Session
- keystoneauth1.loading.session.load_from_conf_options(conf: cfg.ConfigOpts, group: str, **kwargs: Any) Session
- keystoneauth1.loading.session.register_argparse_arguments(parser: ArgumentParser) None
