openstack/oslo.config
Code Issues Proposed changes
Files
master
oslo.config/oslo_config/cfg.py
T
Stephen Finucane 1faa10cb50 trivial: Remove errant space from deprecation warning 
We also simplify this code in general while here.

Change-Id: Ic0bd28d3614c81252820aeeaf163c767692e9e91
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2026-08-31 22:52:09 +01:00

4314 lines
146 KiB
Python
Raw Permalink Blame History

# Copyright 2012 Red Hat, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""Primary module in oslo_config."""
import argparse
import collections
from collections.abc import Callable, Iterable, Iterator, Mapping, Sequence
import copy
import enum
import errno
import functools
import glob
import inspect
import itertools
import logging
import os
import pickle
import string
import sys
from typing import IO, Any, Protocol, TypedDict, cast
# NOTE(bnemec): oslo.log depends on oslo.config, so we can't
# have a hard dependency on oslo.log. However, in most cases
# oslo.log will be installed so we can use it.
try:
import oslo_log
except ImportError:
oslo_log = None # type: ignore[assignment]
from oslo_config import iniparser
from oslo_config import sources
# Absolute import to avoid circular import in Python 2.7
import oslo_config.sources._environment as _environment
from oslo_config import types
import stevedore
LOG = logging.getLogger(__name__)
_CONFIG_OPTS_STATE_VERSION = 1
def _identity(value: Any) -> Any:
return value
def _import_config_opts_state(state: Mapping[str, Any]) -> 'ConfigOpts':
return ConfigOpts.import_state(state)
def _import_global_config_opts_state(state: Mapping[str, Any]) -> 'ConfigOpts':
CONF.__setstate__(state)
return CONF
class _SupportsLog(Protocol):
"""Protocol for objects that support the log() interface."""
def log(self, level: int, msg: object, *args: object) -> None: ...
_SOURCE_DRIVER_OPTION_HELP = (
'The name of the driver that can load this configuration source.'
)
class Locations(enum.Enum):
opt_default = (1, False)
set_default = (2, False)
set_override = (3, False)
user = (4, True)
command_line = (5, True)
environment = (6, True)
def __init__(self, num: int, is_user_controlled: bool) -> None:
self.num = num
self.is_user_controlled = is_user_controlled
LocationInfo = collections.namedtuple('LocationInfo', ['location', 'detail'])
class Error(Exception):
"""Base class for cfg exceptions."""
def __init__(self, msg: str | None = None) -> None:
self.msg = msg
def __str__(self) -> str:
return self.msg or ''
class NotInitializedError(Error):
"""Raised if parser is not initialized yet."""
def __str__(self) -> str:
return "call expression on parser has not been invoked"
class ArgsAlreadyParsedError(Error):
"""Raised if a CLI opt is registered after parsing."""
def __str__(self) -> str:
ret = "arguments already parsed"
if self.msg:
ret += ": " + self.msg
return ret
class NoSuchOptError(Error, AttributeError):
"""Raised if an opt which doesn't exist is referenced."""
def __init__(self, opt_name: str, group: 'OptGroup | None' = None) -> None:
self.opt_name = opt_name
self.group = group
def __str__(self) -> str:
group_name = 'DEFAULT' if self.group is None else self.group.name
return f"no such option {self.opt_name} in group [{group_name}]"
class NoSuchGroupError(Error):
"""Raised if a group which doesn't exist is referenced."""
def __init__(self, group_name: str) -> None:
self.group_name = group_name
def __str__(self) -> str:
return f"no such group [{self.group_name}]"
class DuplicateOptError(Error):
"""Raised if multiple opts with the same name are registered."""
def __init__(self, opt_name: str) -> None:
self.opt_name = opt_name
def __str__(self) -> str:
return f"duplicate option: {self.opt_name}"
class RequiredOptError(Error):
"""Raised if an option is required but no value is supplied by the user."""
def __init__(
self, opt_name: str, group: 'OptGroup | str | None' = None
) -> None:
self.opt_name = opt_name
self.group = group
def __str__(self) -> str:
if isinstance(self.group, str):
group_name = self.group
elif self.group:
group_name = self.group.name
else:
group_name = 'DEFAULT'
return (
f"value required for option {self.opt_name} in group "
f"[{group_name}]"
)
class TemplateSubstitutionError(Error):
"""Raised if an error occurs substituting a variable in an opt value."""
def __str__(self) -> str:
return f"template substitution error: {self.msg}"
class ConfigFilesNotFoundError(Error):
"""Raised if one or more config files are not found."""
def __init__(self, config_files: Iterable[str]) -> None:
self.config_files = config_files
def __str__(self) -> str:
return 'Failed to find some config files: {}'.format(
",".join(self.config_files)
)
class ConfigFilesPermissionDeniedError(Error):
"""Raised if one or more config files are not readable."""
def __init__(self, config_files: Iterable[str]) -> None:
self.config_files = config_files
def __str__(self) -> str:
return 'Failed to open some config files: {}'.format(
",".join(self.config_files)
)
class ConfigDirNotFoundError(Error):
"""Raised if the requested config-dir is not found."""
def __init__(self, config_dir: str) -> None:
self.config_dir = config_dir
def __str__(self) -> str:
return f'Failed to read config file directory: {self.config_dir}'
class ConfigFileParseError(Error):
"""Raised if there is an error parsing a config file."""
def __init__(self, config_file: str, msg: str) -> None:
self.config_file = config_file
self.msg = msg
def __str__(self) -> str:
return f'Failed to parse {self.config_file}: {self.msg}'
class ConfigOptsSerializationError(Error):
"""Raised if a ConfigOpts instance cannot be serialized safely."""
class ConfigSourceValueError(Error, ValueError):
"""Raised if a config source value does not match its opt type."""
pass
class ConfigFileValueError(ConfigSourceValueError):
"""Raised if a config file value does not match its opt type."""
pass
class DefaultValueError(Error, ValueError):
"""Raised if a default config type does not fit the opt type."""
def _fixpath(p: str) -> str:
"""Apply tilde expansion and absolutization to a path."""
return os.path.abspath(os.path.expanduser(p))
def _get_config_dirs(project: str | None = None) -> list[str]:
"""Return a list of directories where config files may be located.
:param project: an optional project name
If a project is specified, following directories are returned::
~/.${project}/
~/
/etc/${project}/
/etc/
If a project is specified and installed from a snap package, following
directories are also returned:
${SNAP_COMMON}/etc/${project}
${SNAP}/etc/${project}
Otherwise, if project is not specified, these directories are returned:
~/
/etc/
"""
snap = os.environ.get('SNAP')
snap_c = os.environ.get('SNAP_COMMON')
cfg_dirs: list[str | None] = [
_fixpath(os.path.join('~', '.' + project)) if project else None,
_fixpath('~'),
os.path.join('/etc', project) if project else None,
'/etc',
os.path.join(snap_c, "etc", project) if snap_c and project else None,
os.path.join(snap, "etc", project) if snap and project else None,
]
return [x for x in cfg_dirs if x]
def _search_dirs(
dirs: list[str], basename: str, extension: str = ""
) -> str | None:
"""Search a list of directories for a given filename or directory name.
Iterator over the supplied directories, returning the first file
found with the supplied name and extension.
:param dirs: a list of directories
:param basename: the filename or directory name, for example 'glance-api'
:param extension: the file extension, for example '.conf'
:returns: the path to a matching file or directory, or None
"""
for d in dirs:
path = os.path.join(d, f'{basename}{extension}')
if os.path.exists(path):
return path
return None
def _find_config_files(
project: str | None, prog: str | None, extension: str
) -> list[str]:
if prog is None:
prog = os.path.basename(sys.argv[0])
if prog.endswith(".py"):
prog = prog[:-3]
cfg_dirs = _get_config_dirs(project)
config_files = (
_search_dirs(cfg_dirs, p, extension) for p in [project, prog] if p
)
return [x for x in config_files if x]
def find_config_files(
project: str | None = None,
prog: str | None = None,
extension: str = '.conf',
) -> list[str]:
"""Return a list of default configuration files.
:param project: an optional project name
:param prog: the program name, defaulting to the basename of
sys.argv[0], without extension .py
:param extension: the type of the config file
We default to two config files: [${project}.conf, ${prog}.conf]
And we look for those config files in the following directories::
~/.${project}/
~/
/etc/${project}/
/etc/
${SNAP_COMMON}/etc/${project}
${SNAP}/etc/${project}
We return an absolute path for (at most) one of each the default config
files, for the topmost directory it exists in.
For example, if project=foo, prog=bar and /etc/foo/foo.conf, /etc/bar.conf
and ~/.foo/bar.conf all exist, then we return ['/etc/foo/foo.conf',
'~/.foo/bar.conf']
If no project name is supplied, we only look for ${prog}.conf.
"""
return _find_config_files(project, prog, extension)
def find_config_dirs(
project: str | None = None,
prog: str | None = None,
extension: str = '.conf.d',
) -> list[str]:
"""Return a list of default configuration dirs.
:param project: an optional project name
:param prog: the program name, defaulting to the basename of
sys.argv[0], without extension .py
:param extension: the type of the config directory. Defaults to '.conf.d'
We default to two config dirs: [${project}.conf.d/, ${prog}.conf.d/].
If no project name is supplied, we only look for ${prog}.conf.d/.
And we look for those config dirs in the following directories::
~/.${project}/
~/
/etc/${project}/
/etc/
${SNAP_COMMON}/etc/${project}
${SNAP}/etc/${project}
We return an absolute path for each of the two config dirs,
in the first place we find it (iff we find it).
For example, if project=foo, prog=bar and /etc/foo/foo.conf.d/,
/etc/bar.conf.d/ and ~/.foo/bar.conf.d/ all exist, then we return
['/etc/foo/foo.conf.d/', '~/.foo/bar.conf.d/']
"""
return _find_config_files(project, prog, extension)
def _is_opt_registered(opts: 'dict[str, _OptInfo]', opt: 'Opt') -> bool:
"""Check whether an opt with the same name is already registered.
The same opt may be registered multiple times, with only the first
registration having any effect. However, it is an error to attempt
to register a different opt with the same name.
:param opts: the set of opts already registered
:param opt: the opt to be registered
:returns: True if the opt was previously registered, False otherwise
:raises: DuplicateOptError if a naming conflict is detected
"""
if opt.dest in opts:
if opts[opt.dest]['opt'] != opt:
raise DuplicateOptError(opt.name)
return True
else:
return False
_show_caller_details = bool(os.environ.get('OSLO_CONFIG_SHOW_CODE_LOCATIONS'))
def _get_caller_detail(n: int = 2) -> str | None:
"""Return a string describing where this is being called from.
:param n: Number of steps up the stack to look. Defaults to ``2``.
:returns: str
"""
if not _show_caller_details:
return None
s = inspect.stack()[: n + 1]
try:
frame = s[n]
try:
return frame[1]
# WARNING(dhellmann): Using frame.lineno to include the
# line number in the return value causes some sort of
# memory or stack corruption that manifests in values not
# being cleaned up in the cfgfilter tests.
# return '%s:%s' % (frame[1], frame[2])
finally:
del frame
finally:
del s
def set_defaults(opts: Sequence['Opt'], **kwargs: Any) -> None:
for opt in opts:
if opt.dest in kwargs:
opt.default = kwargs[opt.dest]
opt._set_location = LocationInfo(
Locations.set_default, _get_caller_detail()
)
def _normalize_group_name(group_name: str) -> str:
if group_name == 'DEFAULT':
return group_name
return group_name.lower()
def _report_deprecation(
format_str: str, format_dict: Mapping[str, str | None]
) -> None:
"""Report use of a deprecated option
Uses versionutils from oslo.log if it is available. If not, logs
a simple warning message.
:param format_str: The message to use for the report
:param format_dict: A dict containing keys for any parameters in format_str
"""
if oslo_log:
# We can't import versionutils at the module level because of circular
# imports. Importing just oslo_log at the module level and
# versionutils locally allows us to unit test this and still avoid the
# circular problem.
from oslo_log import versionutils
versionutils.report_deprecated_feature(LOG, format_str, format_dict)
else:
LOG.warning(format_str, format_dict)
@functools.total_ordering
class Opt:
"""Base class for all configuration options.
The only required parameter is the option's name. However, it is
common to also supply a default and help string for all options.
:param name: the option's name
:param type: the option's type. Must be a callable object that takes string
and returns converted and validated value
:param dest: the name of the corresponding :class:`.ConfigOpts` property
:param short: a single character CLI option name
:param default: the default value of the option
:param positional: True if the option is a positional CLI argument
:param metavar: the option argument to show in --help
:param help: an explanation of how the option is used
:param secret: true if the value should be obfuscated in log output
:param required: true if a value must be supplied for this option
:param deprecated_name: deprecated name option. Acts like an alias
:param deprecated_group: the group containing a deprecated alias
:param deprecated_opts: list of :class:`.DeprecatedOpt`
:param sample_default: a default string for sample config files
:param deprecated_for_removal: indicates whether this opt is planned for
removal in a future release
:param deprecated_reason: indicates why this opt is planned for removal in
a future release. Silently ignored if ``deprecated_for_removal`` is
``False``
:param deprecated_since: indicates which release this opt was deprecated
in. Accepts any string, though valid version strings are encouraged.
Silently ignored if ``deprecated_for_removal`` is ``False``
:param mutable: True if this option may be reloaded
:param advanced: indicates whether this option has advanced usage and is
not normally used by the majority of users
An Opt object has no public methods, but has a number of public properties:
.. py:attribute:: name
the name of the option, which may include hyphens
.. py:attribute:: type
a callable object that takes string and returns converted and
validated value. Default types are available from
:class:`oslo_config.types`
.. py:attribute:: dest
the (hyphen-less) :class:`.ConfigOpts` property which contains the
option value
.. py:attribute:: short
a single character CLI option name
.. py:attribute:: default
the default value of the option
.. py:attribute:: sample_default
a sample default value string to include in sample config files
.. py:attribute:: positional
True if the option is a positional CLI argument
.. py:attribute:: metavar
the name shown as the argument to a CLI option in --help output
.. py:attribute:: help
a string explaining how the option's value is used
.. py:attribute:: advanced
in sample files, a bool value indicating the option is advanced
.. versionchanged:: 1.2
Added *deprecated_opts* parameter.
.. versionchanged:: 1.4
Added *sample_default* parameter.
.. versionchanged:: 1.9
Added *deprecated_for_removal* parameter.
.. versionchanged:: 2.7
An exception is now raised if the default value has the wrong type.
.. versionchanged:: 3.2
Added *deprecated_reason* parameter.
.. versionchanged:: 3.5
Added *mutable* parameter.
.. versionchanged:: 3.12
Added *deprecated_since* parameter.
.. versionchanged:: 3.15
Added *advanced* parameter and attribute.
"""
multi: bool = False
def __init__(
self,
name: str,
type: types.ConfigType | None = None,
dest: str | None = None,
short: str | None = None,
default: Any = None,
positional: bool = False,
metavar: str | None = None,
help: str | None = None,
secret: bool = False,
required: bool | None = None,
deprecated_name: str | None = None,
deprecated_group: str | None = None,
deprecated_opts: Sequence['DeprecatedOpt'] | None = None,
sample_default: str | None = None,
deprecated_for_removal: bool = False,
deprecated_reason: str | None = None,
deprecated_since: str | None = None,
mutable: bool = False,
advanced: bool = False,
) -> None:
if name.startswith('_'):
raise ValueError(f'illegal name {name} with prefix _')
self.name = name
if type is None:
type = types.String()
if not callable(type):
raise TypeError('type must be callable')
self.type = type
# By default, non-positional options are *optional*, and positional
# options are *required*.
if required is None:
required = True if positional else False
if dest is None:
self.dest = self.name.replace('-', '_')
else:
self.dest = dest
self.short = short
self.default = default
self.sample_default = sample_default
self.positional = positional
self.metavar = metavar
self.help = help
self.secret = secret
self.required = required
self.deprecated_for_removal = deprecated_for_removal
self.deprecated_reason = deprecated_reason
self.deprecated_since = deprecated_since
self._logged_deprecation = False
if self.__class__ is Opt:
stack_depth = 2 # someone instantiated Opt directly
else:
stack_depth = 3 # skip the call to the child class constructor
self._set_location = LocationInfo(
Locations.opt_default,
_get_caller_detail(stack_depth),
)
self.deprecated_opts: list[DeprecatedOpt] = (
list(copy.deepcopy(deprecated_opts)) if deprecated_opts else []
)
for o in self.deprecated_opts:
if o.name and '-' in o.name:
self.deprecated_opts.append(
DeprecatedOpt(o.name.replace('-', '_'), group=o.group)
)
if deprecated_name is not None or deprecated_group is not None:
self.deprecated_opts.append(
DeprecatedOpt(deprecated_name, group=deprecated_group)
)
if deprecated_name and '-' in deprecated_name:
self.deprecated_opts.append(
DeprecatedOpt(
deprecated_name.replace('-', '_'),
group=deprecated_group,
)
)
self._check_default()
self.mutable = mutable
self.advanced = advanced
def _default_is_ref(self) -> bool:
"""Check if default is a reference to another var."""
if isinstance(self.default, str):
tmpl = self.default.replace(r'\$', '').replace('$$', '')
return '$' in tmpl
return False
def _check_default(self) -> None:
if self.default is not None and not self._default_is_ref():
try:
self.type(self.default)
except Exception:
raise DefaultValueError(
"Error processing default value "
f"{self.default} for Opt type of {self.type}."
)
def _vars_for_cmp(self) -> dict[str, Any]:
# NOTE(dhellmann): Get the instance variables of this Opt and
# then make a new dictionary so we can modify the contents
# before returning it without removing any attributes of the
# object.
v = dict(vars(self))
# NOTE(dhellmann): Ignore the location where the option is
# defined when comparing them. Ideally we could use this to
# detect duplicate settings in code bases, but as long as the
# options match otherwise they should be safe.
if '_set_location' in v:
del v['_set_location']
return v
def __ne__(self, another: object) -> bool:
if not isinstance(another, Opt):
return NotImplemented
return self._vars_for_cmp() != another._vars_for_cmp()
def __eq__(self, another: object) -> bool:
if not isinstance(another, Opt):
return NotImplemented
return self._vars_for_cmp() == another._vars_for_cmp()
__hash__ = object.__hash__
def _get_from_namespace(
self, namespace: '_Namespace', group_name: str | None
) -> tuple[Any, 'LocationInfo | None']:
"""Retrieves the option value from a _Namespace object.
:param namespace: a _Namespace object
:param group_name: a group name
"""
names = [(group_name, self.dest)]
current_name = (group_name, self.name)
for opt in self.deprecated_opts:
dname, dgroup = opt.name, opt.group
if dname or dgroup:
names.append(
(
dgroup if dgroup else group_name,
dname if dname else self.dest,
)
)
value, loc = namespace._get_value(
names,
multi=self.multi,
positional=self.positional,
current_name=current_name,
)
# The previous line will raise a KeyError if no value is set in the
# config file, so we'll only log deprecations for set options.
if self.deprecated_for_removal and not self._logged_deprecation:
self._logged_deprecation = True
pretty_group = group_name or 'DEFAULT'
if self.deprecated_reason:
pretty_reason = f' ({self.deprecated_reason})'
else:
pretty_reason = ''
format_str = (
'Option "%(option)s" from group "%(group)s" is '
'deprecated for removal%(reason)s. Its value may '
'be silently ignored in the future.'
)
format_dict = {
'option': self.dest,
'group': pretty_group,
'reason': pretty_reason,
}
_report_deprecation(format_str, format_dict)
return (value, loc)
def _add_to_cli(
self, parser: '_CachedArgumentParser', group: 'OptGroup | None' = None
) -> None:
"""Makes the option available in the command line interface.
This is the method ConfigOpts uses to add the opt to the CLI interface
as appropriate for the opt type. Some opt types may extend this method,
others may just extend the helper methods it uses.
:param parser: the CLI option parser
:param group: an optional OptGroup object
"""
container = self._get_argparse_container(parser, group)
kwargs = self._get_argparse_kwargs(group)
prefix = self._get_argparse_prefix('', group.name if group else None)
deprecated_names = []
for opt in self.deprecated_opts:
deprecated_name = self._get_deprecated_cli_name(
opt.name, opt.group
)
if deprecated_name is not None:
deprecated_names.append(deprecated_name)
self._add_to_argparse(
parser,
container,
self.name,
self.short,
kwargs,
prefix,
self.positional,
deprecated_names,
)
def _add_to_argparse(
self,
parser: '_CachedArgumentParser',
container: argparse._ActionsContainer,
name: str,
short: str | None,
kwargs: dict[str, Any],
prefix: str = '',
positional: bool = False,
deprecated_names: list[str] | None = None,
) -> None:
"""Add an option to an argparse parser or group.
:param container: an argparse._ArgumentGroup object
:param name: the opt name
:param short: the short opt name
:param kwargs: the keyword arguments for add_argument()
:param prefix: an optional prefix to prepend to the opt name
:param positional: whether the option is a positional CLI argument
:param deprecated_names: list of deprecated option names
"""
def hyphen(arg: str) -> str:
return arg if not positional else ''
# Because we must omit the dest parameter when using a positional
# argument, the name supplied for the positional argument must not
# include hyphens.
if positional:
prefix = prefix.replace('-', '_')
name = name.replace('-', '_')
args = [hyphen('--') + prefix + name]
if short:
args.append(hyphen('-') + short)
for deprecated_name in deprecated_names or []:
args.append(hyphen('--') + deprecated_name)
parser.add_parser_argument(container, *args, **kwargs)
def _get_argparse_container(
self,
parser: '_CachedArgumentParser',
group: 'OptGroup | None',
) -> argparse._ActionsContainer:
"""Returns an argparse._ArgumentGroup.
:param parser: an argparse.ArgumentParser
:param group: an (optional) OptGroup object
:returns: an argparse._ArgumentGroup if group is given, else parser
"""
if group is not None:
return group._get_argparse_group(parser)
else:
return parser
def _get_argparse_kwargs(
self, group: 'OptGroup | None', **kwargs: Any
) -> dict[str, Any]:
r"""Build a dict of keyword arguments for argparse's add_argument().
Most opt types extend this method to customize the behaviour of the
options added to argparse.
:param group: an optional group
:param \*\*kwargs: optional keyword arguments to add to
:returns: a dict of keyword arguments
"""
if not self.positional:
dest = self.dest
if group is not None:
dest = group.name + '_' + dest
kwargs['dest'] = dest
elif not self.required:
kwargs['nargs'] = '?'
kwargs.update(
{
'default': None,
'metavar': self.metavar,
'help': self.help,
}
)
return kwargs
def _get_argparse_prefix(self, prefix: str, group_name: str | None) -> str:
"""Build a prefix for the CLI option name, if required.
CLI options in a group are prefixed with the group's name in order
to avoid conflicts between similarly named options in different
groups.
:param prefix: an existing prefix to append to (for example 'no' or '')
:param group_name: an optional group name
:returns: a CLI option prefix including the group name, if appropriate
"""
if group_name is not None:
return group_name + '-' + prefix
else:
return prefix
def _get_deprecated_cli_name(
self, dname: str | None, dgroup: str | None, prefix: str = ''
) -> str | None:
"""Build a CLi arg name for deprecated options.
Either a deprecated name or a deprecated group or both or
neither can be supplied:
dname, dgroup -> dgroup + '-' + dname
dname -> dname
dgroup -> dgroup + '-' + self.name
neither -> None
:param dname: a deprecated name, which can be None
:param dgroup: a deprecated group, which can be None
:param prefix: an prefix to append to (for example 'no' or '')
:returns: a CLI argument name
"""
if dgroup == 'DEFAULT':
dgroup = None
if dname is None and dgroup is None:
return None
if dname is None:
dname = self.name
return self._get_argparse_prefix(prefix, dgroup) + dname
def __lt__(self, another: object) -> bool:
return hash(self) < hash(another)
class DeprecatedOpt:
"""Represents a Deprecated option.
Here's how you can use it::
oldopts = [
cfg.DeprecatedOpt('oldopt1', group='group1'),
cfg.DeprecatedOpt('oldopt2', group='group2'),
]
cfg.CONF.register_group(cfg.OptGroup('group1'))
cfg.CONF.register_opt(
cfg.StrOpt('newopt', deprecated_opts=oldopts), group='group1'
)
For options which have a single value (like in the example above),
if the new option is present ("[group1]/newopt" above), it will override
any deprecated options present ("[group1]/oldopt1" and "[group2]/oldopt2"
above).
If no group is specified for a DeprecatedOpt option (i.e. the group is
None), lookup will happen within the same group the new option is in.
For example, if no group was specified for the second option 'oldopt2' in
oldopts list::
oldopts = [
cfg.DeprecatedOpt('oldopt1', group='group1'),
cfg.DeprecatedOpt('oldopt2'),
]
cfg.CONF.register_group(cfg.OptGroup('group1'))
cfg.CONF.register_opt(
cfg.StrOpt('newopt', deprecated_opts=oldopts), group='group1'
)
then lookup for that option will happen in group 'group1'.
If the new option is not present and multiple deprecated options are
present, the option corresponding to the first element of deprecated_opts
will be chosen.
Multi-value options will return all new and deprecated
options. So if we have a multi-value option "[group1]/opt1" whose
deprecated option is "[group2]/opt2", and the conf file has both these
options specified like so::
[group1]
opt1 = val10, val11
[group2]
opt2 = val21, val22
Then the value of "[group1]/opt1" will be ['val10', 'val11', 'val21',
'val22'].
.. versionadded:: 1.2
"""
def __init__(self, name: str | None, group: str | None = None) -> None:
"""Constructs an DeprecatedOpt object.
:param name: the name of the option
:param group: the group of the option
"""
self.name = name
self.group = group
def __key(self) -> tuple[str | None, str | None]:
return (self.name, self.group)
def __eq__(self, other: object) -> bool:
if not isinstance(other, DeprecatedOpt):
return NotImplemented
return self.__key() == other.__key()
def __hash__(self) -> int:
return hash(self.__key())
class StrOpt(Opt):
r"""Option with String type
Option with ``type`` :class:`oslo_config.types.String`
:param name: the option's name
:param choices: Optional sequence of either valid values or tuples of valid
values with descriptions.
:param quotes: If ``True`` and string is enclosed with single or double
quotes, will strip those quotes.
:param regex: Optional regular expression (string or compiled regex) that
the value must match on an unanchored search.
:param ignore_case: If True case differences (uppercase vs. lowercase)
between 'choices' or 'regex' will be ignored.
:param max_length: If positive integer, the value must be less than or
equal to this parameter.
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionchanged:: 2.7
Added *quotes* parameter
.. versionchanged:: 2.7
Added *regex* parameter
.. versionchanged:: 2.7
Added *ignore_case* parameter
.. versionchanged:: 2.7
Added *max_length* parameter
.. versionchanged:: 5.2
The *choices* parameter will now accept a sequence of tuples, where each
tuple is of form (*choice*, *description*)
"""
def __init__(
self,
name: str,
choices: Any = None,
quotes: bool | None = None,
regex: str | None = None,
ignore_case: bool = False,
max_length: int | None = None,
**kwargs: Any,
) -> None:
super().__init__(
name,
type=types.String(
choices=choices,
quotes=quotes or False,
regex=regex,
ignore_case=ignore_case,
max_length=max_length,
),
**kwargs,
)
def _get_choice_text(self, choice: Any) -> str:
if choice is None:
return '<None>'
elif choice == '':
return "''"
return str(choice)
def _get_argparse_kwargs(
self, group: 'OptGroup | None', **kwargs: Any
) -> dict[str, Any]:
"""Extends the base argparse keyword dict for the config dir option."""
kwargs = super()._get_argparse_kwargs(group)
choices = getattr(self.type, 'choices', None)
if choices:
choices_text = ', '.join(
[self._get_choice_text(choice) for choice in choices]
)
if kwargs['help'] is None:
kwargs['help'] = ''
kwargs['help'].rstrip('\n')
kwargs['help'] += f'\n Allowed values: {choices_text}\n'
return kwargs
class BoolOpt(Opt):
r"""Boolean options.
Bool opts are set to True or False on the command line using --optname or
--nooptname respectively.
In config files, boolean values are cast with Boolean type.
:param name: the option's name
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
"""
def __init__(self, name: str, **kwargs: Any) -> None:
if 'positional' in kwargs:
raise ValueError('positional boolean args not supported')
super().__init__(name, type=types.Boolean(), **kwargs)
def _add_to_cli(
self, parser: '_CachedArgumentParser', group: 'OptGroup | None' = None
) -> None:
"""Extends the base class method to add the --nooptname option."""
super()._add_to_cli(parser, group)
self._add_inverse_to_argparse(parser, group)
def _add_inverse_to_argparse(
self, parser: '_CachedArgumentParser', group: 'OptGroup | None'
) -> None:
"""Add the --nooptname option to the option parser."""
container = self._get_argparse_container(parser, group)
kwargs = self._get_argparse_kwargs(group, action='store_false')
prefix = self._get_argparse_prefix('no', group.name if group else None)
deprecated_names = []
for opt in self.deprecated_opts:
deprecated_name = self._get_deprecated_cli_name(
opt.name, opt.group, prefix='no'
)
if deprecated_name is not None:
deprecated_names.append(deprecated_name)
kwargs["help"] = "The inverse of --" + self.name
self._add_to_argparse(
parser,
container,
self.name,
None,
kwargs,
prefix,
self.positional,
deprecated_names,
)
def _get_argparse_kwargs(
self,
group: 'OptGroup | None',
action: str = 'store_true',
**kwargs: Any,
) -> dict[str, Any]:
"""Extends the base argparse keyword dict for boolean options."""
kwargs = super()._get_argparse_kwargs(group, **kwargs)
# type has no effect for BoolOpt, it only matters for
# values that came from config files
if 'type' in kwargs:
del kwargs['type']
# metavar has no effect for BoolOpt
if 'metavar' in kwargs:
del kwargs['metavar']
kwargs['action'] = action
return kwargs
class IntOpt(Opt):
r"""Option with Integer type
Option with ``type`` :class:`oslo_config.types.Integer`
:param name: the option's name
:param min: minimum value the integer can take
:param max: maximum value the integer can take
:param choices: Optional sequence of either valid values or tuples of valid
values with descriptions.
:param sample_min: a minimum value string for sample config files
:param sample_max: a maximum value string for sample config files
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionchanged:: 1.15
Added *min* and *max* parameters.
.. versionchanged:: 9.3.0
Added *choices* parameter.
.. versionchanged:: 10.7.0
Added sample_min and sample_max,
"""
def __init__(
self,
name: str,
min: int | None = None,
max: int | None = None,
choices: Any = None,
sample_min: str | None = None,
sample_max: str | None = None,
**kwargs: Any,
) -> None:
super().__init__(
name,
type=types.Integer(
min=min,
max=max,
choices=choices,
sample_min=sample_min,
sample_max=sample_max,
),
**kwargs,
)
class FloatOpt(Opt):
r"""Option with Float type
Option with ``type`` :class:`oslo_config.types.Float`
:param name: the option's name
:param min: minimum value the float can take
:param max: maximum value the float can take
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionchanged:: 3.14
Added *min* and *max* parameters.
"""
def __init__(
self,
name: str,
min: float | None = None,
max: float | None = None,
**kwargs: Any,
) -> None:
super().__init__(name, type=types.Float(min, max), **kwargs)
class ListOpt(Opt):
r"""Option with List(String) type
Option with ``type`` :class:`oslo_config.types.List`
:param name: the option's name
:param item_type: type of items (see :class:`oslo_config.types`)
:param bounds: if True the value should be inside "[" and "]" pair
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionchanged:: 2.5
Added *item_type* and *bounds* parameters.
"""
def __init__(
self,
name: str,
item_type: types.ConfigType | None = None,
bounds: bool | None = None,
**kwargs: Any,
) -> None:
super().__init__(
name,
type=types.List(item_type=item_type, bounds=bounds or False),
**kwargs,
)
class DictOpt(Opt):
r"""Option with Dict(String) type
Option with ``type`` :class:`oslo_config.types.Dict`
:param name: the option's name
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionadded:: 1.2
"""
def __init__(self, name: str, **kwargs: Any) -> None:
super().__init__(name, type=types.Dict(), **kwargs)
class IPOpt(Opt):
r"""Opt with IPAddress type
Option with ``type`` :class:`oslo_config.types.IPAddress`
:param name: the option's name
:param version: one of either ``4``, ``6``, or ``None`` to specify
either version.
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionadded:: 1.4
"""
def __init__(
self, name: str, version: int | None = None, **kwargs: Any
) -> None:
super().__init__(name, type=types.IPAddress(version), **kwargs)
class PortOpt(Opt):
r"""Option for a TCP/IP port number. Ports can range from 0 to 65535.
Option with ``type`` :class:`oslo_config.types.Integer`
:param name: the option's name
:param min: minimum value the port can take
:param max: maximum value the port can take
:param choices: Optional sequence of either valid values or tuples of valid
values with descriptions.
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionadded:: 2.6
.. versionchanged:: 3.2
Added *choices* parameter.
.. versionchanged:: 3.4
Allow port number with 0.
.. versionchanged:: 3.16
Added *min* and *max* parameters.
.. versionchanged:: 5.2
The *choices* parameter will now accept a sequence of tuples, where each
tuple is of form (*choice*, *description*)
"""
def __init__(
self,
name: str,
min: int | None = None,
max: int | None = None,
choices: Any = None,
**kwargs: Any,
) -> None:
type = types.Port(
min=min, max=max, choices=choices, type_name='port value'
)
super().__init__(name, type=type, **kwargs)
class HostnameOpt(Opt):
r"""Option for a hostname. Only accepts valid hostnames.
Option with ``type`` :class:`oslo_config.types.Hostname`
:param name: the option's name
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionadded:: 3.8
"""
def __init__(self, name: str, **kwargs: Any) -> None:
super().__init__(name, type=types.Hostname(), **kwargs)
class HostAddressOpt(Opt):
r"""Option for either an IP or a hostname.
Accepts valid hostnames and valid IP addresses.
Option with ``type`` :class:`oslo_config.types.HostAddress`
:param name: the option's name
:param version: one of either ``4``, ``6``, or ``None`` to specify
either version.
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionadded:: 3.22
"""
def __init__(
self, name: str, version: int | None = None, **kwargs: Any
) -> None:
super().__init__(name, type=types.HostAddress(version), **kwargs)
class HostDomainOpt(Opt):
r"""Option for either an IP or a hostname.
Like HostAddress with the support of _ character.
Option with ``type`` :class:`oslo_config.types.HostDomain`
:param name: the option's name
:param version: one of either ``4``, ``6``, or ``None`` to specify
either version.
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionadded:: 8.6
"""
def __init__(
self, name: str, version: int | None = None, **kwargs: Any
) -> None:
super().__init__(name, type=types.HostDomain(version), **kwargs)
class URIOpt(Opt):
r"""Opt with URI type
Option with ``type`` :class:`oslo_config.types.URI`
:param name: the option's name
:param max_length: If positive integer, the value must be less than or
equal to this parameter.
:param schemes: iterable of valid URI schemes, e.g. 'https', 'ftp', 'git'
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionadded:: 3.12
.. versionchanged:: 3.14
Added *max_length* parameter
.. versionchanged:: 3.18
Added *schemes* parameter
"""
def __init__(
self,
name: str,
max_length: int | None = None,
schemes: Iterable[str] | None = None,
**kwargs: Any,
) -> None:
type = types.URI(max_length=max_length, schemes=schemes)
super().__init__(name, type=type, **kwargs)
class MultiOpt(Opt):
r"""Multi-value option.
Multi opt values are typed opts which may be specified multiple times.
The opt value is a list containing all the values specified.
:param name: the option's name
:param item_type: Type of items (see :class:`oslo_config.types`)
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
For example::
cfg.MultiOpt(
'foo',
item_type=types.Integer(),
default=None,
help="Multiple foo option",
)
The command line ``--foo=1 --foo=2`` would result in ``cfg.CONF.foo``
containing ``[1,2]``
.. versionadded:: 1.3
"""
multi: bool = True
def __init__(
self, name: str, item_type: types.ConfigType, **kwargs: Any
) -> None:
super().__init__(name, item_type, **kwargs)
def _get_argparse_kwargs(
self, group: 'OptGroup | None', **kwargs: Any
) -> dict[str, Any]:
"""Extends the base argparse keyword dict for multi value options."""
kwargs = super()._get_argparse_kwargs(group)
if not self.positional:
kwargs['action'] = 'append'
else:
kwargs['nargs'] = '*'
return kwargs
class MultiStrOpt(MultiOpt):
r"""MultiOpt with a MultiString ``item_type``.
MultiOpt with a default :class:`oslo_config.types.MultiString` item
type.
:param name: the option's name
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`MultiOpt`
"""
def __init__(self, name: str, **kwargs: Any) -> None:
super().__init__(name, item_type=types.MultiString(), **kwargs)
class SubCommandOpt(Opt):
"""Sub-command options.
Sub-command options allow argparse sub-parsers to be used to parse
additional command line arguments.
The handler argument to the SubCommandOpt constructor is a callable
which is supplied an argparse subparsers object. Use this handler
callable to add sub-parsers.
The opt value is SubCommandAttr object with the name of the chosen
sub-parser stored in the 'name' attribute and the values of other
sub-parser arguments available as additional attributes.
:param name: the option's name
:param dest: the name of the corresponding :class:`.ConfigOpts` property
:param handler: callable which is supplied subparsers object when invoked
:param title: title of the sub-commands group in help output
:param description: description of the group in help output
:param help: a help string giving an overview of available sub-commands
"""
def __init__(
self,
name: str,
dest: str | None = None,
handler: Any = None,
title: str | None = None,
description: str | None = None,
help: str | None = None,
) -> None:
"""Construct an sub-command parsing option.
This behaves similarly to other Opt sub-classes but adds a
'handler' argument. The handler is a callable which is supplied
an subparsers object when invoked. The add_parser() method on
this subparsers object can be used to register parsers for
sub-commands.
"""
super().__init__(name, type=types.String(), dest=dest, help=help)
self.handler = handler
self.title = title
self.description = description
def _add_to_cli(
self, parser: '_CachedArgumentParser', group: 'OptGroup | None' = None
) -> None:
"""Add argparse sub-parsers and invoke the handler method."""
dest = self.dest
if group is not None:
dest = group.name + '_' + dest
subparsers = parser.add_subparsers(
dest=dest,
title=self.title or '',
description=self.description,
help=self.help,
)
# NOTE(jd) Set explicitly to True for Python 3
# See http://bugs.python.org/issue9253 for context
subparsers.required = True
if self.handler is not None:
self.handler(subparsers)
class _ConfigFileOpt(Opt):
"""The --config-file option.
This is an private option type which handles the special processing
required for --config-file options.
As each --config-file option is encountered on the command line, we
parse the file and store the parsed values in the _Namespace object.
This allows us to properly handle the precedence of --config-file
options over previous command line arguments, but not over subsequent
arguments.
.. versionadded:: 1.2
"""
class ConfigFileAction(argparse.Action):
"""An argparse action for --config-file.
As each --config-file option is encountered, this action adds the
value to the config_file attribute on the _Namespace object but also
parses the configuration file and stores the values found also in
the _Namespace object.
"""
def __call__(
self,
parser: argparse.ArgumentParser,
namespace: argparse.Namespace,
values: str | Sequence[Any] | None,
option_string: str | None = None,
) -> None:
"""Handle a --config-file command line argument.
:raises: ConfigFileParseError, ConfigFileValueError
"""
assert isinstance(values, str)
assert isinstance(namespace, _Namespace)
if getattr(namespace, self.dest, None) is None:
setattr(namespace, self.dest, [])
items = getattr(namespace, self.dest)
items.append(values)
ConfigParser._parse_file(values, namespace)
def __init__(self, name: str, **kwargs: Any) -> None:
super().__init__(name, cast(types.ConfigType, _identity), **kwargs)
def _get_argparse_kwargs(
self, group: 'OptGroup | None', **kwargs: Any
) -> dict[str, Any]:
"""Extends the base argparse keyword dict for the config file opt."""
kwargs = super()._get_argparse_kwargs(group)
kwargs['action'] = self.ConfigFileAction
return kwargs
class _ConfigDirOpt(Opt):
"""The --config-dir option.
This is an private option type which handles the special processing
required for --config-dir options.
As each --config-dir option is encountered on the command line, we
parse the files in that directory and store the parsed values in the
_Namespace object. This allows us to properly handle the precedence of
--config-dir options over previous command line arguments, but not
over subsequent arguments.
.. versionadded:: 1.2
"""
class ConfigDirAction(argparse.Action):
"""An argparse action for --config-dir.
As each --config-dir option is encountered, this action sets the
config_dir attribute on the _Namespace object but also parses the
configuration files and stores the values found also in the
_Namespace object.
"""
def __call__(
self,
parser: argparse.ArgumentParser,
namespace: argparse.Namespace,
values: str | Sequence[Any] | None,
option_string: str | None = None,
) -> None:
"""Handle a --config-dir command line argument.
:raises: ConfigFileParseError, ConfigFileValueError,
ConfigDirNotFoundError
"""
assert isinstance(values, str)
assert isinstance(namespace, _Namespace)
namespace._config_dirs.append(values)
setattr(namespace, self.dest, values)
values = os.path.expanduser(values)
if not os.path.exists(values):
raise ConfigDirNotFoundError(values)
config_dir_glob = os.path.join(values, '*.conf')
for config_file in sorted(glob.glob(config_dir_glob)):
ConfigParser._parse_file(config_file, namespace)
def __init__(self, name: str, **kwargs: Any) -> None:
super().__init__(name, type=types.List(), **kwargs)
def _get_argparse_kwargs(
self, group: 'OptGroup | None', **kwargs: Any
) -> dict[str, Any]:
"""Extends the base argparse keyword dict for the config dir option."""
kwargs = super()._get_argparse_kwargs(group)
kwargs['action'] = self.ConfigDirAction
return kwargs
class _OptInfoRequired(TypedDict):
"""Required fields for option info dicts stored in _opts."""
opt: Opt
cli: bool
class _OptInfo(_OptInfoRequired, total=False):
"""Full option info dict stored in _opts (opt and cli are required)."""
location: LocationInfo
override: Any
default: Any
class _OptGroupState(TypedDict):
"""Serialized form for an OptGroup."""
name: str
title: str
help: str | None
dynamic_group_owner: str
driver_option: str
opts: dict[str, _OptInfo]
class _OptGroupGeneratorData(TypedDict):
"""Data returned by OptGroup._get_generator_data()."""
help: str
dynamic_group_owner: str
driver_option: str
driver_opts: dict[str, list[Opt]]
class OptGroup:
"""Represents a group of opts.
CLI opts in the group are automatically prefixed with the group name.
Each group corresponds to a section in config files.
An OptGroup object has no public methods, but has a number of public string
properties:
.. py:attribute:: name
the name of the group
.. py:attribute:: title
the group title as displayed in --help
.. py:attribute:: help
the group description as displayed in --help
:param name: the group name
:param title: the group title for --help
:param help: the group description for --help
:param dynamic_group_owner: The name of the option that controls
repeated instances of this group.
:param driver_option: The name of the option within the group that
controls which driver will register options.
"""
def __init__(
self,
name: str,
title: str | None = None,
help: str | None = None,
dynamic_group_owner: str = '',
driver_option: str = '',
) -> None:
"""Constructs an OptGroup object."""
self.name = name
self.title = f"{name} options" if title is None else title
self.help = help
self.dynamic_group_owner = dynamic_group_owner
self.driver_option = driver_option
self._opts: dict[str, _OptInfo] = {} # keyed by opt dest
self._argparse_group: argparse._ArgumentGroup | None = None
self._driver_opts: dict[
str, list[Opt]
] = {} # populated by the config generator
def _save_driver_opts(self, opts: dict[str, list[Opt]]) -> None:
"""Save known driver opts.
:param opts: mapping between driver name and list of opts
"""
self._driver_opts.update(opts)
def _get_generator_data(self) -> _OptGroupGeneratorData:
"Return a dict with data for the sample generator."
return {
'help': self.help or '',
'dynamic_group_owner': self.dynamic_group_owner,
'driver_option': self.driver_option,
'driver_opts': self._driver_opts,
}
def _register_opt(self, opt: Opt, cli: bool = False) -> bool:
"""Add an opt to this group.
:param opt: an Opt object
:param cli: whether this is a CLI option
:returns: False if previously registered, True otherwise
:raises: DuplicateOptError if a naming conflict is detected
"""
if _is_opt_registered(self._opts, opt):
return False
self._opts[opt.dest] = {'opt': opt, 'cli': cli}
return True
def _unregister_opt(self, opt: Opt) -> None:
"""Remove an opt from this group.
:param opt: an Opt object
"""
if opt.dest in self._opts:
del self._opts[opt.dest]
def _get_argparse_group(
self, parser: '_CachedArgumentParser'
) -> argparse._ArgumentGroup:
if self._argparse_group is None:
"""Build an argparse._ArgumentGroup for this group."""
self._argparse_group = parser.add_argument_group(
self.title, self.help
)
return self._argparse_group
def _clear(self) -> None:
"""Clear this group's option parsing state."""
self._argparse_group = None
def __str__(self) -> str:
return self.name
class _DeprecatedOptInfo(TypedDict):
"""Info dict stored in _deprecated_opts, keyed by group then dest."""
opt: Opt
group: OptGroup | None
class _CliOptEntry(TypedDict):
"""Entry in the _cli_opts deque."""
opt: Opt
group: OptGroup | None
def _copy_opt_info(info: _OptInfo) -> _OptInfo:
copied: _OptInfo = {
'opt': info['opt'],
'cli': info['cli'],
}
if 'location' in info:
copied['location'] = info['location']
if 'override' in info:
copied['override'] = info['override']
if 'default' in info:
copied['default'] = info['default']
return copied
def _export_group(group: OptGroup) -> _OptGroupState:
if group._driver_opts:
raise ConfigOptsSerializationError(
'cannot serialize ConfigOpts state because group '
f'{group.name!r} contains driver options. Driver option metadata '
'is not part of the supported runtime configuration snapshot; '
'avoid passing ConfigOpts instances with driver option metadata '
'to spawn workers or rebuild that metadata in the child process.'
)
return {
'name': group.name,
'title': group.title,
'help': group.help,
'dynamic_group_owner': group.dynamic_group_owner,
'driver_option': group.driver_option,
'opts': {
opt_name: _copy_opt_info(info)
for opt_name, info in group._opts.items()
},
}
def _import_group(state: _OptGroupState) -> OptGroup:
group = OptGroup(
state['name'],
title=state['title'],
help=state['help'],
dynamic_group_owner=state['dynamic_group_owner'],
driver_option=state['driver_option'],
)
group._opts = state['opts']
return group
def _export_namespace(namespace: '_Namespace | None') -> dict[str, Any] | None:
if namespace is None:
return None
return {
key: value
for key, value in namespace.__dict__.items()
if key != '_conf'
}
def _import_namespace(
conf: 'ConfigOpts', state: Mapping[str, Any] | None
) -> '_Namespace | None':
if state is None:
return None
namespace = _Namespace(conf)
namespace.__dict__.update(state)
namespace._conf = conf
return namespace
class ParseError(iniparser.ParseError):
def __init__(
self, msg: str, lineno: int, line: str | None, filename: str
) -> None:
super().__init__(msg, lineno, line or '')
self.filename = filename
def __str__(self) -> str:
return f'at {self.filename}:{self.lineno}, {self.msg}: {self.line!r}'
class ConfigParser(iniparser.BaseParser):
"""Parses a single config file, populating 'sections' to look like::
{'DEFAULT': {'key': [value, ...], ...},
...}
Also populates self._normalized which looks the same but with normalized
section names.
"""
def __init__(self, filename: str, sections: dict[str, dict[str, Any]]):
super().__init__()
self.filename = filename
self.sections = sections
self._normalized: dict[str, dict[str, Any]] | None = None
self.section: str | None = None
def _add_normalized(self, normalized: dict[str, dict[str, Any]]) -> None:
self._normalized = normalized
def parse(self) -> None: # type: ignore[override]
with open(self.filename) as f:
super().parse(f.readlines())
def new_section(self, section: str) -> None:
self.sections.setdefault(section, {})
if self._normalized is not None:
self._normalized.setdefault(_normalize_group_name(section), {})
self.section = section
def assignment(self, key: str, value: list[str]) -> None:
if not self.section:
raise self.error_no_section()
joined = '\n'.join(value)
def append(sections: dict[str, dict[str, Any]], section: str) -> None:
sections[section].setdefault(key, [])
sections[section][key].append(joined)
append(self.sections, self.section)
if self._normalized is not None:
append(self._normalized, _normalize_group_name(self.section))
def parse_exc( # type: ignore[override]
self, msg: str, lineno: int, line: str | None = None
) -> ParseError:
return ParseError(msg, lineno, line, self.filename)
def error_no_section(self) -> ParseError:
return self.parse_exc(
'Section must be started before assignment', self.lineno
)
@classmethod
def _parse_file(cls, config_file: str, namespace: '_Namespace') -> None:
"""Parse a config file and store any values in the namespace.
:raises: ConfigFileParseError, ConfigFileValueError
"""
config_file = _fixpath(config_file)
sections: dict[str, dict[str, Any]] = {}
normalized: dict[str, dict[str, Any]] = {}
parser = cls(config_file, sections)
parser._add_normalized(normalized)
try:
parser.parse()
except iniparser.ParseError as pe:
raise ConfigFileParseError(config_file, str(pe))
except OSError as err:
if err.errno == errno.ENOENT:
namespace._file_not_found(config_file)
return
if err.errno == errno.EACCES:
namespace._file_permission_denied(config_file)
return
raise
namespace._add_parsed_config_file(config_file, sections, normalized)
namespace._parse_cli_opts_from_config_file(
config_file, sections, normalized
)
class _Namespace(argparse.Namespace):
"""An argparse namespace which also stores config file values.
As we parse command line arguments, the values get set as attributes
on a namespace object. However, we also want to parse config files as
they are specified on the command line and collect the values alongside
the option values parsed from the command line.
Note, we don't actually assign values from config files as attributes
on the namespace because config file options be registered after the
command line has been parsed, so we may not know how to properly parse
or convert a config file value at this point.
"""
_deprecated_opt_message = (
'Option "%(dep_option)s" from group '
'"%(dep_group)s" is deprecated. Use option '
'"%(option)s" from group "%(group)s".'
)
def __init__(self, conf: 'ConfigOpts') -> None:
self._conf = conf
self._parsed: list[dict[str, dict[str, Any]]] = []
self._normalized: list[dict[str, dict[str, Any]]] = []
self._emitted_deprecations: set[tuple[str | None, str]] = set()
self._files_not_found: list[str] = []
self._files_permission_denied: list[str] = []
self._config_dirs: list[str] = []
self._sections_to_file: dict[str, str] = {}
def _parse_cli_opts_from_config_file(
self,
config_file: str,
sections: dict[str, dict[str, Any]],
normalized: dict[str, dict[str, Any]],
) -> None:
"""Parse CLI options from a config file.
CLI options are special - we require they be registered before the
command line is parsed. This means that as we parse config files, we
can go ahead and apply the appropriate option-type specific conversion
to the values in config files for CLI options. We can't do this for
non-CLI options, because the schema describing those options may not be
registered until after the config files are parsed.
This method relies on that invariant in order to enforce proper
priority of option values - i.e. that the order in which an option
value is parsed, whether the value comes from the CLI or a config file,
determines which value specified for a given option wins.
The way we implement this ordering is that as we parse each config
file, we look for values in that config file for CLI options only. Any
values for CLI options found in the config file are treated like they
had appeared on the command line and set as attributes on the namespace
objects. Values in later config files or on the command line will
override values found in this file.
"""
namespace = _Namespace(self._conf)
namespace._add_parsed_config_file(config_file, sections, normalized)
for opt, group in self._conf._all_cli_opts():
group_name = group.name if group is not None else None
try:
value, loc = opt._get_from_namespace(namespace, group_name)
except KeyError:
continue
except ValueError as ve:
raise ConfigFileValueError(
f"Value for option {opt.name} is not valid: {str(ve)}"
)
if group_name is None:
dest = opt.dest
else:
dest = group_name + '_' + opt.dest
if opt.multi:
if getattr(self, dest, None) is None:
setattr(self, dest, [])
values = getattr(self, dest)
values.extend(value)
else:
setattr(self, dest, value)
def _add_parsed_config_file(
self,
filename: str,
sections: dict[str, dict[str, Any]],
normalized: dict[str, dict[str, Any]],
) -> None:
"""Add a parsed config file to the list of parsed files.
:param filename: the full name of the file that was parsed
:param sections: a mapping of section name to dicts of config values
:param normalized: sections mapping with section names normalized
:raises: ConfigFileValueError
"""
for s in sections:
self._sections_to_file[s] = filename
self._parsed.insert(0, sections)
self._normalized.insert(0, normalized)
def _file_not_found(self, config_file: str) -> None:
"""Record that we were unable to open a config file.
:param config_file: the path to the failed file
"""
self._files_not_found.append(config_file)
def _file_permission_denied(self, config_file: str) -> None:
"""Record that we have no permission to open a config file.
:param config_file: the path to the failed file
"""
self._files_permission_denied.append(config_file)
def _get_cli_value(
self, names: Sequence[tuple[str | None, str]], positional: bool = False
) -> Any:
"""Fetch a CLI option value.
Look up the value of a CLI option. The value itself may have come from
parsing the command line or parsing config files specified on the
command line. Type conversion have already been performed for CLI
options at this point.
:param names: a list of (section, name) tuples
:param positional: whether this is a positional option
"""
for group_name, name in names:
name = name if group_name is None else group_name + '_' + name
value = getattr(self, name, None)
if value is not None:
# argparse ignores default=None for nargs='*' and returns []
if positional and not value:
continue
return value
raise KeyError
def _get_file_value(
self,
names: Sequence[tuple[str | None, str]],
multi: bool = False,
normalized: bool = False,
current_name: tuple[str | None, str] | None = None,
) -> tuple[Any, 'LocationInfo | None']:
"""Fetch a config file value from the parsed files.
:param names: a list of (section, name) tuples
:param multi: a boolean indicating whether to return multiple values
:param normalized: whether to normalize group names to lowercase
:param current_name: current name in tuple being checked
"""
rvalue: list[str] = []
def normalize(name: str | None) -> str:
if name is None:
name = 'DEFAULT'
return _normalize_group_name(name) if normalized else name
names = [(normalize(section), name) for section, name in names]
loc = None
for sections in self._normalized if normalized else self._parsed:
for section, name in names:
if section not in sections:
continue
if name in sections[section]:
current_name = current_name or names[0]
self._check_deprecated(
(section, name), current_name, names[1:]
)
val = sections[section][name]
if loc is None:
loc = LocationInfo(
Locations.user,
self._sections_to_file.get(section, ''),
)
if multi:
rvalue = val + rvalue
else:
return (val, loc)
if multi and rvalue != []:
return (rvalue, loc)
raise KeyError
def _check_deprecated(
self,
name: tuple[str | None, str],
current: tuple[str | None, str],
deprecated: Sequence[tuple[str | None, str]],
) -> None:
"""Check for usage of deprecated names.
:param name: A tuple of the form (group, name) representing the group
and name where an opt value was found.
:param current: A tuple of the form (group, name) representing the
current name for an option.
:param deprecated: A list of tuples with the same format as the name
param which represent any deprecated names for an option.
If the name param matches any entries in this list a
deprecation warning will be logged.
"""
if name in deprecated and name not in self._emitted_deprecations:
self._emitted_deprecations.add(name)
current = (current[0] or 'DEFAULT', current[1])
format_dict = {
'dep_option': name[1],
'dep_group': name[0],
'option': current[1],
'group': current[0],
}
_report_deprecation(self._deprecated_opt_message, format_dict)
def _get_value(
self,
names: Sequence[tuple[str | None, str]],
multi: bool = False,
positional: bool = False,
current_name: tuple[str | None, str] | None = None,
normalized: bool = True,
) -> tuple[Any, 'LocationInfo | None']:
"""Fetch a value from config files.
Multiple names for a given configuration option may be supplied so
that we can transparently handle files containing deprecated option
names or groups.
:param names: a list of (section, name) tuples
:param positional: whether this is a positional option
:param multi: a boolean indicating whether to return multiple values
:param normalized: whether to normalize group names to lowercase
"""
# NOTE(dhellmann): We don't have a way to track which options
# that are registered as command line values show up on the
# command line or in the configuration files. So we look up
# the value in the file first to get the location, and then
# try looking it up as a CLI value in case it was set there.
# Set a default location indicating that the value came from
# the command line. This will be overridden if we find a value
# in a file.
loc: LocationInfo | None = LocationInfo(Locations.command_line, '')
try:
file_names: list[tuple[str | None, str]] = [
(g if g is not None else 'DEFAULT', n) for g, n in names
]
values, loc = self._get_file_value(
file_names,
multi=multi,
normalized=normalized,
current_name=current_name,
)
except KeyError:
# If we receive a KeyError when looking for the CLI, just
# go ahead and throw it because we know we don't have a
# value.
raise_later = True
else:
raise_later = False
# Now try the CLI
try:
value = self._get_cli_value(names, positional)
return (value, loc)
except KeyError:
if raise_later:
# Re-raise to indicate that we haven't found the value
# anywhere.
raise
# Return the value we found in the file.
return (values if multi else values[-1], loc)
def _sections(self) -> Iterator[str]:
for sections in self._parsed:
yield from sections
class _CachedArgEntry(TypedDict):
"""One argument entry cached by _CachedArgumentParser."""
args: tuple[str, ...]
kwargs: dict[str, Any]
class _CachedArgumentParser(argparse.ArgumentParser):
"""class for caching/collecting command line arguments.
It also sorts the arguments before initializing the ArgumentParser.
We need to do this since ArgumentParser by default does not sort
the argument options and the only way to influence the order of
arguments in '--help' is to ensure they are added in the sorted
order.
"""
def __init__(
self, prog: str | None = None, usage: str | None = None, **kwargs: Any
) -> None:
super().__init__(prog, usage, **kwargs)
self._args_cache: dict[
argparse._ActionsContainer, list[_CachedArgEntry]
] = {}
def add_parser_argument(
self, container: argparse._ActionsContainer, *args: Any, **kwargs: Any
) -> None:
values: list[_CachedArgEntry] = []
if container in self._args_cache:
values = self._args_cache[container]
values.append({'args': args, 'kwargs': kwargs})
self._args_cache[container] = values
def initialize_parser_arguments(self) -> None:
# NOTE(mfedosin): The code below looks a little bit weird, but
# it's done because we need to sort only optional opts and do
# not touch positional. For the reason optional opts go first in
# the values we only need to find an index of the first positional
# option and then sort the values slice.
for container, values in self._args_cache.items():
index = 0
has_positional = False
for index, argument in enumerate(values):
if not argument['args'][0].startswith('-'):
has_positional = True
break
size = index if has_positional else len(values)
values[:size] = sorted(values[:size], key=lambda x: x['args'])
for argument in values:
try:
container.add_argument(
*argument['args'], **argument['kwargs']
)
except argparse.ArgumentError:
options = ','.join(argument['args'])
raise DuplicateOptError(options)
self._args_cache = {}
def parse_args( # type: ignore[override]
self,
args: Sequence[str] | None = None,
namespace: argparse.Namespace | None = None,
) -> argparse.Namespace:
self.initialize_parser_arguments()
return super().parse_args(args, namespace)
def print_help(self, file: Any = None) -> None:
self.initialize_parser_arguments()
super().print_help(file)
def print_usage(self, file: Any = None) -> None:
self.initialize_parser_arguments()
super().print_usage(file)
# Type alias for hooks passed to register_mutate_hook / mutate_config_files.
# The second argument is the dict of changed (group, optname) -> (old, new).
_MutationHook = Callable[
['ConfigOpts', dict[tuple[str | None, str], tuple[Any, Any]]], None
]
class ConfigOpts(Mapping[str, Any]):
"""Config options which may be set on the command line or in config files.
ConfigOpts is a configuration option manager with APIs for registering
option schemas, grouping options, parsing option values and retrieving
the values of options.
It has built-in support for :oslo.config:option:`config_file` and
:oslo.config:option:`config_dir` options.
.. versionchanged:: 9.5.0
Added shell-completion option for generate a shell completion script.
"""
disallow_names = (
'project',
'prog',
'version',
'usage',
'default_config_files',
'default_config_dirs',
)
supported_shell_completion = ['bash', 'zsh']
# NOTE(dhellmann): This instance is reused by list_opts().
_config_source_opt = ListOpt(
'config_source',
metavar='SOURCE',
default=[],
help=(
'Lists configuration groups that provide more '
'details for accessing configuration settings '
'from locations other than local files.'
),
)
# Add option for generate a shell completion script
_shell_completion_opt = StrOpt(
'shell_completion',
choices=supported_shell_completion,
help='Display a shell completion script',
)
_serialized_setup_attrs = (
'project',
'prog',
'version',
'usage',
'default_config_files',
'default_config_dirs',
)
def __init__(self) -> None:
"""Construct a ConfigOpts object."""
self._opts: dict[str, _OptInfo] = {} # keyed by opt dest
self._groups: dict[str, OptGroup] = {}
self._deprecated_opts: dict[str, dict[str, _DeprecatedOptInfo]] = {}
self._args: list[str] | None = None
self._oparser: _CachedArgumentParser | None = None
self._namespace: _Namespace | None = None
self._mutable_ns: _Namespace | None = None
self._mutate_hooks: set[_MutationHook] = set()
self.__cache: dict[tuple[str | None, str], Any] = {}
self.__drivers_cache: dict[
tuple[str | None, str], tuple[Any, LocationInfo | None]
] = {}
self._config_opts: list[Opt] = []
self._cli_opts: collections.deque[_CliOptEntry] = collections.deque()
self._validate_default_values: bool = False
self._sources: list[sources.ConfigurationSource] = []
self._ext_mgr: Any = None
# Though the env_driver is a Source, we load it by default.
self._use_env: bool = True
self._env_driver = _environment.EnvironmentConfigurationSource()
self.register_opt(self._config_source_opt)
self.register_cli_opt(self._shell_completion_opt)
def _export_deprecated_opts(
self,
) -> dict[str, dict[str, dict[str, Any]]]:
"""Return a serializable copy of ``_deprecated_opts``.
The live mapping stores raw :class:`OptGroup` references, which may
hold process-local argparse objects after CLI parsing. Replace those
references with the group name so the snapshot remains picklable; the
name is re-resolved to the live group on import.
"""
exported: dict[str, dict[str, dict[str, Any]]] = {}
for group_name, entries in self._deprecated_opts.items():
exported[group_name] = {
dest: {
'opt': info['opt'],
'group_name': (
info['group'].name
if info['group'] is not None
else None
),
}
for dest, info in entries.items()
}
return exported
def _import_deprecated_opts(
self,
state: Mapping[str, Mapping[str, Mapping[str, Any]]],
) -> dict[str, dict[str, _DeprecatedOptInfo]]:
"""Rebuild ``_deprecated_opts`` from an exported snapshot.
``OptGroup`` references are re-resolved against the groups restored by
:meth:`__setstate__`. A valid snapshot produced by ``export_state``
always includes every group a deprecated entry references, because
``register_opt`` creates the group before tracking it and
``export_state`` serializes every group. A referenced group that is
absent from the restored ``_groups`` therefore indicates a corrupt or
hand-built state, which is rejected rather than silently repaired.
"""
imported: dict[str, dict[str, _DeprecatedOptInfo]] = {}
for group_name, entries in state.items():
imported_entries: dict[str, _DeprecatedOptInfo] = {}
for dest, info in entries.items():
ref_group_name: str | None = info['group_name']
if ref_group_name is None:
ref_group: OptGroup | None = None
else:
ref_group = self._groups.get(ref_group_name)
if ref_group is None:
raise ConfigOptsSerializationError(
'cannot import ConfigOpts state because the '
f'deprecated option {dest!r} references group '
f'{ref_group_name!r}, which is not present in '
'the serialized groups. The state is invalid.'
)
imported_entries[dest] = {
'opt': info['opt'],
'group': ref_group,
}
imported[group_name] = imported_entries
return imported
def export_state(self) -> dict[str, Any]:
"""Return a serializable snapshot of this configuration state.
The snapshot preserves registered opts and groups, parsed CLI and
config-file values, defaults, overrides, and setup metadata. It
intentionally excludes process-local parser objects, caches, mutation
hooks, extension managers, and environment drivers.
Alternative configuration source objects are not serialized because
they may hold process-local resources. If any are loaded, exporting
fails instead of silently dropping meaningful configuration state.
"""
if self._sources:
raise ConfigOptsSerializationError(
'cannot serialize ConfigOpts state because it contains loaded '
'configuration sources. Source objects may hold process-local '
'or non-picklable state; avoid passing this ConfigOpts '
'instance to spawn workers or use serializable configuration '
'inputs before spawning.'
)
state: dict[str, Any] = {
'version': _CONFIG_OPTS_STATE_VERSION,
'opts': {
opt_name: _copy_opt_info(info)
for opt_name, info in self._opts.items()
},
'groups': {
group_name: _export_group(group)
for group_name, group in self._groups.items()
},
'deprecated_opts': self._export_deprecated_opts(),
'args': list(self._args) if self._args is not None else None,
'namespace': _export_namespace(self._namespace),
'mutable_ns': _export_namespace(self._mutable_ns),
'config_opts': list(self._config_opts),
'cli_opts': [
(
item['opt'],
item['group'].name if item['group'] is not None else None,
)
for item in self._cli_opts
],
'validate_default_values': self._validate_default_values,
'use_env': self._use_env,
'setup_attrs': {
name: getattr(self, name)
for name in self._serialized_setup_attrs
if hasattr(self, name)
},
}
self._assert_serializable(state)
return state
@classmethod
def import_state(cls, state: Mapping[str, Any]) -> 'ConfigOpts':
"""Create a ConfigOpts instance from an exported state snapshot."""
conf = cls()
conf.__setstate__(state)
return conf
@staticmethod
def _assert_serializable(state: Mapping[str, Any]) -> None:
try:
pickle.dumps(state)
except Exception as exc:
raise ConfigOptsSerializationError(
'cannot serialize ConfigOpts state because it contains a '
'non-picklable option, option type, or source-related value. '
'Avoid passing such state to spawn workers or use '
f'serializable option types. Original error: {exc}'
) from exc
def __getstate__(self) -> dict[str, Any]:
return self.export_state()
def __setstate__(self, state: Mapping[str, Any]) -> None:
if state.get('version') != _CONFIG_OPTS_STATE_VERSION:
raise ConfigOptsSerializationError(
'unsupported ConfigOpts serialized state version '
f'{state.get("version")!r}'
)
self._opts = state['opts']
self._groups = {
group_name: _import_group(group_state)
for group_name, group_state in state['groups'].items()
}
self._deprecated_opts = self._import_deprecated_opts(
state['deprecated_opts']
)
self._args = state['args']
self._oparser = None
self._namespace = _import_namespace(self, state['namespace'])
self._mutable_ns = _import_namespace(self, state['mutable_ns'])
self._mutate_hooks = set()
self.__cache = {}
self.__drivers_cache = {}
self._config_opts = state['config_opts']
self._cli_opts = collections.deque(
{
'opt': opt,
'group': self._groups[group_name]
if group_name is not None
else None,
}
for opt, group_name in state['cli_opts']
)
self._validate_default_values = state['validate_default_values']
self._sources = []
self._ext_mgr = None
self._use_env = state['use_env']
self._env_driver = _environment.EnvironmentConfigurationSource()
for name, value in state['setup_attrs'].items():
setattr(self, name, value)
def __reduce__(self) -> tuple[Any, tuple[dict[str, Any]]]:
if self is CONF:
return (_import_global_config_opts_state, (self.export_state(),))
return (_import_config_opts_state, (self.export_state(),))
def _pre_setup(
self,
project: str | None,
prog: str | None,
version: str | None,
usage: str | None,
description: str | None,
epilog: str | None,
default_config_files: list[str] | None,
default_config_dirs: list[str] | None,
) -> tuple[str, list[str], list[str]]:
"""Initialize a ConfigCliParser object for option parsing."""
if prog is None:
prog = os.path.basename(sys.argv[0])
if prog.endswith(".py"):
prog = prog[:-3]
if default_config_files is None:
default_config_files = find_config_files(project, prog)
if default_config_dirs is None:
default_config_dirs = find_config_dirs(project, prog)
self._oparser = _CachedArgumentParser(
prog=prog, usage=usage, description=description, epilog=epilog
)
if version is not None:
self._oparser.add_parser_argument(
self._oparser, '--version', action='version', version=version
)
return prog, default_config_files, default_config_dirs
@staticmethod
def _make_config_options(
default_config_files: list[str], default_config_dirs: list[str]
) -> list[Opt]:
return [
_ConfigFileOpt(
'config-file',
default=default_config_files,
metavar='PATH',
help=(
'Path to a config file to use. Multiple '
'config files can be specified, with values '
'in later files taking precedence. Defaults '
'to %(default)s. This option must be set '
'from the command-line.'
),
),
_ConfigDirOpt(
'config-dir',
metavar='DIR',
default=default_config_dirs,
help='Path to a config directory to pull `*.conf` '
'files from. This file set is sorted, so as to '
'provide a predictable parse order if '
'individual options are over-ridden. The set '
'is parsed after the file(s) specified via '
'previous --config-file, arguments hence '
'over-ridden options in the directory take '
'precedence. This option must be set from '
'the command-line.',
),
]
@classmethod
def _list_options_for_discovery(
cls, default_config_files: list[str], default_config_dirs: list[str]
) -> list[Opt]:
"Return options to be used by list_opts() for the sample generator."
options = cls._make_config_options(
default_config_files, default_config_dirs
)
options.append(cls._config_source_opt)
return options
def _setup(
self,
project: str | None,
prog: str,
version: str | None,
usage: str | None,
default_config_files: list[str],
default_config_dirs: list[str],
use_env: bool,
) -> None:
"""Initialize a ConfigOpts object for option parsing."""
self._config_opts = self._make_config_options(
default_config_files, default_config_dirs
)
self.register_cli_opts(self._config_opts)
self.project = project
self.prog = prog
self.version = version
self.usage = usage
self.default_config_files = default_config_files
self.default_config_dirs = default_config_dirs
self._use_env = use_env
def __clear_cache(f: Any) -> Any:
@functools.wraps(f)
def __inner(self: Any, *args: Any, **kwargs: Any) -> Any:
if kwargs.pop('clear_cache', True):
result = f(self, *args, **kwargs)
self.__cache.clear()
return result
else:
return f(self, *args, **kwargs)
return __inner
def __clear_drivers_cache(f: Any) -> Any:
@functools.wraps(f)
def __inner(self: Any, *args: Any, **kwargs: Any) -> Any:
if kwargs.pop('clear_drivers_cache', True):
result = f(self, *args, **kwargs)
self.__drivers_cache.clear()
return result
else:
return f(self, *args, **kwargs)
return __inner
def __call__(
self,
args: Sequence[str] | None = None,
project: str | None = None,
prog: str | None = None,
version: str | None = None,
usage: str | None = None,
default_config_files: list[str] | None = None,
default_config_dirs: list[str] | None = None,
validate_default_values: bool = False,
description: str | None = None,
epilog: str | None = None,
use_env: bool = True,
) -> None:
"""Parse command line arguments and config files.
Calling a ConfigOpts object causes the supplied command line arguments
and config files to be parsed, causing opt values to be made available
as attributes of the object.
The object may be called multiple times, each time causing the previous
set of values to be overwritten.
Automatically registers the --config-file option with either a supplied
list of default config files, or a list from find_config_files().
If the --config-dir option is set, any *.conf files from this
directory are pulled in, after all the file(s) specified by the
--config-file option.
:param args: command line arguments (defaults to sys.argv[1:])
:param project: the toplevel project name, used to locate config files
:param prog: the name of the program (defaults to sys.argv[0]
basename, without extension .py)
:param version: the program version (for --version)
:param usage: a usage string (%prog will be expanded)
:param description: A description of what the program does
:param epilog: Text following the argument descriptions
:param default_config_files: config files to use by default
:param default_config_dirs: config dirs to use by default
:param validate_default_values: whether to validate the default values
:param use_env: If True (the default) look in the environment as one
source of option values.
:raises: SystemExit, ConfigFilesNotFoundError, ConfigFileParseError,
ConfigFilesPermissionDeniedError,
RequiredOptError, DuplicateOptError
.. versionchanged:: 9.5.0
Added shell-completion option for generate a shell completion script.
"""
self.clear()
self._validate_default_values = validate_default_values
prog, default_config_files, default_config_dirs = self._pre_setup(
project,
prog,
version,
usage,
description,
epilog,
default_config_files,
default_config_dirs,
)
self._setup(
project,
prog,
version,
usage,
default_config_files,
default_config_dirs,
use_env,
)
# This is necessary to analyse first args now,
# because if there are subcommands,
# these are mandatory even if you only want to use
# the --shell_completion option
argv = args if args is not None else sys.argv[1:]
if (
len(argv) > 1
and argv[0] == '--shell_completion'
and argv[1] in self.supported_shell_completion
):
shell = argv[1]
self._print_shell_completion(shell)
sys.exit(0)
self._namespace = self._parse_cli_opts(argv)
if self._namespace._files_not_found:
raise ConfigFilesNotFoundError(self._namespace._files_not_found)
if self._namespace._files_permission_denied:
raise ConfigFilesPermissionDeniedError(
self._namespace._files_permission_denied
)
self._load_alternative_sources()
self._check_required_opts()
def _print_shell_completion(self, shell: str) -> None:
"""Print shell completion Script
:param shell: name of shell to generate script, actually bash or zsh
"""
maps: dict[str, Any] = {}
descr: dict[str, Any] = {}
opts: dict[str, Any] = {}
opts_sub: dict[str, Any] = {}
args: dict[str, Any] = {}
multi: list[str] = []
template = os.path.join(
os.path.dirname(os.path.abspath(__file__)),
"templates",
f"{shell}-completion.template",
)
for opt, group in self._all_cli_opts():
if isinstance(opt, SubCommandOpt):
# If a subcommand, call _add_to_cli, for getting the subparser
assert self._oparser is not None
opt._add_to_cli(self._oparser, group)
else:
name = (
f"{group}_{opt.name}"
if not (group is None and group != '')
else f"{opt.name}"
)
if opt.multi:
multi.append(name)
opts.setdefault(name, [])
opts[name] += [f"--{name}"]
descr[name] = opt.help
maps[f"--{name}"] = name
if opt.short:
opts[name] += [f"-{opt.short}"]
maps[f"-{opt.short}"] = name
if hasattr(opt.type, 'choices') and opt.type.choices:
args[name] = ' '.join(opt.type.choices.keys())
else:
args[name] = ' '
assert self._oparser is not None
for op in self._oparser._actions:
# Analyze parser for find subcommanf options and help option
if isinstance(op, argparse._SubParsersAction):
for k, v in op._name_parser_map.items():
descr[k] = v.description if v.description else ''
opts_sub.setdefault(k, {})
for opt in v._actions:
op_str = opt.option_strings
descr[f"{k}_{opt.dest}"] = opt.help
opts_sub[k][opt.dest] = op_str
for op in op_str:
maps[op] = opt.dest
elif isinstance(op, argparse._HelpAction):
opts.setdefault(op.dest, [])
opts[op.dest] += [f"--{op.dest}", '-h']
descr[op.dest] = op.help
if shell == 'bash':
output = self._generate_bash_completion(
template,
maps=maps,
opts=opts,
descr=descr,
opts_sub=opts_sub,
multi=multi,
args=args,
)
elif shell == 'zsh':
output = self._generate_zsh_completion(
template,
maps=maps,
opts=opts,
descr=descr,
opts_sub=opts_sub,
multi=multi,
args=args,
)
print(output)
def _generate_bash_completion(
self,
template: str,
maps: dict[str, Any] | None = None,
opts: dict[str, Any] | None = None,
descr: dict[str, Any] | None = None,
opts_sub: dict[str, Any] | None = None,
multi: list[str] | None = None,
args: dict[str, Any] | None = None,
) -> str:
"""Generate a bash completaion script
:param template: tamplate for generate script
:param maps: a dict mapping short and long option name with destination
variable
:param opts: a dict of option (destination is key, short and long name
is in a list in value)
:param descr: dict of help message for option
:param opts_sub: dict of subcommand
:param multi: list of MultiOPt
:param args: dict of options with arguments
"""
if maps is None:
maps = {}
if opts is None:
opts = {}
if descr is None:
descr = {}
if opts_sub is None:
opts_sub = {}
if multi is None:
multi = []
if args is None:
args = {}
b_opts_sub = ''
b_opts = ' '.join([f"[{k}]='{' '.join(v)}'" for k, v in opts.items()])
b_args = ' '.join([f"[{k}]='{v}'" for k, v in args.items()])
for k, v in opts_sub.items():
b_opts += f" [{k}]='{k}'"
sub = '|'.join(
[
f"{ik}=\"{' '.join(iv)}\""
for ik, iv in v.items()
if len(iv) > 0
]
)
b_opts_sub += f"[{k}]='{sub}' "
b_map = ' '.join([f"[{k}]={v}" for k, v in maps.items()])
b_multi = ' '.join([f"[{k}]=true" for k in multi])
with open(template) as input:
output = input.read().format(
scriptname=self.prog,
opts=b_opts,
opts_sub=b_opts_sub,
args=b_args,
multi=b_multi,
map=b_map,
)
return output
def _generate_zsh_completion(
self,
template: str,
maps: dict[str, Any] | None = None,
opts: dict[str, Any] | None = None,
descr: dict[str, Any] | None = None,
opts_sub: dict[str, Any] | None = None,
multi: list[str] | None = None,
args: dict[str, Any] | None = None,
) -> str:
"""Generate a zsh completaion script
:param template: tamplate for generate script
:param maps: a dict mapping short and long option name with destination
variable
:param opts: a dict of option (destination is key, short and long name
is in a list in value)
:param descr: dict of help message for option
:param opts_sub: dict of subcommand
:param multi: list of MultiOPt
:param args: dict of options with arguments
"""
if maps is None:
maps = {}
if opts is None:
opts = {}
if descr is None:
descr = {}
if opts_sub is None:
opts_sub = {}
if multi is None:
multi = []
if args is None:
args = {}
p = self.prog
t = ' '
z_opts = ''
for k, v in opts.items():
repeat = '*' if k in multi else f"({' '.join(v)})"
o = f"{{{','.join(v)}}}" if len(v) > 1 else v[0]
d = descr[k]
c = f":choice:({args[k]})" if k in args else ''
z_opts += f"{t * 2}'{repeat}'{o}'[{d}]{c}' \\\n"
if opts_sub:
z_opts += f"{t * 2}'*::{p} command:_{p}_commands'\n"
c_list = ''
c_opts = ''
for k, v in opts_sub.items():
desc = descr[k] if descr[k] else ''
c_list += f"{t * 2}'{k}:{desc}'\n"
c_opts += f"{t * 3}{k})\n"
c_opts += f"{t * 4}_arguments -s \\\n"
for ik, iv in v.items():
if len(iv) > 1:
c_opts += (
f"{t * 4}'({' '.join(iv)})'{{{','.join(iv)}}}"
)
elif len(iv) == 1:
c_opts += f"{t * 4}{iv[0]}"
desc = descr[k + '_' + ik] if descr[k + '_' + ik] else ''
c_opts += f"'[{desc}]' \\\n"
c_opts += f"\n{t * 4};;\n"
with open(template) as input:
output = input.read().format(
scriptname=p,
opts=z_opts,
commands_list=c_list,
commands_opts=c_opts,
)
return output
def _load_alternative_sources(self) -> None:
# Look for other sources of option data.
for source_group_name in self.config_source:
source = self._open_source_from_opt_group(source_group_name)
if source is not None:
self._sources.append(source)
def _open_source_from_opt_group(self, group_name: str) -> Any:
if not self._ext_mgr:
self._ext_mgr = stevedore.ExtensionManager(
"oslo.config.driver", invoke_on_load=True
)
self.register_opt(
StrOpt(
'driver',
choices=self._ext_mgr.names(),
help=_SOURCE_DRIVER_OPTION_HELP,
),
group=group_name,
)
try:
driver_name = self[group_name].driver
except ConfigFileValueError as err:
LOG.error(
"could not load configuration from %r. %s", group_name, err.msg
)
return None
if driver_name is None:
LOG.error(
"could not load configuration from %r, no 'driver' is set.",
group_name,
)
return None
LOG.info(
'loading configuration from %r using %r', group_name, driver_name
)
driver = self._ext_mgr[driver_name].obj
try:
return driver.open_source_from_opt_group(self, group_name)
except Exception as err:
LOG.error(
"could not load configuration from %r using %s driver: %s",
group_name,
driver_name,
err,
)
return None
def __getattr__(self, name: str) -> Any:
"""Look up an option value and perform string substitution.
:param name: the opt name (or 'dest', more precisely)
:returns: the option value (after string substitution) or a GroupAttr
:raises: ValueError or NoSuchOptError
"""
try:
return self._get(name)
except ValueError:
raise
except Exception:
raise NoSuchOptError(name)
def __getitem__(self, key: str) -> Any:
"""Look up an option value and perform string substitution."""
return self.__getattr__(key)
def __contains__(self, key: object) -> bool:
"""Return True if key is the name of a registered opt or group."""
return key in self._opts or key in self._groups
def __iter__(self) -> Iterator[str]:
"""Iterate over all registered opt and group names."""
yield from itertools.chain(
list(self._opts.keys()), list(self._groups.keys())
)
def __len__(self) -> int:
"""Return the number of options and option groups."""
return len(self._opts) + len(self._groups)
def reset(self) -> None:
"""Clear the object state and unset overrides and defaults."""
self._unset_defaults_and_overrides()
self.clear()
@__clear_cache
def clear(self) -> None:
"""Reset the state of the object to before options were registered.
This method removes all registered options and discards the data
from the command line and configuration files.
Any subparsers added using the add_cli_subparsers() will also be
removed as a side-effect of this method.
"""
self._args = None
self._oparser = None
self._namespace = None
self._mutable_ns = None
# Keep _mutate_hooks
self._validate_default_values = False
self.unregister_opts(self._config_opts)
for group in self._groups.values():
group._clear()
def _add_cli_opt(self, opt: Opt, group: OptGroup | None) -> None:
if {'opt': opt, 'group': group} in self._cli_opts:
return
if opt.positional:
self._cli_opts.append({'opt': opt, 'group': group})
else:
self._cli_opts.appendleft({'opt': opt, 'group': group})
def _track_deprecated_opts(
self, opt: Opt, group: OptGroup | None = None
) -> None:
if hasattr(opt, 'deprecated_opts'):
for dep_opt in opt.deprecated_opts:
dep_group = dep_opt.group or 'DEFAULT'
dep_dest = (dep_opt.name or opt.dest).replace('-', '_')
if dep_group not in self._deprecated_opts:
self._deprecated_opts[dep_group] = {
dep_dest: {'opt': opt, 'group': group}
}
else:
self._deprecated_opts[dep_group][dep_dest] = {
'opt': opt,
'group': group,
}
@__clear_cache
def register_opt(
self, opt: Opt, group: str | OptGroup | None = None, cli: bool = False
) -> bool:
"""Register an option schema.
Registering an option schema makes any option value which is previously
or subsequently parsed from the command line or config files available
as an attribute of this object.
:param opt: an instance of an Opt sub-class
:param group: an optional OptGroup object or group name
:param cli: whether this is a CLI option
:return: False if the opt was already registered, True otherwise
:raises: DuplicateOptError
"""
if group is not None:
group = self._get_group(group, autocreate=True)
if cli:
self._add_cli_opt(opt, group)
self._track_deprecated_opts(opt, group=group)
return group._register_opt(opt, cli)
# NOTE(gcb) We can't use some names which are same with attributes of
# Opts in default group. They includes project, prog, version, usage,
# default_config_files and default_config_dirs.
if group is None:
if opt.name in self.disallow_names:
raise ValueError(
f'Name {opt.name} was reserved for oslo.config.'
)
if cli:
self._add_cli_opt(opt, None)
if _is_opt_registered(self._opts, opt):
return False
self._opts[opt.dest] = {'opt': opt, 'cli': cli}
self._track_deprecated_opts(opt)
return True
@__clear_cache
def register_opts(
self, opts: list[Opt], group: str | OptGroup | None = None
) -> None:
"""Register multiple option schemas at once."""
for opt in opts:
self.register_opt(opt, group, clear_cache=False)
@__clear_cache
def register_cli_opt(
self, opt: Opt, group: str | OptGroup | None = None
) -> bool:
"""Register a CLI option schema.
CLI option schemas must be registered before the command line and
config files are parsed. This is to ensure that all CLI options are
shown in --help and option validation works as expected.
:param opt: an instance of an Opt sub-class
:param group: an optional OptGroup object or group name
:return: False if the opt was already registered, True otherwise
:raises: DuplicateOptError, ArgsAlreadyParsedError
"""
if self._args is not None:
raise ArgsAlreadyParsedError("cannot register CLI option")
return cast(
bool, self.register_opt(opt, group, cli=True, clear_cache=False)
)
@__clear_cache
def register_cli_opts(
self, opts: list[Opt], group: str | OptGroup | None = None
) -> None:
"""Register multiple CLI option schemas at once."""
for opt in opts:
self.register_cli_opt(opt, group, clear_cache=False)
def register_group(self, group: OptGroup) -> None:
"""Register an option group.
An option group must be registered before options can be registered
with the group.
:param group: an OptGroup object
"""
if group.name in self._groups:
return
self._groups[group.name] = copy.copy(group)
@__clear_cache
def unregister_opt(
self, opt: Opt, group: str | OptGroup | None = None
) -> None:
"""Unregister an option.
:param opt: an Opt object
:param group: an optional OptGroup object or group name
:raises: ArgsAlreadyParsedError, NoSuchGroupError
"""
if self._args is not None:
raise ArgsAlreadyParsedError("reset before unregistering options")
remitem = None
for item in self._cli_opts:
if item['opt'].dest == opt.dest and (
group is None
or (
item['group'] is not None
and self._get_group(group).name == item['group'].name
)
):
remitem = item
break
if remitem is not None:
self._cli_opts.remove(remitem)
if group is not None:
self._get_group(group)._unregister_opt(opt)
elif opt.dest in self._opts:
del self._opts[opt.dest]
@__clear_cache
def unregister_opts(
self, opts: list[Opt], group: str | OptGroup | None = None
) -> None:
"""Unregister multiple CLI option schemas at once."""
for opt in opts:
self.unregister_opt(opt, group, clear_cache=False)
def import_opt(
self, name: str, module_str: str, group: str | OptGroup | None = None
) -> None:
"""Import an option definition from a module.
Import a module and check that a given option is registered.
This is intended for use with global configuration objects
like cfg.CONF where modules commonly register options with
CONF at module load time. If one module requires an option
defined by another module it can use this method to explicitly
declare the dependency.
:param name: the name/dest of the opt
:param module_str: the name of a module to import
:param group: an option OptGroup object or group name
:raises: NoSuchOptError, NoSuchGroupError
"""
__import__(module_str)
self._get_opt_info(name, group)
def import_group(self, group: str | OptGroup, module_str: str) -> None:
"""Import an option group from a module.
Import a module and check that a given option group is registered.
This is intended for use with global configuration objects
like cfg.CONF where modules commonly register options with
CONF at module load time. If one module requires an option group
defined by another module it can use this method to explicitly
declare the dependency.
:param group: an option OptGroup object or group name
:param module_str: the name of a module to import
:raises: ImportError, NoSuchGroupError
"""
__import__(module_str)
self._get_group(group)
@__clear_cache
def set_override(
self, name: str, override: Any, group: str | OptGroup | None = None
) -> None:
"""Override an opt value.
Override the command line, config file and default values of a
given option.
:param name: the name/dest of the opt
:param override: the override value
:param group: an option OptGroup object or group name
:raises: NoSuchOptError, NoSuchGroupError
"""
opt_info = self._get_opt_info(name, group)
opt_info['override'] = self._get_enforced_type_value(
opt_info['opt'], override
)
opt_info['location'] = LocationInfo(
Locations.set_override,
_get_caller_detail(3), # this function has a decorator to skip
)
@__clear_cache
def set_default(
self, name: str, default: Any, group: str | OptGroup | None = None
) -> None:
"""Override an opt's default value.
Override the default value of given option. A command line or
config file value will still take precedence over this default.
:param name: the name/dest of the opt
:param default: the default value
:param group: an option OptGroup object or group name
:raises: NoSuchOptError, NoSuchGroupError
"""
opt_info = self._get_opt_info(name, group)
opt_info['default'] = self._get_enforced_type_value(
opt_info['opt'], default
)
opt_info['location'] = LocationInfo(
Locations.set_default,
_get_caller_detail(3), # this function has a decorator to skip
)
def _get_enforced_type_value(self, opt: Opt, value: Any) -> Any:
if value is None:
return None
return self._convert_value(value, opt)
@__clear_cache
def clear_override(
self, name: str, group: str | OptGroup | None = None
) -> None:
"""Clear an override an opt value.
Clear a previously set override of the command line, config file
and default values of a given option.
:param name: the name/dest of the opt
:param group: an option OptGroup object or group name
:raises: NoSuchOptError, NoSuchGroupError
"""
opt_info = self._get_opt_info(name, group)
opt_info.pop('override', None)
@__clear_cache
def clear_default(
self, name: str, group: str | OptGroup | None = None
) -> None:
"""Clear an override an opt's default value.
Clear a previously set override of the default value of given option.
:param name: the name/dest of the opt
:param group: an option OptGroup object or group name
:raises: NoSuchOptError, NoSuchGroupError
"""
opt_info = self._get_opt_info(name, group)
opt_info.pop('default', None)
def _all_opt_infos(
self,
) -> Iterator[tuple[_OptInfo, OptGroup | None]]:
"""A generator function for iteration opt infos."""
for info in list(self._opts.values()):
yield info, None
for group in list(self._groups.values()):
for info in list(group._opts.values()):
yield info, group
def _all_cli_opts(
self,
) -> Iterator[tuple[Opt, OptGroup | None]]:
"""A generator function for iterating CLI opts."""
for item in self._cli_opts:
yield item['opt'], item['group']
def _unset_defaults_and_overrides(self) -> None:
"""Unset any default or override on all options."""
for info, group in self._all_opt_infos():
info.pop('default', None)
info.pop('override', None)
@property
def config_dirs(self) -> list[str]:
if self._namespace is None:
return []
return self._namespace._config_dirs
def find_file(self, name: str) -> str | None:
"""Locate a file located alongside the config files.
Search for a file with the supplied basename in the directories
which we have already loaded config files from and other known
configuration directories.
The directory, if any, supplied by the config_dir option is
searched first. Then the config_file option is iterated over
and each of the base directories of the config_files values
are searched. Failing both of these, the standard directories
searched by the module level find_config_files() function is
used. The first matching file is returned.
:param name: the filename, for example 'policy.json'
:returns: the path to a matching file, or None
"""
if not self._namespace:
raise NotInitializedError()
dirs = []
if self._namespace._config_dirs:
for directory in self._namespace._config_dirs:
dirs.append(_fixpath(directory))
for cf in reversed(self.config_file):
dirs.append(os.path.dirname(_fixpath(cf)))
dirs.extend(_get_config_dirs(self.project))
return _search_dirs(dirs, name)
def log_opt_values(self, logger: '_SupportsLog', lvl: int) -> None:
"""Log the value of all registered opts.
It's often useful for an app to log its configuration to a log file at
startup for debugging. This method dumps to the entire config state to
the supplied logger at a given log level.
:param logger: a logging.Logger object
:param lvl: the log level (for example logging.DEBUG) arg to
logger.log()
"""
logger.log(lvl, "*" * 80)
logger.log(lvl, "Configuration options gathered from:")
logger.log(lvl, "command line args: %s", self._args)
logger.log(
lvl,
"config files: %s",
hasattr(self, 'config_file') and self.config_file or [],
)
logger.log(lvl, "=" * 80)
def _sanitize(opt: Opt, value: Any) -> Any:
"""Obfuscate values of options declared secret."""
return value if not opt.secret else '*' * 4
for opt_name in sorted(self._opts):
opt = self._get_opt_info(opt_name)['opt']
logger.log(
lvl,
"%-30s = %s",
opt_name,
_sanitize(opt, getattr(self, opt_name)),
)
for group_name in list(self._groups):
group_attr = self.GroupAttr(self, self._get_group(group_name))
for opt_name in sorted(self._groups[group_name]._opts):
opt = self._get_opt_info(opt_name, group_name)['opt']
logger.log(
lvl,
"%-30s = %s",
f"{group_name}.{opt_name}",
_sanitize(opt, getattr(group_attr, opt_name)),
)
logger.log(lvl, "*" * 80)
def print_usage(self, file: IO[str] | None = None) -> None:
"""Print the usage message for the current program.
This method is for use after all CLI options are known
registered using __call__() method. If this method is called
before the __call__() is invoked, it throws NotInitializedError
:param file: the File object (if None, output is on sys.stdout)
:raises: NotInitializedError
"""
if not self._oparser:
raise NotInitializedError()
self._oparser.print_usage(file)
def print_help(self, file: IO[str] | None = None) -> None:
"""Print the help message for the current program.
This method is for use after all CLI options are known
registered using __call__() method. If this method is called
before the __call__() is invoked, it throws NotInitializedError
:param file: the File object (if None, output is on sys.stdout)
:raises: NotInitializedError
"""
if not self._oparser:
raise NotInitializedError()
self._oparser.print_help(file)
def _get(
self,
name: str,
group: str | OptGroup | None = None,
namespace: '_Namespace | None' = None,
) -> Any:
key: tuple[str | None, str]
if isinstance(group, OptGroup):
key = (group.name, name)
else:
key = (group, name)
if namespace is None:
try:
return self.__cache[key]
except KeyError: # nosec: Valid control flow instruction
pass
value, loc = self._do_get(name, group, namespace)
self.__cache[key] = value
return value
def _do_get(
self,
name: str,
group: str | OptGroup | None = None,
namespace: '_Namespace | None' = None,
) -> tuple[Any, 'LocationInfo | None']:
"""Look up an option value.
:param name: the opt name (or 'dest', more precisely)
:param group: an OptGroup
:param namespace: the namespace object to get the option value from
:returns: 2-tuple of the option value or a GroupAttr object
and LocationInfo or None
:raises: NoSuchOptError, NoSuchGroupError, ConfigFileValueError,
TemplateSubstitutionError
"""
if group is None and name in self._groups:
return (self.GroupAttr(self, self._get_group(name)), None)
info = self._get_opt_info(name, group)
opt = info['opt']
if 'location' in info:
loc = info['location']
else:
loc = opt._set_location
if isinstance(opt, SubCommandOpt):
resolved_group = (
self._get_group(group) if isinstance(group, str) else group
)
return (
self.SubCommandAttr(self, resolved_group, opt.dest),
None,
)
if 'override' in info:
return (self._substitute(info['override']), loc)
def convert(value: Any) -> Any:
return self._convert_value(
self._substitute(value, group, namespace), opt
)
group_name = group.name if isinstance(group, OptGroup) else group
key = (group_name, name)
# If use_env is true, get a value from the environment but don't use
# it yet. We will look at the command line first, below.
env_val: tuple[Any, LocationInfo | None] = (sources._NoValue, None)
if self._use_env:
env_val = self._env_driver.get(group_name, name, opt)
if opt.mutable and namespace is None:
namespace = self._mutable_ns
if namespace is None:
namespace = self._namespace
if namespace is not None:
try:
alt_loc = None
try:
val, alt_loc = opt._get_from_namespace(
namespace, group_name
)
# Try command line first
if (
val != sources._NoValue
and alt_loc is not None
and alt_loc.location == Locations.command_line
):
return (convert(val), alt_loc)
# Environment source second
if env_val[0] != sources._NoValue:
return (convert(env_val[0]), env_val[1])
# Default file source third
if val != sources._NoValue:
return (convert(val), alt_loc)
except KeyError: # nosec: Valid control flow instruction
alt_loc = LocationInfo(
Locations.environment,
self._env_driver.get_name(group_name, name),
)
# If there was a KeyError looking at config files or
# command line, retry the env_val.
if env_val[0] != sources._NoValue:
return (convert(env_val[0]), env_val[1])
except ValueError as ve:
message = (
f"Value for option {opt.name} from {alt_loc} "
f"is not valid: {str(ve)}"
)
# Preserve backwards compatibility for file-based value
# errors.
if alt_loc is not None and alt_loc.location == Locations.user:
raise ConfigFileValueError(message)
raise ConfigSourceValueError(message)
try:
return self.__drivers_cache[key]
except KeyError: # nosec: Valid control flow instruction
pass
for source in self._sources:
val = source.get(group_name, name, opt)
if val[0] != sources._NoValue:
result = (convert(val[0]), val[1])
self.__drivers_cache[key] = result
return result
if 'default' in info:
return (self._substitute(info['default']), loc)
if self._validate_default_values:
if opt.default is not None:
try:
convert(opt.default)
except ValueError as e:
raise ConfigFileValueError(
f"Default value for option {opt.name} is not valid: "
f"{str(e)}"
)
if opt.default is not None:
return (convert(opt.default), loc)
return (None, None)
def _substitute(
self,
value: Any,
group: str | OptGroup | None = None,
namespace: '_Namespace | None' = None,
) -> Any:
"""Perform string template substitution.
Substitute any template variables (for example $foo, ${bar}) in
the supplied string value(s) with opt values.
:param value: the string value, or list of string values
:param group: the group that retrieves the option value from
:param namespace: the namespace object that retrieves the option
value from
:returns: the substituted string(s)
"""
if isinstance(value, list):
return [
self._substitute(i, group=group, namespace=namespace)
for i in value
]
elif isinstance(value, str):
# Treat a backslash followed by the dollar sign "\$"
# the same as the string template escape "$$" as it is
# a bit more natural for users
if r'\$' in value:
value = value.replace(r'\$', '$$')
tmpl = self.Template(value)
ret = tmpl.safe_substitute(
cast(
Mapping[str, str],
self.StrSubWrapper(self, group=group, namespace=namespace),
)
)
return ret
elif isinstance(value, dict):
# Substitute template variables in both key and value
return {
self._substitute(
key, group=group, namespace=namespace
): self._substitute(val, group=group, namespace=namespace)
for key, val in value.items()
}
else:
return value
class Template(string.Template):
idpattern = r'[_a-z][\._a-z0-9]*'
def _convert_value(self, value: Any, opt: Opt) -> Any:
"""Perform value type conversion.
Converts values using option's type. Handles cases when value is
actually a list of values (for example for multi opts).
:param value: the string value, or list of string values
:param opt: option definition (instance of Opt class or its subclasses)
:returns: converted value
"""
if opt.multi:
return [opt.type(v) for v in value]
else:
return opt.type(value)
def _get_group(
self, group_or_name: str | OptGroup, autocreate: bool = False
) -> OptGroup:
"""Looks up a OptGroup object.
Helper function to return an OptGroup given a parameter which can
either be the group's name or an OptGroup object.
The OptGroup object returned is from the internal dict of OptGroup
objects, which will be a copy of any OptGroup object that users of
the API have access to.
If autocreate is True, the group will be created if it's not found. If
group is an instance of OptGroup, that same instance will be
registered, otherwise a new instance of OptGroup will be created.
:param group_or_name: the group's name or the OptGroup object itself
:param autocreate: whether to auto-create the group if it's not found
:raises: NoSuchGroupError
"""
if isinstance(group_or_name, OptGroup):
group: OptGroup | None = group_or_name
group_name: str = group_or_name.name
else:
group = None
group_name = group_or_name
if group_name not in self._groups:
if not autocreate:
raise NoSuchGroupError(group_name)
self.register_group(group or OptGroup(name=group_name))
return self._groups[group_name]
def _find_deprecated_opts(
self,
opt_name: str,
group: str | OptGroup | None = None,
) -> tuple[str | None, str | None]:
real_opt_name = None
real_group_name = None
if isinstance(group, OptGroup):
group_name: str = group.name
elif group is not None:
group_name = group
else:
group_name = 'DEFAULT'
dep_group = self._deprecated_opts.get(group_name)
if dep_group:
real_opt_dict = dep_group.get(opt_name)
if real_opt_dict:
real_opt_name = real_opt_dict['opt'].name
if real_opt_dict['group']:
real_group_name = real_opt_dict['group'].name
return real_opt_name, real_group_name
def _get_opt_info(
self,
opt_name: str,
group: str | OptGroup | None = None,
) -> _OptInfo:
"""Return the (opt, override, default) dict for an opt.
:param opt_name: an opt name/dest
:param group: an optional group name or OptGroup object
:raises: NoSuchOptError, NoSuchGroupError
"""
if group is None:
opts = self._opts
else:
group = self._get_group(group)
opts = group._opts
if opt_name not in opts:
real_opt_name, real_group_name = self._find_deprecated_opts(
opt_name, group=group
)
if not real_opt_name:
raise NoSuchOptError(opt_name, group)
LOG.warning(
'Config option %(dep_group)s.%(dep_option)s is deprecated. '
'Use option %(group)s.%(option)s instead.',
{
'dep_option': opt_name,
'dep_group': group,
'option': real_opt_name,
'group': real_group_name or 'DEFAULT',
},
)
opt_name = real_opt_name
if real_group_name:
group = self._get_group(real_group_name)
opts = group._opts
return opts[opt_name]
def _check_required_opts(
self, namespace: '_Namespace | None' = None
) -> None:
"""Check that all opts marked as required have values specified.
:param namespace: the namespace object be checked the required options
:raises: RequiredOptError
"""
for info, group in self._all_opt_infos():
opt = info['opt']
if opt.required:
if 'default' in info or 'override' in info:
continue
if self._get(opt.dest, group, namespace) is None:
raise RequiredOptError(opt.name, group)
def _parse_cli_opts(self, args: Sequence[str]) -> '_Namespace':
"""Parse command line options.
Initializes the command line option parser and parses the supplied
command line arguments.
:param args: the command line arguments
:returns: a _Namespace object containing the parsed option values
:raises: SystemExit, DuplicateOptError
ConfigFileParseError, ConfigFileValueError
"""
self._args = list(args)
assert self._oparser is not None
for opt, group in self._all_cli_opts():
opt._add_to_cli(self._oparser, group)
return self._parse_config_files()
def _parse_config_files(self) -> '_Namespace':
"""Parse configure files options.
:raises: SystemExit, ConfigFilesNotFoundError, ConfigFileParseError,
ConfigFilesPermissionDeniedError,
RequiredOptError, DuplicateOptError
"""
namespace = _Namespace(self)
assert self._args is not None
assert self._oparser is not None
# handle --config-file args or the default_config_files
for arg in self._args:
if arg == '--config-file' or arg.startswith('--config-file='):
break
else:
for config_file in self.default_config_files:
ConfigParser._parse_file(config_file, namespace)
# handle --config-dir args or the default_config_dirs
for arg in self._args:
if arg == '--config-dir' or arg.startswith('--config-dir='):
break
else:
for config_dir in self.default_config_dirs:
# for the default config-dir directories we just continue
# if the directories do not exist. This is different to the
# case where --config-dir is given on the command line.
if not os.path.exists(config_dir):
continue
config_dir_glob = os.path.join(config_dir, '*.conf')
for config_file in sorted(glob.glob(config_dir_glob)):
ConfigParser._parse_file(config_file, namespace)
self._oparser.parse_args(self._args, namespace)
self._validate_cli_options(namespace)
return namespace
def _validate_cli_options(self, namespace: '_Namespace') -> None:
for opt, group in sorted(
self._all_cli_opts(), key=lambda x: x[0].name
):
group_name = group.name if group else None
try:
value, loc = opt._get_from_namespace(namespace, group_name)
except KeyError:
continue
value = self._substitute(value, group=group, namespace=namespace)
try:
self._convert_value(value, opt)
except ValueError:
sys.stderr.write(
f"argument --{opt.dest}: Invalid {repr(opt.type)} value: {value}\n" # noqa: E501
)
raise SystemExit(1)
def _reload_config_files(self) -> '_Namespace':
namespace = self._parse_config_files()
if namespace._files_not_found:
raise ConfigFilesNotFoundError(namespace._files_not_found)
if namespace._files_permission_denied:
raise ConfigFilesPermissionDeniedError(
namespace._files_permission_denied
)
self._check_required_opts(namespace)
return namespace
@__clear_cache
@__clear_drivers_cache
def reload_config_files(self) -> bool:
"""Reload configure files and parse all options
:return: False if reload configure files failed or else return True
"""
try:
namespace = self._reload_config_files()
except SystemExit as exc:
LOG.warning(
"Caught SystemExit while reloading configure "
"files with exit code: %d",
exc.code,
)
return False
except Error as err:
LOG.warning(
"Caught Error while reloading configure files: %s", err
)
return False
else:
self._namespace = namespace
return True
def register_mutate_hook(self, hook: Callable[..., Any]) -> None:
"""Registers a hook to be called by mutate_config_files.
:param hook: a function accepting this ConfigOpts object and a dict of
config mutations, as returned by mutate_config_files.
:return: None
"""
self._mutate_hooks.add(hook)
def mutate_config_files(
self,
) -> dict[tuple[str | None, str], tuple[Any, Any]]:
"""Reload configure files and parse all options.
Only options marked as 'mutable' will appear to change.
Hooks are called in a NON-DETERMINISTIC ORDER. Do not expect hooks to
be called in the same order as they were added.
:return: {(None or 'group', 'optname'): (old_value, new_value), ... }
:raises: Error if reloading fails
"""
self.__cache.clear()
old_mutate_ns = self._mutable_ns or self._namespace
self._mutable_ns = self._reload_config_files()
self._warn_immutability()
fresh = self._diff_ns(old_mutate_ns, self._mutable_ns)
def key_fn(
item: tuple[tuple[str | None, str], tuple[Any, Any]],
) -> tuple[Any, Any]:
# Py3 won't sort heterogeneous types. Sort None as TAB which has a
# very low ASCII value.
(groupname, optname) = item[0]
return item[0] if groupname else ('\t', optname)
sorted_fresh = sorted(fresh.items(), key=key_fn)
for (groupname, optname), (old, new) in sorted_fresh:
groupname = groupname if groupname else 'DEFAULT'
LOG.info(
"Option %(group)s.%(option)s changed from "
"[%(old_val)s] to [%(new_val)s]",
{
'group': groupname,
'option': optname,
'old_val': old,
'new_val': new,
},
)
for hook in self._mutate_hooks:
hook(self, fresh)
return fresh
def _warn_immutability(self) -> None:
"""Check immutable opts have not changed.
_do_get won't return the new values but presumably someone changed the
config file expecting them to change so we should warn them they won't.
"""
assert self._namespace is not None
assert self._mutable_ns is not None
for info, group in self._all_opt_infos():
opt = info['opt']
if opt.mutable:
continue
groupname = group.name if group else 'DEFAULT'
try:
old, _ = opt._get_from_namespace(self._namespace, groupname)
except KeyError:
old = None
try:
new, _ = opt._get_from_namespace(self._mutable_ns, groupname)
except KeyError:
new = None
if old != new:
LOG.warning(
"Ignoring change to immutable option %(group)s.%(option)s",
{"group": groupname, "option": opt.name},
)
def _diff_ns(
self,
old_ns: '_Namespace | None',
new_ns: '_Namespace',
) -> dict[tuple[str | None, str], tuple[Any, Any]]:
"""Compare mutable option values between two namespaces.
This can be used to only reconfigure stateful sessions when necessary.
:return {(None or 'group', 'optname'): (old_value, new_value), ... }
"""
diff: dict[tuple[str | None, str], tuple[Any, Any]] = {}
for info, group in self._all_opt_infos():
opt = info['opt']
if not opt.mutable:
continue
groupname = group.name if group else None
try:
old, _ = (
opt._get_from_namespace(old_ns, groupname)
if old_ns is not None
else (None, None)
)
except KeyError:
old = None
try:
new, _ = opt._get_from_namespace(new_ns, groupname)
except KeyError:
new = None
if old != new:
diff[(groupname, opt.name)] = (old, new)
return diff
def list_all_sections(self) -> list[str]:
"""List all sections from the configuration.
Returns a sorted list of all section names found in the
configuration files, whether declared beforehand or not.
"""
s = set()
if self._mutable_ns:
s |= set(self._mutable_ns._sections())
if self._namespace:
s |= set(self._namespace._sections())
return sorted(s)
def get_location(
self, name: str, group: str | None = None
) -> 'LocationInfo | None':
"""Return the location where the option is being set.
:param name: The name of the option.
:param group: The name of the group of the option. Defaults to
``'DEFAULT'``.
:return: LocationInfo
.. seealso::
:doc:`/reference/locations`
.. versionadded:: 5.3.0
"""
opt_group = OptGroup(group) if group is not None else None
value, loc = self._do_get(name, opt_group, None)
return loc
class GroupAttr(Mapping[str, Any]):
"""Helper class.
Represents the option values of a group as a mapping and attributes.
"""
def __init__(self, conf: 'ConfigOpts', group: 'OptGroup') -> None:
"""Construct a GroupAttr object.
:param conf: a ConfigOpts object
:param group: an OptGroup object
"""
self._conf = conf
self._group = group
def __getattr__(self, name: str) -> Any:
"""Look up an option value and perform template substitution."""
return self._conf._get(name, self._group)
def __getitem__(self, key: str) -> Any:
"""Look up an option value and perform string substitution."""
return self.__getattr__(key)
def __contains__(self, key: object) -> bool:
"""Return True if key is the name of a registered opt or group."""
return key in self._group._opts
def __iter__(self) -> Iterator[str]:
"""Iterate over all registered opt and group names."""
yield from self._group._opts.keys()
def __len__(self) -> int:
"""Return the number of options and option groups."""
return len(self._group._opts)
class SubCommandAttr:
"""Helper class.
Represents the name and arguments of an argparse sub-parser.
"""
def __init__(
self,
conf: 'ConfigOpts',
group: 'OptGroup | None',
dest: str,
) -> None:
"""Construct a SubCommandAttr object.
:param conf: a ConfigOpts object
:param group: an OptGroup object
:param dest: the name of the sub-parser
"""
self._conf = conf
self._group = group
self._dest = dest
def __getattr__(self, name: str) -> Any:
"""Look up a sub-parser name or argument value."""
if name == 'name':
name = self._dest
if self._group is not None:
name = self._group.name + '_' + name
return getattr(self._conf._namespace, name)
if name in self._conf:
raise DuplicateOptError(name)
try:
return getattr(self._conf._namespace, name)
except AttributeError:
raise NoSuchOptError(name)
class StrSubWrapper:
"""Helper class.
Exposes opt values as a dict for string substitution.
"""
def __init__(
self,
conf: 'ConfigOpts',
group: 'str | OptGroup | None' = None,
namespace: '_Namespace | None' = None,
) -> None:
"""Construct a StrSubWrapper object.
:param conf: a ConfigOpts object
:param group: an OptGroup object
:param namespace: the namespace object that retrieves the option
value from
"""
self.conf = conf
self.group = group
self.namespace = namespace
def __getitem__(self, key: str) -> Any:
"""Look up an opt value from the ConfigOpts object.
:param key: an opt name
:returns: an opt value
"""
try:
group_name, option = key.split(".", 1)
except ValueError:
group = self.group
option = key
else:
group = OptGroup(name=group_name)
try:
value = self.conf._get(
option, group=group, namespace=self.namespace
)
except NoSuchOptError:
value = self.conf._get(key, namespace=self.namespace)
if isinstance(value, self.conf.GroupAttr):
raise TemplateSubstitutionError(
f'substituting group {key} not supported'
)
if value is None:
return ''
return value
CONF = ConfigOpts()
View Git Blame Copy Permalink