ansible-core 2.19.0b6__py3-none-any.whl → 2.19.0rc1__py3-none-any.whl

ansible/utils/display.py

@@ -40,7 +40,6 @@ import secrets
 import subprocess
 import sys
 import termios
-import textwrap
 import threading
 import time
 import tty
@@ -329,7 +328,6 @@ class Display(metaclass=Singleton):
         self.noncow = C.ANSIBLE_COW_SELECTION
 
         self.set_cowsay_info()
-        self._wrap_stderr = C.WRAP_STDERR
 
         if self.b_cowsay:
             try:
@@ -621,6 +619,12 @@ class Display(metaclass=Singleton):
             # collections have a resolved_name but no type
             collection = deprecator.resolved_name if deprecator else None
             plugin_fragment = ''
+        elif deprecator.resolved_name == 'ansible.builtin':
+            # core deprecations from base classes (the API) have no plugin name, only 'ansible.builtin'
+            plugin_type_name = str(deprecator.type) if deprecator.type is _messages.PluginType.MODULE else f'{deprecator.type} plugin'
+
+            collection = deprecator.resolved_name
+            plugin_fragment = f'the {plugin_type_name} API'
         else:
             parts = deprecator.resolved_name.split('.')
             plugin_name = parts[-1]
@@ -657,13 +661,6 @@ class Display(metaclass=Singleton):
 
         return _join_sentences(msg, deprecation_msg)
 
-    def _wrap_message(self, msg: str, wrap_text: bool) -> str:
-        if wrap_text and self._wrap_stderr:
-            wrapped = textwrap.wrap(msg, self.columns, drop_whitespace=False)
-            msg = "\n".join(wrapped) + "\n"
-
-        return msg
-
     @staticmethod
     def _deduplicate(msg: str, messages: set[str]) -> bool:
         """
@@ -780,9 +777,6 @@ class Display(metaclass=Singleton):
         msg = _format_message(warning, _traceback.is_traceback_enabled(_traceback.TracebackEvent.DEPRECATED))
         msg = f'[DEPRECATION WARNING]: {msg}'
 
-        # DTFIX3: what should we do with wrap_message?
-        msg = self._wrap_message(msg=msg, wrap_text=True)
-
         if self._deduplicate(msg, self._deprecations):
             return
 
@@ -799,6 +793,8 @@ class Display(metaclass=Singleton):
         """Display a warning message."""
         _skip_stackwalk = True
 
+        # deprecated: description='The formatted argument has no effect.' core_version='2.23'
+
         # This is the pre-proxy half of the `warning` implementation.
         # Any logic that must occur on workers needs to be implemented here.
 
@@ -818,13 +814,12 @@ class Display(metaclass=Singleton):
 
         if warning_ctx := _DeferredWarningContext.current(optional=True):
             warning_ctx.capture(warning)
-            # DTFIX3: what to do about propagating wrap_text?
             return
 
-        self._warning(warning, wrap_text=not formatted)
+        self._warning(warning)
 
     @_proxy
-    def _warning(self, warning: _messages.WarningSummary, wrap_text: bool) -> None:
+    def _warning(self, warning: _messages.WarningSummary) -> None:
         """Internal implementation detail, use `warning` instead."""
 
         # This is the post-proxy half of the `warning` implementation.
@@ -836,9 +831,6 @@ class Display(metaclass=Singleton):
         if self._deduplicate(msg, self._warns):
             return
 
-        # DTFIX3: what should we do with wrap_message?
-        msg = self._wrap_message(msg=msg, wrap_text=wrap_text)
-
         self.display(msg, color=C.config.get_config_value('COLOR_WARN'), stderr=True, caplevel=-2)
 
     @_proxy
@@ -927,19 +919,20 @@ class Display(metaclass=Singleton):
             warning_ctx.capture(warning)
             return
 
-        self._warning(warning, wrap_text=False)
+        self._warning(warning)
 
     def error(self, msg: str | BaseException, wrap_text: bool = True, stderr: bool = True) -> None:
         """Display an error message."""
         _skip_stackwalk = True
 
+        # deprecated: description='The wrap_text argument has no effect.' core_version='2.23'
+        # deprecated: description='The stderr argument has no effect.' core_version='2.23'
+
         # This is the pre-proxy half of the `error` implementation.
         # Any logic that must occur on workers needs to be implemented here.
 
         if isinstance(msg, BaseException):
             event = _error_factory.ControllerEventFactory.from_exception(msg, _traceback.is_traceback_enabled(_traceback.TracebackEvent.ERROR))
-
-            wrap_text = False
         else:
             event = _messages.Event(
                 msg=msg,
@@ -950,10 +943,10 @@ class Display(metaclass=Singleton):
             event=event,
         )
 
-        self._error(error, wrap_text=wrap_text, stderr=stderr)
+        self._error(error, stderr=True)
 
     @_proxy
-    def _error(self, error: _messages.ErrorSummary, wrap_text: bool, stderr: bool) -> None:
+    def _error(self, error: _messages.ErrorSummary, stderr: bool) -> None:
         """Internal implementation detail, use `error` instead."""
 
         # This is the post-proxy half of the `error` implementation.
@@ -965,9 +958,6 @@ class Display(metaclass=Singleton):
         if self._deduplicate(msg, self._errors):
             return
 
-        # DTFIX3: what should we do with wrap_message?
-        msg = self._wrap_message(msg=msg, wrap_text=wrap_text)
-
         self.display(msg, color=C.config.get_config_value('COLOR_ERROR'), stderr=stderr, caplevel=-1)
 
     @staticmethod

ansible/utils/path.py

@@ -102,7 +102,7 @@ def basedir(source):
         dname = os.path.dirname(source)
 
     if dname:
-        # don't follow symlinks for basedir, enables source re-use
+        # don't follow symlinks for basedir, enables source reuse
         dname = os.path.abspath(dname)
 
     return to_text(dname, errors='surrogate_or_strict')

ansible/utils/vars.py

@@ -28,6 +28,7 @@ from json import dumps
 from ansible import constants as C
 from ansible import context
 from ansible._internal import _json
+from ansible._internal._templating import _jinja_bits
 from ansible.errors import AnsibleError, AnsibleOptionsError
 from ansible.module_utils.datatag import native_type_name
 from ansible.module_utils.common.text.converters import to_native, to_text
@@ -252,6 +253,8 @@ def isidentifier(ident):
 
     Originally posted at https://stackoverflow.com/a/29586366
     """
+    # deprecated: description='Use validate_variable_name instead.' core_version='2.23'
+
     if not isinstance(ident, str):
         return False
 
@@ -269,7 +272,7 @@ def isidentifier(ident):
 
 def validate_variable_name(name: object) -> None:
     """Validate the given variable name is valid, raising an AnsibleError if it is not."""
-    if isinstance(name, str) and isidentifier(name):
+    if isinstance(name, str) and name.isidentifier() and name.isascii() and name not in _jinja_bits.JINJA_KEYWORDS:
         return
 
     if isinstance(name, (str, int, float, bool, type(None))):
@@ -290,7 +293,7 @@ def validate_variable_name(name: object) -> None:
 def transform_to_native_types(
     value: object,
     redact: bool = True,
-) -> object:
+) -> t.Any:
     """
     Recursively transform the given value to Python native types.
     Potentially sensitive values such as individually vaulted variables will be redacted unless ``redact=False`` is passed.
@@ -303,6 +306,7 @@ def transform_to_native_types(
         convert_custom_scalars=True,
         convert_to_native_values=True,
         apply_transforms=True,
+        visit_keys=True,  # ensure that keys are also converted
         encrypted_string_behavior=_json.EncryptedStringBehavior.REDACT if redact else _json.EncryptedStringBehavior.DECRYPT,
     )
 

ansible/vars/manager.py

@@ -407,7 +407,7 @@ class VariableManager:
         all_vars = _combine_and_track(all_vars, self._extra_vars, "extra vars")
 
         # before we add 'reserved vars', check we didn't add any reserved vars
-        warn_if_reserved(all_vars.keys())
+        warn_if_reserved(all_vars)
 
         # magic variables
         all_vars = _combine_and_track(all_vars, magic_variables, "magic vars")
@@ -563,7 +563,8 @@ class VariableManager:
         if not isinstance(facts, Mapping):
             raise AnsibleAssertionError("the type of 'facts' to set for host_facts should be a Mapping but is a %s" % type(facts))
 
-        warn_if_reserved(facts.keys())
+        warn_if_reserved(facts)
+
         try:
             host_cache = self._fact_cache.get(host)
         except KeyError:
@@ -587,7 +588,8 @@ class VariableManager:
         if not isinstance(facts, Mapping):
             raise AnsibleAssertionError("the type of 'facts' to set for nonpersistent_facts should be a Mapping but is a %s" % type(facts))
 
-        warn_if_reserved(facts.keys())
+        warn_if_reserved(facts)
+
         try:
             self._nonpersistent_fact_cache[host] |= facts
         except KeyError:
@@ -599,6 +601,7 @@ class VariableManager:
         """
 
         warn_if_reserved([varname])
+
         if host not in self._vars_cache:
             self._vars_cache[host] = dict()
 

ansible/vars/reserved.py

@@ -66,8 +66,7 @@ def get_reserved_names(include_private: bool = True) -> set[str]:
 
 
 def warn_if_reserved(myvars: c.Iterable[str], additional: c.Iterable[str] | None = None) -> None:
-    """ this function warns if any variable passed conflicts with internally reserved names """
-
+    """Issue a warning for any variable which conflicts with an internally reserved name."""
     if additional is None:
         reserved = _RESERVED_NAMES
     else:
@@ -76,8 +75,11 @@ def warn_if_reserved(myvars: c.Iterable[str], additional: c.Iterable[str] | None
     varnames = set(myvars)
     varnames.discard('vars')  # we add this one internally, so safe to ignore
 
-    for varname in varnames.intersection(reserved):
-        display.warning(f'Found variable using reserved name {varname!r}.')
+    if conflicts := varnames.intersection(reserved):
+        # Ensure the varname used for obj is the tagged one from myvars and not the untagged one from reserved.
+        # This can occur because tags do not affect value equality, and intersection can return values from either the left or right side.
+        for varname in (name for name in myvars if name in conflicts):
+            display.warning(f'Found variable using reserved name {varname!r}.', obj=varname)
 
 
 def is_reserved_name(name: str) -> bool:

{ansible_core-2.19.0b6.dist-info → ansible_core-2.19.0rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ansible-core
-Version: 2.19.0b6
+Version: 2.19.0rc1
 Summary: Radically simple IT automation
 Author: Ansible Project
 Project-URL: Homepage, https://ansible.com/