ansible-core 2.19.2rc1__py3-none-any.whl → 2.20.0b1__py3-none-any.whl

ansible/release.py

@@ -17,6 +17,6 @@
 
 from __future__ import annotations
 
-__version__ = '2.19.2rc1'
+__version__ = '2.20.0b1'
 __author__ = 'Ansible, Inc.'
-__codename__ = "What Is and What Should Never Be"
+__codename__ = "Good Times Bad Times"

ansible/template/__init__.py

@@ -25,7 +25,6 @@ if _t.TYPE_CHECKING:  # pragma: nocover
 
 _display: _t.Final[_Display] = _Display()
 _UNSET = _t.cast(_t.Any, object())
-_TTrustable = _t.TypeVar('_TTrustable', bound=str | _io.IOBase | _t.TextIO | _t.BinaryIO)
 _TRUSTABLE_TYPES = (str, _io.IOBase)
 
 AnsibleUndefined = _jinja_common.UndefinedMarker
@@ -361,7 +360,7 @@ def generate_ansible_template_vars(
     return _template_vars.generate_ansible_template_vars(path=path, fullpath=fullpath, dest_path=dest_path, include_ansible_managed=True)
 
 
-def trust_as_template(value: _TTrustable) -> _TTrustable:
+def trust_as_template[T: str | _io.IOBase | _t.TextIO | _t.BinaryIO](value: T) -> T:
     """
     Returns `value` tagged as trusted for templating.
     Raises a `TypeError` if `value` is not a supported type.
@@ -385,10 +384,7 @@ def is_trusted_as_template(value: object) -> bool:
     return isinstance(value, _TRUSTABLE_TYPES) and _tags.TrustedAsTemplate.is_tagged_on(value)
 
 
-_TCallable = _t.TypeVar('_TCallable', bound=_t.Callable)
-
-
-def accept_args_markers(plugin: _TCallable) -> _TCallable:
+def accept_args_markers[T: _t.Callable](plugin: T) -> T:
     """
     A decorator to mark a Jinja plugin as capable of handling `Marker` values for its top-level arguments.
     Non-decorated plugin invocation is skipped when a top-level argument is a `Marker`, with the first such value substituted as the plugin result.
@@ -399,7 +395,7 @@ def accept_args_markers(plugin: _TCallable) -> _TCallable:
     return plugin
 
 
-def accept_lazy_markers(plugin: _TCallable) -> _TCallable:
+def accept_lazy_markers[T: _t.Callable](plugin: T) -> T:
     """
     A decorator to mark a Jinja plugin as capable of handling `Marker` values retrieved from lazy containers.
     Non-decorated plugins will trigger a `MarkerError` exception when attempting to retrieve a `Marker` from a lazy container.

ansible/utils/collection_loader/_collection_config.py

@@ -62,6 +62,11 @@ class _AnsibleCollectionConfig(type):
         cls._require_finder()
         return [_to_text(p) for p in cls._collection_finder._n_collection_paths]
 
+    @property
+    def _internal_collections(cls):
+        cls._require_finder()
+        return cls._collection_finder._internal_collections
+
     @property
     def default_collection(cls):
         return cls._default_collection

ansible/utils/collection_loader/_collection_finder.py

@@ -26,20 +26,16 @@ from . import _to_bytes, _to_text
 from ._collection_config import AnsibleCollectionConfig
 
 try:
-    try:
-        # Available on Python >= 3.11
-        # We ignore the import error that will trigger when running mypy with
-        # older Python versions.
-        from importlib.resources.abc import TraversableResources  # type: ignore[import]
-    except ImportError:
-        # Used with Python 3.9 and 3.10 only
-        # This member is still available as an alias up until Python 3.14 but
-        # is deprecated as of Python 3.12.
-        from importlib.abc import TraversableResources  # deprecated: description='TraversableResources move' python_version='3.10'
+    # Available on Python >= 3.11
+    # We ignore the import error that will trigger when running mypy with
+    # older Python versions.
+    from importlib.resources.abc import TraversableResources  # type: ignore[import]
 except ImportError:
-    # Python < 3.9
-    # deprecated: description='TraversableResources fallback' python_version='3.8'
-    TraversableResources = object  # type: ignore[assignment,misc]
+    # Used with Python 3.9 and 3.10 only
+    # This member is still available as an alias up until Python 3.14 but
+    # is deprecated as of Python 3.12.
+    # deprecated: description='TraversableResources move' python_version='3.10'
+    from importlib.abc import TraversableResources  # type: ignore[assignment,no-redef]
 
 # NB: this supports import sanity test providing a different impl
 try:
@@ -186,7 +182,7 @@ class _AnsibleTraversableResources(TraversableResources):
 
 
 class _AnsibleCollectionFinder:
-    def __init__(self, paths=None, scan_sys_paths=True):
+    def __init__(self, paths=None, scan_sys_paths=True, internal_collections=None):
         # TODO: accept metadata loader override
         self._ansible_pkg_path = _to_text(os.path.dirname(_to_bytes(sys.modules['ansible'].__file__)))
 
@@ -213,6 +209,7 @@ class _AnsibleCollectionFinder:
             if p not in good_paths and os.path.isdir(_to_bytes(os.path.join(p, 'ansible_collections'))):
                 good_paths.append(p)
 
+        self._internal_collections = internal_collections
         self._n_configured_paths = good_paths
         self._n_cached_collection_paths = None
         self._n_cached_collection_qualified_paths = None

ansible/utils/context_objects.py

@@ -9,14 +9,14 @@ from __future__ import annotations
 from abc import ABCMeta
 from collections.abc import Container, Mapping, Sequence, Set
 
+from ansible.module_utils._internal import _no_six
 from ansible.module_utils.common.collections import ImmutableDict
-from ansible.module_utils.six import add_metaclass, binary_type, text_type
 from ansible.utils.singleton import Singleton
 
 
 def _make_immutable(obj):
     """Recursively convert a container and objects inside of it into immutable data types"""
-    if isinstance(obj, (text_type, binary_type)):
+    if isinstance(obj, (str, bytes)):
         # Strings first because they are also sequences
         return obj
     elif isinstance(obj, Mapping):
@@ -79,11 +79,14 @@ class CLIArgs(ImmutableDict):
         return cls(vars(options))
 
 
-@add_metaclass(_ABCSingleton)
-class GlobalCLIArgs(CLIArgs):
+class GlobalCLIArgs(CLIArgs, metaclass=_ABCSingleton):
     """
     Globally hold a parsed copy of cli arguments.
 
     Only one of these exist per program as it is for global context
     """
     pass
+
+
+def __getattr__(importable_name):
+    return _no_six.deprecate(importable_name, __name__, "binary_type", "text_type", "add_metaclass")

ansible/utils/display.py

@@ -18,7 +18,6 @@
 from __future__ import annotations
 
 import contextlib
-import dataclasses
 
 try:
     import curses
@@ -52,12 +51,11 @@ from ansible import constants as C
 from ansible.constants import config
 from ansible.errors import AnsibleAssertionError, AnsiblePromptInterrupt, AnsiblePromptNoninteractive, AnsibleError
 from ansible._internal._errors import _error_utils, _error_factory
-from ansible._internal import _event_formatting
-from ansible.module_utils._internal import _ambient_context, _deprecator, _messages
+from ansible._internal import _display_utils
+from ansible.module_utils._internal import _deprecator, _messages, _no_six
 from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.module_utils.datatag import deprecator_from_collection_name
 from ansible._internal._datatag._tags import TrustedAsTemplate
-from ansible.module_utils.six import text_type
 from ansible.module_utils._internal import _traceback, _errors
 from ansible.utils.color import stringc
 from ansible.utils.multiprocessing import context as multiprocessing_context
@@ -67,8 +65,6 @@ if t.TYPE_CHECKING:
     # avoid circular import at runtime
     from ansible.executor.task_queue_manager import FinalQueue
 
-P = t.ParamSpec('P')
-
 _LIBC = ctypes.cdll.LoadLibrary(ctypes.util.find_library('c'))
 # Set argtypes, to avoid segfault if the wrong type is provided,
 # restype is assumed to be c_int
@@ -100,6 +96,17 @@ def _is_controller_traceback_enabled(event: _traceback.TracebackEvent) -> bool:
 _traceback._is_traceback_enabled = _is_controller_traceback_enabled
 
 
+def _deprecation_warnings_enabled() -> bool:
+    """Return True if deprecation warnings are enabled for the current calling context, otherwise False."""
+    # DTFIX-FUTURE: move this capability into config using an AmbientContext-derived TaskContext (once it exists)
+    if warning_ctx := _display_utils.DeferredWarningContext.current(optional=True):
+        variables = warning_ctx._variables
+    else:
+        variables = None
+
+    return C.config.get_config_value('DEPRECATION_WARNINGS', variables=variables)
+
+
 def get_text_width(text: str) -> int:
     """Function that utilizes ``wcswidth`` or ``wcwidth`` to determine the
     number of columns used to display a text string.
@@ -108,7 +115,7 @@ def get_text_width(text: str) -> int:
     character and using wcwidth individually, falling back to a value of 0
     for non-printable wide characters.
     """
-    if not isinstance(text, text_type):
+    if not isinstance(text, str):
         raise TypeError('get_text_width requires text, not %s' % type(text))
 
     try:
@@ -388,7 +395,7 @@ class Display(metaclass=Singleton):
                     self.b_cowsay = b_cow_path
 
     @staticmethod
-    def _proxy(
+    def _proxy[**P](
         func: c.Callable[t.Concatenate[Display, P], None]
     ) -> c.Callable[..., None]:
         @wraps(func)
@@ -582,7 +589,7 @@ class Display(metaclass=Singleton):
             version="2.23",
         )
 
-        msg = self._get_deprecation_message_with_plugin_info(
+        msg = _display_utils.get_deprecation_message_with_plugin_info(
             msg=msg,
             version=version,
             removed=removed,
@@ -597,70 +604,6 @@ class Display(metaclass=Singleton):
 
         return msg
 
-    def _get_deprecation_message_with_plugin_info(
-        self,
-        *,
-        msg: str,
-        version: str | None,
-        removed: bool = False,
-        date: str | None,
-        deprecator: _messages.PluginInfo | None,
-    ) -> str:
-        """Internal use only. Return a deprecation message and help text for display."""
-        # DTFIX-FUTURE: the logic for omitting date/version doesn't apply to the payload, so it shows up in vars in some cases when it should not
-
-        if removed:
-            removal_fragment = 'This feature was removed'
-        else:
-            removal_fragment = 'This feature will be removed'
-
-        if not deprecator or not deprecator.type:
-            # indeterminate has no resolved_name or type
-            # 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]
-            plugin_type_name = str(deprecator.type) if deprecator.type is _messages.PluginType.MODULE else f'{deprecator.type} plugin'
-
-            collection = '.'.join(parts[:2]) if len(parts) > 2 else None
-            plugin_fragment = f'{plugin_type_name} {plugin_name!r}'
-
-        if collection and plugin_fragment:
-            plugin_fragment += ' in'
-
-        if collection == 'ansible.builtin':
-            collection_fragment = 'ansible-core'
-        elif collection:
-            collection_fragment = f'collection {collection!r}'
-        else:
-            collection_fragment = ''
-
-        if not collection:
-            when_fragment = 'in the future' if not removed else ''
-        elif date:
-            when_fragment = f'in a release after {date}'
-        elif version:
-            when_fragment = f'version {version}'
-        else:
-            when_fragment = 'in a future release' if not removed else ''
-
-        if plugin_fragment or collection_fragment:
-            from_fragment = 'from'
-        else:
-            from_fragment = ''
-
-        deprecation_msg = ' '.join(f for f in [removal_fragment, from_fragment, plugin_fragment, collection_fragment, when_fragment] if f) + '.'
-
-        return _join_sentences(msg, deprecation_msg)
-
     @staticmethod
     def _deduplicate(msg: str, messages: set[str]) -> bool:
         """
@@ -729,7 +672,7 @@ class Display(metaclass=Singleton):
         _skip_stackwalk = True
 
         if removed:
-            formatted_msg = self._get_deprecation_message_with_plugin_info(
+            formatted_msg = _display_utils.get_deprecation_message_with_plugin_info(
                 msg=msg,
                 version=version,
                 removed=removed,
@@ -756,7 +699,7 @@ class Display(metaclass=Singleton):
             deprecator=deprecator,
         )
 
-        if warning_ctx := _DeferredWarningContext.current(optional=True):
+        if warning_ctx := _display_utils.DeferredWarningContext.current(optional=True):
             warning_ctx.capture(deprecation)
             return
 
@@ -769,12 +712,12 @@ class Display(metaclass=Singleton):
         # This is the post-proxy half of the `deprecated` implementation.
         # Any logic that must occur in the primary controller process needs to be implemented here.
 
-        if not _DeferredWarningContext.deprecation_warnings_enabled():
+        if not _deprecation_warnings_enabled():
             return
 
         self.warning('Deprecation warnings can be disabled by setting `deprecation_warnings=False` in ansible.cfg.')
 
-        msg = _format_message(warning, _traceback.is_traceback_enabled(_traceback.TracebackEvent.DEPRECATED))
+        msg = _display_utils.format_message(warning, _traceback.is_traceback_enabled(_traceback.TracebackEvent.DEPRECATED))
         msg = f'[DEPRECATION WARNING]: {msg}'
 
         if self._deduplicate(msg, self._deprecations):
@@ -812,7 +755,7 @@ class Display(metaclass=Singleton):
             ),
         )
 
-        if warning_ctx := _DeferredWarningContext.current(optional=True):
+        if warning_ctx := _display_utils.DeferredWarningContext.current(optional=True):
             warning_ctx.capture(warning)
             return
 
@@ -825,7 +768,7 @@ class Display(metaclass=Singleton):
         # This is the post-proxy half of the `warning` implementation.
         # Any logic that must occur in the primary controller process needs to be implemented here.
 
-        msg = _format_message(warning, _traceback.is_traceback_enabled(_traceback.TracebackEvent.WARNING))
+        msg = _display_utils.format_message(warning, _traceback.is_traceback_enabled(_traceback.TracebackEvent.WARNING))
         msg = f"[WARNING]: {msg}"
 
         if self._deduplicate(msg, self._warns):
@@ -915,7 +858,7 @@ class Display(metaclass=Singleton):
             event=event,
         )
 
-        if warning_ctx := _DeferredWarningContext.current(optional=True):
+        if warning_ctx := _display_utils.DeferredWarningContext.current(optional=True):
             warning_ctx.capture(warning)
             return
 
@@ -952,7 +895,7 @@ class Display(metaclass=Singleton):
         # This is the post-proxy half of the `error` implementation.
         # Any logic that must occur in the primary controller process needs to be implemented here.
 
-        msg = _format_message(error, _traceback.is_traceback_enabled(_traceback.TracebackEvent.ERROR))
+        msg = _display_utils.format_message(error, _traceback.is_traceback_enabled(_traceback.TracebackEvent.ERROR))
         msg = f'[ERROR]: {msg}'
 
         if self._deduplicate(msg, self._errors):
@@ -1173,92 +1116,6 @@ class Display(metaclass=Singleton):
 _display = Display()
 
 
-class _DeferredWarningContext(_ambient_context.AmbientContextBase):
-    """
-    Calls to `Display.warning()` and `Display.deprecated()` within this context will cause the resulting warnings to be captured and not displayed.
-    The intended use is for task-initiated warnings to be recorded with the task result, which makes them visible to registered results, callbacks, etc.
-    The active display callback is responsible for communicating any warnings to the user.
-    """
-
-    # DTFIX-FUTURE: once we start implementing nested scoped contexts for our own bookkeeping, this should be an interface facade that forwards to the nearest
-    #               context that actually implements the warnings collection capability
-
-    def __init__(self, *, variables: dict[str, object]) -> None:
-        self._variables = variables  # DTFIX-FUTURE: move this to an AmbientContext-derived TaskContext (once it exists)
-        self._deprecation_warnings: list[_messages.DeprecationSummary] = []
-        self._warnings: list[_messages.WarningSummary] = []
-        self._seen: set[_messages.WarningSummary] = set()
-
-    @classmethod
-    def deprecation_warnings_enabled(cls) -> bool:
-        """Return True if deprecation warnings are enabled for the current calling context, otherwise False."""
-        # DTFIX-FUTURE: move this capability into config using an AmbientContext-derived TaskContext (once it exists)
-        if warning_ctx := cls.current(optional=True):
-            variables = warning_ctx._variables
-        else:
-            variables = None
-
-        return C.config.get_config_value('DEPRECATION_WARNINGS', variables=variables)
-
-    def capture(self, warning: _messages.WarningSummary) -> None:
-        """Add the warning/deprecation to the context if it has not already been seen by this context."""
-        if warning in self._seen:
-            return
-
-        self._seen.add(warning)
-
-        if isinstance(warning, _messages.DeprecationSummary):
-            self._deprecation_warnings.append(warning)
-        else:
-            self._warnings.append(warning)
-
-    def get_warnings(self) -> list[_messages.WarningSummary]:
-        """Return a list of the captured non-deprecation warnings."""
-        # DTFIX-FUTURE: return a read-only list proxy instead
-        return self._warnings
-
-    def get_deprecation_warnings(self) -> list[_messages.DeprecationSummary]:
-        """Return a list of the captured deprecation warnings."""
-        # DTFIX-FUTURE: return a read-only list proxy instead
-        return self._deprecation_warnings
-
-
-def _join_sentences(first: str | None, second: str | None) -> str:
-    """Join two sentences together."""
-    first = (first or '').strip()
-    second = (second or '').strip()
-
-    if first and first[-1] not in ('!', '?', '.'):
-        first += '.'
-
-    if second and second[-1] not in ('!', '?', '.'):
-        second += '.'
-
-    if first and not second:
-        return first
-
-    if not first and second:
-        return second
-
-    return ' '.join((first, second))
-
-
-def _format_message(summary: _messages.SummaryBase, include_traceback: bool) -> str:
-    if isinstance(summary, _messages.DeprecationSummary):
-        deprecation_message = _display._get_deprecation_message_with_plugin_info(
-            msg=summary.event.msg,
-            version=summary.version,
-            date=summary.date,
-            deprecator=summary.deprecator,
-        )
-
-        event = dataclasses.replace(summary.event, msg=deprecation_message)
-    else:
-        event = summary.event
-
-    return _event_formatting.format_event(event, include_traceback)
-
-
 def _report_config_warnings(deprecator: _messages.PluginInfo) -> None:
     """Called by config to report warnings/deprecations collected during a config parse."""
     while config._errors:
@@ -1284,3 +1141,7 @@ def _report_config_warnings(deprecator: _messages.PluginInfo) -> None:
 # emit any warnings or deprecations
 # in the event config fails before display is up, we'll lose warnings -- but that's OK, since everything is broken anyway
 _report_config_warnings(_deprecator.ANSIBLE_CORE_DEPRECATOR)
+
+
+def __getattr__(importable_name):
+    return _no_six.deprecate(importable_name, __name__, "text_type")

ansible/utils/encrypt.py

@@ -176,11 +176,6 @@ class PasslibHash(BaseHash):
         return to_text(result, errors='strict')
 
 
-def passlib_or_crypt(secret, algorithm, salt=None, salt_size=None, rounds=None, ident=None):
-    display.deprecated("passlib_or_crypt API is deprecated in favor of do_encrypt", version='2.20')
-    return do_encrypt(secret, algorithm, salt=salt, salt_size=salt_size, rounds=rounds, ident=ident)
-
-
 def do_encrypt(result, encrypt, salt_size=None, salt=None, ident=None, rounds=None):
     if PASSLIB_AVAILABLE:
         return PasslibHash(encrypt).hash(result, salt=salt, salt_size=salt_size, rounds=rounds, ident=ident)

ansible/utils/helpers.py

@@ -17,7 +17,7 @@
 
 from __future__ import annotations
 
-from ansible.module_utils.six import string_types
+from ansible.module_utils._internal import _no_six
 
 
 def pct_to_int(value, num_items, min_value=1):
@@ -25,7 +25,7 @@ def pct_to_int(value, num_items, min_value=1):
     Converts a given value to a percentage if specified as "x%",
     otherwise converts the given value to an integer.
     """
-    if isinstance(value, string_types) and value.endswith('%'):
+    if isinstance(value, str) and value.endswith('%'):
         value_pct = int(value.replace("%", ""))
         return int((value_pct / 100.0) * num_items) or min_value
     else:
@@ -47,3 +47,7 @@ def deduplicate_list(original_list):
     """
     seen = set()
     return [x for x in original_list if x not in seen and not seen.add(x)]
+
+
+def __getattr__(importable_name):
+    return _no_six.deprecate(importable_name, __name__, "string_types")

ansible/utils/jsonrpc.py

@@ -7,9 +7,9 @@ import json
 import pickle
 import traceback
 
+from ansible.module_utils._internal import _no_six
 from ansible.module_utils.common.text.converters import to_text
 from ansible.module_utils.connection import ConnectionError
-from ansible.module_utils.six import binary_type, text_type
 from ansible.utils.display import Display
 
 display = Display()
@@ -79,9 +79,9 @@ class JsonRpcServer(object):
 
     def response(self, result=None):
         response = self.header()
-        if isinstance(result, binary_type):
+        if isinstance(result, bytes):
             result = to_text(result)
-        if not isinstance(result, text_type):
+        if not isinstance(result, str):
             response["result_type"] = "pickle"
             result = to_text(pickle.dumps(result), errors='surrogateescape')
         response['result'] = result
@@ -110,3 +110,7 @@ class JsonRpcServer(object):
 
     def internal_error(self, data=None):
         return self.error(-32603, 'Internal error', data)
+
+
+def __getattr__(importable_name):
+    return _no_six.deprecate(importable_name, __name__, "binary_type", "text_type")