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

ansible/parsing/yaml/dumper.py

@@ -1,124 +1,10 @@
-# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+from __future__ import annotations as _annotations
 
-from __future__ import annotations
+import typing as _t
 
-import yaml
+from ansible._internal._yaml import _dumper
 
-from ansible.module_utils.six import text_type, binary_type
-from ansible.module_utils.common.yaml import SafeDumper
-from ansible.parsing.yaml.objects import AnsibleUnicode, AnsibleSequence, AnsibleMapping, AnsibleVaultEncryptedUnicode
-from ansible.utils.unsafe_proxy import AnsibleUnsafeText, AnsibleUnsafeBytes, NativeJinjaUnsafeText, NativeJinjaText, _is_unsafe
-from ansible.template import AnsibleUndefined
-from ansible.vars.hostvars import HostVars, HostVarsVars
-from ansible.vars.manager import VarsWithSources
 
-
-class AnsibleDumper(SafeDumper):
-    '''
-    A simple stub class that allows us to add representers
-    for our overridden object types.
-    '''
-
-
-def represent_hostvars(self, data):
-    return self.represent_dict(dict(data))
-
-
-# Note: only want to represent the encrypted data
-def represent_vault_encrypted_unicode(self, data):
-    return self.represent_scalar(u'!vault', data._ciphertext.decode(), style='|')
-
-
-def represent_unicode(self, data):
-    if _is_unsafe(data):
-        data = data._strip_unsafe()
-    return yaml.representer.SafeRepresenter.represent_str(self, text_type(data))
-
-
-def represent_binary(self, data):
-    if _is_unsafe(data):
-        data = data._strip_unsafe()
-    return yaml.representer.SafeRepresenter.represent_binary(self, binary_type(data))
-
-
-def represent_undefined(self, data):
-    # Here bool will ensure _fail_with_undefined_error happens
-    # if the value is Undefined.
-    # This happens because Jinja sets __bool__ on StrictUndefined
-    return bool(data)
-
-
-AnsibleDumper.add_representer(
-    AnsibleUnicode,
-    represent_unicode,
-)
-
-AnsibleDumper.add_representer(
-    AnsibleUnsafeText,
-    represent_unicode,
-)
-
-AnsibleDumper.add_representer(
-    AnsibleUnsafeBytes,
-    represent_binary,
-)
-
-AnsibleDumper.add_representer(
-    HostVars,
-    represent_hostvars,
-)
-
-AnsibleDumper.add_representer(
-    HostVarsVars,
-    represent_hostvars,
-)
-
-AnsibleDumper.add_representer(
-    VarsWithSources,
-    represent_hostvars,
-)
-
-AnsibleDumper.add_representer(
-    AnsibleSequence,
-    yaml.representer.SafeRepresenter.represent_list,
-)
-
-AnsibleDumper.add_representer(
-    AnsibleMapping,
-    yaml.representer.SafeRepresenter.represent_dict,
-)
-
-AnsibleDumper.add_representer(
-    AnsibleVaultEncryptedUnicode,
-    represent_vault_encrypted_unicode,
-)
-
-AnsibleDumper.add_representer(
-    AnsibleUndefined,
-    represent_undefined,
-)
-
-AnsibleDumper.add_representer(
-    NativeJinjaUnsafeText,
-    represent_unicode,
-)
-
-AnsibleDumper.add_representer(
-    NativeJinjaText,
-    represent_unicode,
-)
+def AnsibleDumper(*args, **kwargs) -> _t.Any:
+    """Compatibility factory function; returns an Ansible YAML dumper instance."""
+    return _dumper.AnsibleDumper(*args, **kwargs)

ansible/parsing/yaml/loader.py

@@ -1,43 +1,10 @@
-# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+from __future__ import annotations as _annotations
 
-from __future__ import annotations
+import typing as _t
 
-from yaml.resolver import Resolver
+from ansible._internal._yaml import _loader
 
-from ansible.parsing.yaml.constructor import AnsibleConstructor
-from ansible.module_utils.common.yaml import HAS_LIBYAML, Parser
 
-if HAS_LIBYAML:
-    class AnsibleLoader(Parser, AnsibleConstructor, Resolver):  # type: ignore[misc] # pylint: disable=inconsistent-mro
-        def __init__(self, stream, file_name=None, vault_secrets=None):
-            Parser.__init__(self, stream)
-            AnsibleConstructor.__init__(self, file_name=file_name, vault_secrets=vault_secrets)
-            Resolver.__init__(self)
-else:
-    from yaml.composer import Composer
-    from yaml.reader import Reader
-    from yaml.scanner import Scanner
-
-    class AnsibleLoader(Reader, Scanner, Parser, Composer, AnsibleConstructor, Resolver):  # type: ignore[misc,no-redef]  # pylint: disable=inconsistent-mro
-        def __init__(self, stream, file_name=None, vault_secrets=None):
-            Reader.__init__(self, stream)
-            Scanner.__init__(self)
-            Parser.__init__(self)
-            Composer.__init__(self)
-            AnsibleConstructor.__init__(self, file_name=file_name, vault_secrets=vault_secrets)
-            Resolver.__init__(self)
+def AnsibleLoader(*args, **kwargs) -> _t.Any:
+    """Compatibility factory function; returns an Ansible YAML loader instance."""
+    return _loader.AnsibleLoader(*args, **kwargs)

ansible/parsing/yaml/objects.py

@@ -1,359 +1,67 @@
-# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+"""Backwards compatibility types, which will be deprecated a future release. Do not use these in new code."""
 
-from __future__ import annotations
+from __future__ import annotations as _annotations
 
-import sys as _sys
+import typing as _t
 
-from collections.abc import Sequence
+from ansible.module_utils._internal import _datatag
+from ansible.module_utils.common.text import converters as _converters
+from ansible.parsing import vault as _vault
 
-from ansible.module_utils.six import text_type
-from ansible.module_utils.common.text.converters import to_bytes, to_text, to_native
+_UNSET = _t.cast(_t.Any, object())
 
 
-class AnsibleBaseYAMLObject(object):
-    '''
-    the base class used to sub-class python built-in objects
-    so that we can add attributes to them during yaml parsing
+class _AnsibleMapping(dict):
+    """Backwards compatibility type."""
 
-    '''
-    _data_source = None
-    _line_number = 0
-    _column_number = 0
+    def __new__(cls, value=_UNSET, /, **kwargs):
+        if value is _UNSET:
+            return dict(**kwargs)
 
-    def _get_ansible_position(self):
-        return (self._data_source, self._line_number, self._column_number)
+        return _datatag.AnsibleTagHelper.tag_copy(value, dict(value, **kwargs))
 
-    def _set_ansible_position(self, obj):
-        try:
-            (src, line, col) = obj
-        except (TypeError, ValueError):
-            raise AssertionError(
-                'ansible_pos can only be set with a tuple/list '
-                'of three values: source, line number, column number'
-            )
-        self._data_source = src
-        self._line_number = line
-        self._column_number = col
 
-    ansible_pos = property(_get_ansible_position, _set_ansible_position)
+class _AnsibleUnicode(str):
+    """Backwards compatibility type."""
 
+    def __new__(cls, object=_UNSET, **kwargs):
+        if object is _UNSET:
+            return str(**kwargs)
 
-class AnsibleMapping(AnsibleBaseYAMLObject, dict):
-    ''' sub class for dictionaries '''
-    pass
+        return _datatag.AnsibleTagHelper.tag_copy(object, str(object, **kwargs))
 
 
-class AnsibleUnicode(AnsibleBaseYAMLObject, text_type):
-    ''' sub class for unicode objects '''
-    pass
+class _AnsibleSequence(list):
+    """Backwards compatibility type."""
 
+    def __new__(cls, value=_UNSET, /):
+        if value is _UNSET:
+            return list()
 
-class AnsibleSequence(AnsibleBaseYAMLObject, list):
-    ''' sub class for lists '''
-    pass
+        return _datatag.AnsibleTagHelper.tag_copy(value, list(value))
 
 
-class AnsibleVaultEncryptedUnicode(Sequence, AnsibleBaseYAMLObject):
-    '''Unicode like object that is not evaluated (decrypted) until it needs to be'''
-    __UNSAFE__ = True
-    __ENCRYPTED__ = True
-    yaml_tag = u'!vault'
+class _AnsibleVaultEncryptedUnicode:
+    """Backwards compatibility type."""
 
-    @classmethod
-    def from_plaintext(cls, seq, vault, secret):
-        if not vault:
-            raise vault.AnsibleVaultError('Error creating AnsibleVaultEncryptedUnicode, invalid vault (%s) provided' % vault)
+    def __new__(cls, ciphertext: str | bytes):
+        encrypted_string = _vault.EncryptedString(ciphertext=_converters.to_text(_datatag.AnsibleTagHelper.untag(ciphertext)))
 
-        ciphertext = vault.encrypt(seq, secret)
-        avu = cls(ciphertext)
-        avu.vault = vault
-        return avu
+        return _datatag.AnsibleTagHelper.tag_copy(ciphertext, encrypted_string)
 
-    def __init__(self, ciphertext):
-        '''A AnsibleUnicode with a Vault attribute that can decrypt it.
 
-        ciphertext is a byte string (str on PY2, bytestring on PY3).
+def __getattr__(name: str) -> _t.Any:
+    """Inject import-time deprecation warnings."""
+    if (value := globals().get(f'_{name}', None)) and name.startswith('Ansible'):
+        # deprecated: description='enable deprecation of everything in this module', core_version='2.23'
+        # from ansible.utils.display import Display
+        #
+        # Display().deprecated(
+        #     msg=f"Importing {name!r} is deprecated.",
+        #     help_text="Instances of this type cannot be created and will not be encountered.",
+        #     version="2.27",
+        # )
 
-        The .data attribute is a property that returns the decrypted plaintext
-        of the ciphertext as a PY2 unicode or PY3 string object.
-        '''
-        super(AnsibleVaultEncryptedUnicode, self).__init__()
+        return value
 
-        # after construction, calling code has to set the .vault attribute to a vaultlib object
-        self.vault = None
-        self._ciphertext = to_bytes(ciphertext)
-
-    @property
-    def data(self):
-        if not self.vault:
-            return to_text(self._ciphertext)
-        return to_text(self.vault.decrypt(self._ciphertext, obj=self))
-
-    @data.setter
-    def data(self, value):
-        self._ciphertext = to_bytes(value)
-
-    def is_encrypted(self):
-        return self.vault and self.vault.is_encrypted(self._ciphertext)
-
-    def __eq__(self, other):
-        if self.vault:
-            return other == self.data
-        return False
-
-    def __ne__(self, other):
-        if self.vault:
-            return other != self.data
-        return True
-
-    def __reversed__(self):
-        # This gets inherited from ``collections.Sequence`` which returns a generator
-        # make this act more like the string implementation
-        return to_text(self[::-1], errors='surrogate_or_strict')
-
-    def __str__(self):
-        return to_native(self.data, errors='surrogate_or_strict')
-
-    def __unicode__(self):
-        return to_text(self.data, errors='surrogate_or_strict')
-
-    def encode(self, encoding=None, errors=None):
-        return to_bytes(self.data, encoding=encoding, errors=errors)
-
-    # Methods below are a copy from ``collections.UserString``
-    # Some are copied as is, where others are modified to not
-    # auto wrap with ``self.__class__``
-    def __repr__(self):
-        return repr(self.data)
-
-    def __int__(self, base=10):
-        return int(self.data, base=base)
-
-    def __float__(self):
-        return float(self.data)
-
-    def __complex__(self):
-        return complex(self.data)
-
-    def __hash__(self):
-        return hash(self.data)
-
-    # This breaks vault, do not define it, we cannot satisfy this
-    # def __getnewargs__(self):
-    #    return (self.data[:],)
-
-    def __lt__(self, string):
-        if isinstance(string, AnsibleVaultEncryptedUnicode):
-            return self.data < string.data
-        return self.data < string
-
-    def __le__(self, string):
-        if isinstance(string, AnsibleVaultEncryptedUnicode):
-            return self.data <= string.data
-        return self.data <= string
-
-    def __gt__(self, string):
-        if isinstance(string, AnsibleVaultEncryptedUnicode):
-            return self.data > string.data
-        return self.data > string
-
-    def __ge__(self, string):
-        if isinstance(string, AnsibleVaultEncryptedUnicode):
-            return self.data >= string.data
-        return self.data >= string
-
-    def __contains__(self, char):
-        if isinstance(char, AnsibleVaultEncryptedUnicode):
-            char = char.data
-        return char in self.data
-
-    def __len__(self):
-        return len(self.data)
-
-    def __getitem__(self, index):
-        return self.data[index]
-
-    def __getslice__(self, start, end):
-        start = max(start, 0)
-        end = max(end, 0)
-        return self.data[start:end]
-
-    def __add__(self, other):
-        if isinstance(other, AnsibleVaultEncryptedUnicode):
-            return self.data + other.data
-        elif isinstance(other, text_type):
-            return self.data + other
-        return self.data + to_text(other)
-
-    def __radd__(self, other):
-        if isinstance(other, text_type):
-            return other + self.data
-        return to_text(other) + self.data
-
-    def __mul__(self, n):
-        return self.data * n
-
-    __rmul__ = __mul__
-
-    def __mod__(self, args):
-        return self.data % args
-
-    def __rmod__(self, template):
-        return to_text(template) % self
-
-    # the following methods are defined in alphabetical order:
-    def capitalize(self):
-        return self.data.capitalize()
-
-    def casefold(self):
-        return self.data.casefold()
-
-    def center(self, width, *args):
-        return self.data.center(width, *args)
-
-    def count(self, sub, start=0, end=_sys.maxsize):
-        if isinstance(sub, AnsibleVaultEncryptedUnicode):
-            sub = sub.data
-        return self.data.count(sub, start, end)
-
-    def endswith(self, suffix, start=0, end=_sys.maxsize):
-        return self.data.endswith(suffix, start, end)
-
-    def expandtabs(self, tabsize=8):
-        return self.data.expandtabs(tabsize)
-
-    def find(self, sub, start=0, end=_sys.maxsize):
-        if isinstance(sub, AnsibleVaultEncryptedUnicode):
-            sub = sub.data
-        return self.data.find(sub, start, end)
-
-    def format(self, *args, **kwds):
-        return self.data.format(*args, **kwds)
-
-    def format_map(self, mapping):
-        return self.data.format_map(mapping)
-
-    def index(self, sub, start=0, end=_sys.maxsize):
-        return self.data.index(sub, start, end)
-
-    def isalpha(self):
-        return self.data.isalpha()
-
-    def isalnum(self):
-        return self.data.isalnum()
-
-    def isascii(self):
-        return self.data.isascii()
-
-    def isdecimal(self):
-        return self.data.isdecimal()
-
-    def isdigit(self):
-        return self.data.isdigit()
-
-    def isidentifier(self):
-        return self.data.isidentifier()
-
-    def islower(self):
-        return self.data.islower()
-
-    def isnumeric(self):
-        return self.data.isnumeric()
-
-    def isprintable(self):
-        return self.data.isprintable()
-
-    def isspace(self):
-        return self.data.isspace()
-
-    def istitle(self):
-        return self.data.istitle()
-
-    def isupper(self):
-        return self.data.isupper()
-
-    def join(self, seq):
-        return self.data.join(seq)
-
-    def ljust(self, width, *args):
-        return self.data.ljust(width, *args)
-
-    def lower(self):
-        return self.data.lower()
-
-    def lstrip(self, chars=None):
-        return self.data.lstrip(chars)
-
-    maketrans = str.maketrans
-
-    def partition(self, sep):
-        return self.data.partition(sep)
-
-    def replace(self, old, new, maxsplit=-1):
-        if isinstance(old, AnsibleVaultEncryptedUnicode):
-            old = old.data
-        if isinstance(new, AnsibleVaultEncryptedUnicode):
-            new = new.data
-        return self.data.replace(old, new, maxsplit)
-
-    def rfind(self, sub, start=0, end=_sys.maxsize):
-        if isinstance(sub, AnsibleVaultEncryptedUnicode):
-            sub = sub.data
-        return self.data.rfind(sub, start, end)
-
-    def rindex(self, sub, start=0, end=_sys.maxsize):
-        return self.data.rindex(sub, start, end)
-
-    def rjust(self, width, *args):
-        return self.data.rjust(width, *args)
-
-    def rpartition(self, sep):
-        return self.data.rpartition(sep)
-
-    def rstrip(self, chars=None):
-        return self.data.rstrip(chars)
-
-    def split(self, sep=None, maxsplit=-1):
-        return self.data.split(sep, maxsplit)
-
-    def rsplit(self, sep=None, maxsplit=-1):
-        return self.data.rsplit(sep, maxsplit)
-
-    def splitlines(self, keepends=False):
-        return self.data.splitlines(keepends)
-
-    def startswith(self, prefix, start=0, end=_sys.maxsize):
-        return self.data.startswith(prefix, start, end)
-
-    def strip(self, chars=None):
-        return self.data.strip(chars)
-
-    def swapcase(self):
-        return self.data.swapcase()
-
-    def title(self):
-        return self.data.title()
-
-    def translate(self, *args):
-        return self.data.translate(*args)
-
-    def upper(self):
-        return self.data.upper()
-
-    def zfill(self, width):
-        return self.data.zfill(width)
+    raise AttributeError(f'module {__name__!r} has no attribute {name!r}')

ansible/playbook/__init__.py

@@ -66,7 +66,7 @@ class Playbook:
         self._file_name = file_name
 
         try:
-            ds = self._loader.load_from_file(os.path.basename(file_name))
+            ds = self._loader.load_from_file(os.path.basename(file_name), trusted_as_template=True)
         except UnicodeDecodeError as e:
             raise AnsibleParserError("Could not read playbook (%s) due to encoding issues: %s" % (file_name, to_native(e)))
 

ansible/playbook/attribute.py

@@ -17,8 +17,13 @@
 
 from __future__ import annotations
 
+import typing as t
+
 from ansible.utils.sentinel import Sentinel
 
+if t.TYPE_CHECKING:
+    from ansible.playbook.base import FieldAttributeBase
+
 _CONTAINERS = frozenset(('list', 'dict', 'set'))
 
 
@@ -105,7 +110,7 @@ class Attribute:
     def __ge__(self, other):
         return other.priority >= self.priority
 
-    def __get__(self, obj, obj_type=None):
+    def __get__(self, obj: FieldAttributeBase, obj_type=None):
         method = f'_get_attr_{self.name}'
         if hasattr(obj, method):
             # NOTE this appears to be not used in the codebase,
@@ -127,7 +132,7 @@ class Attribute:
 
         return value
 
-    def __set__(self, obj, value):
+    def __set__(self, obj: FieldAttributeBase, value):
         setattr(obj, f'_{self.name}', value)
         if self.alias is not None:
             setattr(obj, f'_{self.alias}', value)
@@ -180,7 +185,7 @@ class FieldAttribute(Attribute):
 
 class ConnectionFieldAttribute(FieldAttribute):
     def __get__(self, obj, obj_type=None):
-        from ansible.module_utils.compat.paramiko import paramiko
+        from ansible.module_utils.compat.paramiko import _paramiko as paramiko
         from ansible.utils.ssh_functions import check_for_controlpersist
         value = super().__get__(obj, obj_type)