ansible-core 2.18.5rc1__py3-none-any.whl → 2.19.0b1__py3-none-any.whl

ansible/config/manager.py

@@ -11,23 +11,21 @@ import os.path
 import sys
 import stat
 import tempfile
+import typing as t
 
-from collections import namedtuple
 from collections.abc import Mapping, Sequence
 from jinja2.nativetypes import NativeEnvironment
 
-from ansible.errors import AnsibleOptionsError, AnsibleError, AnsibleRequiredOptionError
+from ansible.errors import AnsibleOptionsError, AnsibleError, AnsibleUndefinedConfigEntry, AnsibleRequiredOptionError
+from ansible.module_utils.common.sentinel import Sentinel
 from ansible.module_utils.common.text.converters import to_text, to_bytes, to_native
 from ansible.module_utils.common.yaml import yaml_load
 from ansible.module_utils.six import string_types
 from ansible.module_utils.parsing.convert_bool import boolean
 from ansible.parsing.quoting import unquote
-from ansible.parsing.yaml.objects import AnsibleVaultEncryptedUnicode
 from ansible.utils.path import cleanup_tmp_file, makedirs_safe, unfrackpath
 
 
-Setting = namedtuple('Setting', 'name value origin type')
-
 INTERNAL_DEFS = {'lookup': ('_terms',)}
 
 GALAXY_SERVER_DEF = [
@@ -39,6 +37,7 @@ GALAXY_SERVER_DEF = [
     ('api_version', False, 'int'),
     ('validate_certs', False, 'bool'),
     ('client_id', False, 'str'),
+    ('client_secret', False, 'str'),
     ('timeout', False, 'int'),
 ]
 
@@ -51,20 +50,24 @@ GALAXY_SERVER_ADDITIONAL = {
 }
 
 
-def _get_entry(plugin_type, plugin_name, config):
-    ''' construct entry for requested config '''
-    entry = ''
+def _get_config_label(plugin_type: str, plugin_name: str, config: str) -> str:
+    """Return a label for the given config."""
+    entry = f'{config!r}'
+
     if plugin_type:
-        entry += 'plugin_type: %s ' % plugin_type
+        entry += ' for'
+
         if plugin_name:
-            entry += 'plugin: %s ' % plugin_name
-    entry += 'setting: %s ' % config
+            entry += f' {plugin_name!r}'
+
+        entry += f' {plugin_type} plugin'
+
     return entry
 
 
 # FIXME: see if we can unify in module_utils with similar function used by argspec
 def ensure_type(value, value_type, origin=None, origin_ftype=None):
-    ''' return a configuration variable with casting
+    """ return a configuration variable with casting
     :arg value: The value to ensure correct typing of
     :kwarg value_type: The type of the value.  This can be any of the following strings:
         :boolean: sets the value to a True or False value
@@ -87,7 +90,7 @@ def ensure_type(value, value_type, origin=None, origin_ftype=None):
             tildes's in the value.
         :str: Sets the value to string types.
         :string: Same as 'str'
-    '''
+    """
 
     errmsg = ''
     basedir = None
@@ -108,8 +111,8 @@ def ensure_type(value, value_type, origin=None, origin_ftype=None):
                         value = int_part
                     else:
                         errmsg = 'int'
-                except decimal.DecimalException as e:
-                    raise ValueError from e
+                except decimal.DecimalException:
+                    errmsg = 'int'
 
         elif value_type == 'float':
             if not isinstance(value, float):
@@ -168,7 +171,7 @@ def ensure_type(value, value_type, origin=None, origin_ftype=None):
                 errmsg = 'dictionary'
 
         elif value_type in ('str', 'string'):
-            if isinstance(value, (string_types, AnsibleVaultEncryptedUnicode, bool, int, float, complex)):
+            if isinstance(value, (string_types, bool, int, float, complex)):
                 value = to_text(value, errors='surrogate_or_strict')
                 if origin_ftype and origin_ftype == 'ini':
                     value = unquote(value)
@@ -176,20 +179,20 @@ def ensure_type(value, value_type, origin=None, origin_ftype=None):
                 errmsg = 'string'
 
         # defaults to string type
-        elif isinstance(value, (string_types, AnsibleVaultEncryptedUnicode)):
+        elif isinstance(value, (string_types)):
             value = to_text(value, errors='surrogate_or_strict')
             if origin_ftype and origin_ftype == 'ini':
                 value = unquote(value)
 
         if errmsg:
-            raise ValueError(f'Invalid type provided for "{errmsg}": {value!r}')
+            raise ValueError(f'Invalid type provided for {errmsg!r}: {value!r}')
 
     return to_text(value, errors='surrogate_or_strict', nonstring='passthru')
 
 
 # FIXME: see if this can live in utils/path
 def resolve_path(path, basedir=None):
-    ''' resolve relative or 'variable' paths '''
+    """ resolve relative or 'variable' paths """
     if '{{CWD}}' in path:  # allow users to force CWD using 'magic' {{CWD}}
         path = path.replace('{{CWD}}', os.getcwd())
 
@@ -214,7 +217,7 @@ def get_config_type(cfile):
 
 # FIXME: can move to module_utils for use for ini plugins also?
 def get_ini_config_value(p, entry):
-    ''' returns the value of last ini entry found '''
+    """ returns the value of last ini entry found """
     value = None
     if p is not None:
         try:
@@ -225,22 +228,20 @@ def get_ini_config_value(p, entry):
 
 
 def find_ini_config_file(warnings=None):
-    ''' Load INI Config File order(first found is used): ENV, CWD, HOME, /etc/ansible '''
+    """ Load INI Config File order(first found is used): ENV, CWD, HOME, /etc/ansible """
     # FIXME: eventually deprecate ini configs
 
     if warnings is None:
         # Note: In this case, warnings does nothing
         warnings = set()
 
-    # A value that can never be a valid path so that we can tell if ANSIBLE_CONFIG was set later
-    # We can't use None because we could set path to None.
-    SENTINEL = object
-
     potential_paths = []
 
+    # A value that can never be a valid path so that we can tell if ANSIBLE_CONFIG was set later
+    # We can't use None because we could set path to None.
     # Environment setting
-    path_from_env = os.getenv("ANSIBLE_CONFIG", SENTINEL)
-    if path_from_env is not SENTINEL:
+    path_from_env = os.getenv("ANSIBLE_CONFIG", Sentinel)
+    if path_from_env is not Sentinel:
         path_from_env = unfrackpath(path_from_env, follow=False)
         if os.path.isdir(to_bytes(path_from_env)):
             path_from_env = os.path.join(path_from_env, "ansible.cfg")
@@ -290,7 +291,7 @@ def find_ini_config_file(warnings=None):
 
 
 def _add_base_defs_deprecations(base_defs):
-    '''Add deprecation source 'ansible.builtin' to deprecations in base.yml'''
+    """Add deprecation source 'ansible.builtin' to deprecations in base.yml"""
     def process(entry):
         if 'deprecated' in entry:
             entry['deprecated']['collection_name'] = 'ansible.builtin'
@@ -372,6 +373,7 @@ class ConfigManager(object):
             # template default values if possible
             # NOTE: cannot use is_template due to circular dep
             try:
+                # FIXME: This really should be using an immutable sandboxed native environment, not just native environment
                 t = NativeEnvironment().from_string(value)
                 value = t.render(variables)
             except Exception:
@@ -389,7 +391,7 @@ class ConfigManager(object):
             "Missing base YAML definition file (bad install?): %s" % to_native(yml_file))
 
     def _parse_config_file(self, cfile=None):
-        ''' return flat configuration settings from file(s) '''
+        """ return flat configuration settings from file(s) """
         # TODO: take list of files with merge/nomerge
 
         if cfile is None:
@@ -416,7 +418,7 @@ class ConfigManager(object):
                 raise AnsibleOptionsError("Unsupported configuration file type: %s" % to_native(ftype))
 
     def _find_yaml_config_files(self):
-        ''' Load YAML Config Files in order, check merge flags, keep origin of settings'''
+        """ Load YAML Config Files in order, check merge flags, keep origin of settings"""
         pass
 
     def get_plugin_options(self, plugin_type, name, keys=None, variables=None, direct=None):
@@ -468,7 +470,7 @@ class ConfigManager(object):
         return has
 
     def get_configuration_definitions(self, plugin_type=None, name=None, ignore_private=False):
-        ''' just list the possible settings, either base or for specific plugins or plugin '''
+        """ just list the possible settings, either base or for specific plugins or plugin """
 
         ret = {}
         if plugin_type is None:
@@ -485,7 +487,7 @@ class ConfigManager(object):
         return ret
 
     def _loop_entries(self, container, entry_list):
-        ''' repeat code for value entry assignment '''
+        """ repeat code for value entry assignment """
 
         value = None
         origin = None
@@ -497,10 +499,6 @@ class ConfigManager(object):
                 self.WARNINGS.add(u'value for config entry {0} contains invalid characters, ignoring...'.format(to_text(name)))
                 continue
             if temp_value is not None:  # only set if entry is defined in container
-                # inline vault variables should be converted to a text string
-                if isinstance(temp_value, AnsibleVaultEncryptedUnicode):
-                    temp_value = to_text(temp_value, errors='surrogate_or_strict')
-
                 value = temp_value
                 origin = name
 
@@ -511,19 +509,23 @@ class ConfigManager(object):
         return value, origin
 
     def get_config_value(self, config, cfile=None, plugin_type=None, plugin_name=None, keys=None, variables=None, direct=None):
-        ''' wrapper '''
+        """ wrapper """
 
         try:
             value, _drop = self.get_config_value_and_origin(config, cfile=cfile, plugin_type=plugin_type, plugin_name=plugin_name,
                                                             keys=keys, variables=variables, direct=direct)
         except AnsibleError:
             raise
-        except Exception as e:
-            raise AnsibleError("Unhandled exception when retrieving %s:\n%s" % (config, to_native(e)), orig_exc=e)
+        except Exception as ex:
+            raise AnsibleError(f"Unhandled exception when retrieving {config!r}.") from ex
         return value
 
+    def get_config_default(self, config: str, plugin_type: str | None = None, plugin_name: str | None = None) -> t.Any:
+        """Return the default value for the specified configuration."""
+        return self.get_configuration_definitions(plugin_type, plugin_name)[config]['default']
+
     def get_config_value_and_origin(self, config, cfile=None, plugin_type=None, plugin_name=None, keys=None, variables=None, direct=None):
-        ''' Given a config key figure out the actual value and report on the origin of the settings '''
+        """ Given a config key figure out the actual value and report on the origin of the settings """
         if cfile is None:
             # use default config
             cfile = self._config_file
@@ -626,22 +628,21 @@ class ConfigManager(object):
             if value is None:
                 if defs[config].get('required', False):
                     if not plugin_type or config not in INTERNAL_DEFS.get(plugin_type, {}):
-                        raise AnsibleRequiredOptionError("No setting was provided for required configuration %s" %
-                                                         to_native(_get_entry(plugin_type, plugin_name, config)))
+                        raise AnsibleRequiredOptionError(f"Required config {_get_config_label(plugin_type, plugin_name, config)} not provided.")
                 else:
                     origin = 'default'
                     value = self.template_default(defs[config].get('default'), variables)
+
             try:
                 # ensure correct type, can raise exceptions on mismatched types
                 value = ensure_type(value, defs[config].get('type'), origin=origin, origin_ftype=origin_ftype)
-            except ValueError as e:
+            except ValueError as ex:
                 if origin.startswith('env:') and value == '':
                     # this is empty env var for non string so we can set to default
                     origin = 'default'
                     value = ensure_type(defs[config].get('default'), defs[config].get('type'), origin=origin, origin_ftype=origin_ftype)
                 else:
-                    raise AnsibleOptionsError('Invalid type for configuration option %s (from %s): %s' %
-                                              (to_native(_get_entry(plugin_type, plugin_name, config)).strip(), origin, to_native(e)))
+                    raise AnsibleOptionsError(f'Config {_get_config_label(plugin_type, plugin_name, config)} from {origin!r} has an invalid value.') from ex
 
             # deal with restricted values
             if value is not None and 'choices' in defs[config] and defs[config]['choices'] is not None:
@@ -664,14 +665,14 @@ class ConfigManager(object):
                     else:
                         valid = defs[config]['choices']
 
-                    raise AnsibleOptionsError('Invalid value "%s" for configuration option "%s", valid values are: %s' %
-                                              (value, to_native(_get_entry(plugin_type, plugin_name, config)), valid))
+                    raise AnsibleOptionsError(f'Invalid value {value!r} for config {_get_config_label(plugin_type, plugin_name, config)}.',
+                                              help_text=f'Valid values are: {valid}')
 
             # deal with deprecation of the setting
             if 'deprecated' in defs[config] and origin != 'default':
                 self.DEPRECATED.append((config, defs[config].get('deprecated')))
         else:
-            raise AnsibleError('Requested entry (%s) was not defined in configuration.' % to_native(_get_entry(plugin_type, plugin_name, config)))
+            raise AnsibleUndefinedConfigEntry(f'No config definition exists for {_get_config_label(plugin_type, plugin_name, config)}.')
 
         return value, origin
 
@@ -683,12 +684,14 @@ class ConfigManager(object):
         self._plugins[plugin_type][name] = defs
 
     @staticmethod
-    def get_deprecated_msg_from_config(dep_docs, include_removal=False):
+    def get_deprecated_msg_from_config(dep_docs, include_removal=False, collection_name=None):
 
         removal = ''
         if include_removal:
             if 'removed_at_date' in dep_docs:
                 removal = f"Will be removed in a release after {dep_docs['removed_at_date']}\n\t"
+            elif collection_name:
+                removal = f"Will be removed in: {collection_name} {dep_docs['removed_in']}\n\t"
             else:
                 removal = f"Will be removed in: Ansible {dep_docs['removed_in']}\n\t"
 

ansible/constants.py

@@ -21,7 +21,7 @@ config = ConfigManager()
 
 
 def _warning(msg):
-    ''' display is not guaranteed here, nor it being the full class, but try anyways, fallback to sys.stderr.write '''
+    """ display is not guaranteed here, nor it being the full class, but try anyways, fallback to sys.stderr.write """
     try:
         from ansible.utils.display import Display
         Display().warning(msg)
@@ -31,7 +31,7 @@ def _warning(msg):
 
 
 def _deprecated(msg, version):
-    ''' display is not guaranteed here, nor it being the full class, but try anyways, fallback to sys.stderr.write '''
+    """ display is not guaranteed here, nor it being the full class, but try anyways, fallback to sys.stderr.write """
     try:
         from ansible.utils.display import Display
         Display().deprecated(msg, version=version)
@@ -63,7 +63,7 @@ def handle_config_noise(display=None):
 
 
 def set_constant(name, value, export=vars()):
-    ''' sets constants and returns resolved options dict '''
+    """ sets constants and returns resolved options dict """
     export[name] = value
 
 
@@ -166,7 +166,6 @@ INTERNAL_STATIC_VARS = frozenset(
         "inventory_hostname_short",
         "groups",
         "group_names",
-        "omit",
         "hostvars",
         "playbook_dir",
         "play_hosts",