ansible-core 2.16.6__py3-none-any.whl → 2.17.0rc1__py3-none-any.whl

ansible_test/_util/controller/sanity/validate-modules/validate_modules/main.py

@@ -70,13 +70,12 @@ from ansible.module_utils.common.collections import is_iterable
 from ansible.module_utils.common.parameters import DEFAULT_TYPE_VALIDATORS
 from ansible.module_utils.compat.version import StrictVersion, LooseVersion
 from ansible.module_utils.basic import to_bytes
-from ansible.module_utils.six import PY3, with_metaclass, string_types
 from ansible.plugins.loader import fragment_loader
 from ansible.plugins.list import IGNORE as REJECTLIST
 from ansible.utils.plugin_docs import add_collection_to_versions_and_dates, add_fragments, get_docstring
 from ansible.utils.version import SemanticVersion
 
-from .module_args import AnsibleModuleImportError, AnsibleModuleNotInitialized, get_argument_spec
+from .module_args import AnsibleModuleImportError, AnsibleModuleNotInitialized, get_py_argument_spec, get_ps_argument_spec
 
 from .schema import (
     ansible_module_kwargs_schema,
@@ -87,18 +86,14 @@ from .schema import (
 from .utils import CaptureStd, NoArgsAnsibleModule, compare_unordered_lists, parse_yaml, parse_isodate
 
 
-if PY3:
-    # Because there is no ast.TryExcept in Python 3 ast module
-    TRY_EXCEPT = ast.Try
-    # REPLACER_WINDOWS from ansible.executor.module_common is byte
-    # string but we need unicode for Python 3
-    REPLACER_WINDOWS = REPLACER_WINDOWS.decode('utf-8')
-else:
-    TRY_EXCEPT = ast.TryExcept
+# Because there is no ast.TryExcept in Python 3 ast module
+TRY_EXCEPT = ast.Try
+# REPLACER_WINDOWS from ansible.executor.module_common is byte
+# string but we need unicode for Python 3
+REPLACER_WINDOWS = REPLACER_WINDOWS.decode('utf-8')
 
 REJECTLIST_DIRS = frozenset(('.git', 'test', '.github', '.idea'))
 INDENT_REGEX = re.compile(r'([\t]*)')
-TYPE_REGEX = re.compile(r'.*(if|or)(\s+[^"\']*|\s+)(?<!_)(?<!str\()type\([^)].*')
 SYS_EXIT_REGEX = re.compile(r'[^#]*sys.exit\s*\(.*')
 NO_LOG_REGEX = re.compile(r'(?:pass(?!ive)|secret|token|key)', re.I)
 
@@ -269,7 +264,7 @@ class Reporter:
         return 3 if sum(ret) else 0
 
 
-class Validator(with_metaclass(abc.ABCMeta, object)):
+class Validator(metaclass=abc.ABCMeta):
     """Validator instances are intended to be run on a single object.  if you
     are scanning multiple objects for problems, you'll want to have a separate
     Validator for each one."""
@@ -335,8 +330,6 @@ class ModuleValidator(Validator):
         self.git_cache = git_cache
         self.base_module = self.git_cache.get_original_path(self.path)
 
-        self._python_module_override = False
-
         with open(path) as f:
             self.text = f.read()
         self.length = len(self.text.splitlines())
@@ -383,7 +376,7 @@ class ModuleValidator(Validator):
         pass
 
     def _python_module(self):
-        if self.path.endswith('.py') or self._python_module_override:
+        if self.path.endswith('.py'):
             return True
         return False
 
@@ -421,7 +414,7 @@ class ModuleValidator(Validator):
         return self.git_cache.is_new(self.path)
 
     def _check_interpreter(self, powershell=False):
-        if powershell:
+        if self._powershell_module():
             if not self.text.startswith('#!powershell\n'):
                 self.reporter.error(
                     path=self.object_path,
@@ -430,34 +423,20 @@ class ModuleValidator(Validator):
                 )
             return
 
-        missing_python_interpreter = False
-
-        if not self.text.startswith('#!/usr/bin/python'):
-            if NEW_STYLE_PYTHON_MODULE_RE.search(to_bytes(self.text)):
-                missing_python_interpreter = self.text.startswith('#!')  # shebang optional, but if present must match
-            else:
-                missing_python_interpreter = True  # shebang required
+        if self._python_module():
+            missing_python_interpreter = False
 
-        if missing_python_interpreter:
-            self.reporter.error(
-                path=self.object_path,
-                code='missing-python-interpreter',
-                msg='Interpreter line is not "#!/usr/bin/python"',
-            )
+            if not self.text.startswith('#!/usr/bin/python'):
+                if NEW_STYLE_PYTHON_MODULE_RE.search(to_bytes(self.text)):
+                    missing_python_interpreter = self.text.startswith('#!')  # shebang optional, but if present must match
+                else:
+                    missing_python_interpreter = True  # shebang required
 
-    def _check_type_instead_of_isinstance(self, powershell=False):
-        if powershell:
-            return
-        for line_no, line in enumerate(self.text.splitlines()):
-            typekeyword = TYPE_REGEX.match(line)
-            if typekeyword:
-                # TODO: add column
+            if missing_python_interpreter:
                 self.reporter.error(
                     path=self.object_path,
-                    code='unidiomatic-typecheck',
-                    msg=('Type comparison using type() found. '
-                         'Use isinstance() instead'),
-                    line=line_no + 1
+                    code='missing-python-interpreter',
+                    msg='Interpreter line is not "#!/usr/bin/python"',
                 )
 
     def _check_for_sys_exit(self):
@@ -1120,14 +1099,6 @@ class ModuleValidator(Validator):
                         ' documentation for removed'
                 )
         else:
-            # We are testing a collection
-            if self.object_name.startswith('_'):
-                self.reporter.error(
-                    path=self.object_path,
-                    code='collections-no-underscore-on-deprecation',
-                    msg='Deprecated content in collections MUST NOT start with "_", update meta/runtime.yml instead',
-                )
-
             if not (doc_deprecated == routing_says_deprecated):
                 # DOCUMENTATION.deprecated and meta/runtime.yml disagree
                 self.reporter.error(
@@ -1193,7 +1164,7 @@ class ModuleValidator(Validator):
             for entry in object:
                 self._validate_semantic_markup(entry)
             return
-        if not isinstance(object, string_types):
+        if not isinstance(object, str):
             return
 
         if self.collection:
@@ -1312,7 +1283,12 @@ class ModuleValidator(Validator):
 
     def _validate_ansible_module_call(self, docs):
         try:
-            spec, kwargs = get_argument_spec(self.path, self.collection)
+            if self._python_module():
+                spec, kwargs = get_py_argument_spec(self.path, self.collection)
+            elif self._powershell_module():
+                spec, kwargs = get_ps_argument_spec(self.path, self.collection)
+            else:
+                raise NotImplementedError()
         except AnsibleModuleNotInitialized:
             self.reporter.error(
                 path=self.object_path,
@@ -1374,7 +1350,7 @@ class ModuleValidator(Validator):
                 continue
             bad_term = False
             for term in check:
-                if not isinstance(term, string_types):
+                if not isinstance(term, str):
                     msg = name
                     if context:
                         msg += " found in %s" % " -> ".join(context)
@@ -1442,7 +1418,7 @@ class ModuleValidator(Validator):
                 continue
             bad_term = False
             for term in requirements:
-                if not isinstance(term, string_types):
+                if not isinstance(term, str):
                     msg = "required_if"
                     if context:
                         msg += " found in %s" % " -> ".join(context)
@@ -1525,13 +1501,13 @@ class ModuleValidator(Validator):
             # This is already reported by schema checking
             return
         for key, value in terms.items():
-            if isinstance(value, string_types):
+            if isinstance(value, str):
                 value = [value]
             if not isinstance(value, (list, tuple)):
                 # This is already reported by schema checking
                 continue
             for term in value:
-                if not isinstance(term, string_types):
+                if not isinstance(term, str):
                     # This is already reported by schema checking
                     continue
             if len(set(value)) != len(value) or key in value:
@@ -2268,7 +2244,6 @@ class ModuleValidator(Validator):
                      'extension for python modules or a .ps1 '
                      'for powershell modules')
             )
-            self._python_module_override = True
 
         if self._python_module() and self.ast is None:
             self.reporter.error(
@@ -2380,10 +2355,7 @@ class ModuleValidator(Validator):
         self._check_gpl3_header()
         if not self._just_docs() and not self._sidecar_doc() and not end_of_deprecation_should_be_removed_only:
             if self.plugin_type == 'module':
-                self._check_interpreter(powershell=self._powershell_module())
-            self._check_type_instead_of_isinstance(
-                powershell=self._powershell_module()
-            )
+                self._check_interpreter()
 
 
 class PythonPackageValidator(Validator):

ansible_test/_util/controller/sanity/validate-modules/validate_modules/module_args.py

@@ -167,10 +167,3 @@ def get_py_argument_spec(filename, collection):
         return argument_spec, fake.kwargs
     except (TypeError, IndexError):
         return {}, {}
-
-
-def get_argument_spec(filename, collection):
-    if filename.endswith('.py'):
-        return get_py_argument_spec(filename, collection)
-    else:
-        return get_ps_argument_spec(filename, collection)

ansible_test/_util/controller/sanity/validate-modules/validate_modules/schema.py

@@ -297,6 +297,7 @@ def argument_spec_schema(for_collection):
                 [is_callable, list_string_types],
             ),
             'choices': Any([object], (object,)),
+            'context': dict,
             'required': bool,
             'no_log': bool,
             'aliases': Any(list_string_types, tuple(list_string_types)),
@@ -487,10 +488,17 @@ def check_option_choices(v):
         type_checker, type_name = get_type_checker({'type': v.get('elements')})
     else:
         type_checker, type_name = get_type_checker(v)
+
     if type_checker is None:
         return v
 
-    for value in v_choices:
+    if isinstance(v_choices, dict):
+        # choices are still a list (the keys) but dict form serves to document each choice.
+        iterate = v_choices.keys()
+    else:
+        iterate = v_choices
+
+    for value in iterate:
         try:
             type_checker(value)
         except Exception as exc:
@@ -542,7 +550,7 @@ def list_dict_option_schema(for_collection, plugin_type):
     basic_option_schema = {
         Required('description'): doc_string_or_strings,
         'required': bool,
-        'choices': list,
+        'choices': Any(list, {object: doc_string_or_strings}),
         'aliases': Any(list_string_types),
         'version_added': version(for_collection),
         'version_added_collection': collection_name,

ansible_test/_util/controller/sanity/validate-modules/validate_modules/utils.py

@@ -192,7 +192,7 @@ def compare_unordered_lists(a, b):
       - unordered lists
       - unhashable elements
     """
-    return len(a) == len(b) and all(x in b for x in a)
+    return len(a) == len(b) and all(x in b for x in a) and all(x in a for x in b)
 
 
 class NoArgsAnsibleModule(AnsibleModule):

ansible_test/_util/controller/sanity/yamllint/yamllinter.py

@@ -126,19 +126,31 @@ class YamlChecker:
                 yaml_data = yaml_data[1:]
                 lineno += 1
 
-            self.check_parsable(path, yaml_data, lineno)
+            multiple_docs_allowed = [
+                "EXAMPLES",
+            ]
+            self.check_parsable(path, yaml_data, lineno, (key in multiple_docs_allowed), key)
 
             messages = list(linter.run(yaml_data, conf, path))
 
             self.messages += [self.result_to_message(r, path, lineno - 1, key) for r in messages]
 
-    def check_parsable(self, path, contents, lineno=1):  # type: (str, str, int) -> None
+    def check_parsable(self, path, contents, lineno=1, allow_multiple=False, prefix=""):  # type: (str, str, int, bool) -> None
         """Check the given contents to verify they can be parsed as YAML."""
+        prefix = f"{prefix}: " if prefix else ""
         try:
-            yaml.load(contents, Loader=TestLoader)
+            documents = len(list(yaml.load_all(contents, Loader=TestLoader)))
+            if documents > 1 and not allow_multiple:
+                self.messages += [{'code': 'multiple-yaml-documents',
+                                   'message': f'{prefix}expected a single document in the stream',
+                                   'path': path,
+                                   'line': lineno,
+                                   'column': 1,
+                                   'level': 'error',
+                                   }]
         except MarkedYAMLError as ex:
             self.messages += [{'code': 'unparsable-with-libyaml',
-                               'message': '%s - %s' % (ex.args[0], ex.args[2]),
+                               'message': f'{prefix}{ex.args[0]} - {ex.args[2]}',
                                'path': path,
                                'line': ex.problem_mark.line + lineno,
                                'column': ex.problem_mark.column + 1,

ansible_test/_util/target/__init__.py

@@ -1,2 +1 @@
-# Empty __init__.py to allow importing of `ansible_test._util.target.common` under Python 2.x.
-# This allows the ansible-test entry point to report supported Python versions before exiting.
+# Empty __init__.py to keep pylint happy.

ansible_test/_util/target/cli/ansible_test_cli_stub.py

@@ -4,8 +4,7 @@
 
 # NOTE: This file resides in the _util/target directory to ensure compatibility with all supported Python versions.
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import sys

ansible_test/_util/target/common/constants.py

@@ -2,12 +2,9 @@
 
 # NOTE: This file resides in the _util/target directory to ensure compatibility with all supported Python versions.
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 REMOTE_ONLY_PYTHON_VERSIONS = (
-    '2.7',
-    '3.6',
     '3.7',
     '3.8',
     '3.9',

ansible_test/_util/target/injector/python.py

@@ -1,8 +1,8 @@
 # auto-shebang
 """Provides an entry point for python scripts and python modules on the controller with the current python interpreter and optional code coverage collection."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
+import importlib.util
 import os
 import sys
 
@@ -19,22 +19,7 @@ def main():
         if coverage_output:
             args += ['-m', 'coverage.__main__', 'run', '--rcfile', coverage_config]
         else:
-            if sys.version_info >= (3, 4):
-                # noinspection PyUnresolvedReferences
-                import importlib.util
-
-                # noinspection PyUnresolvedReferences
-                found = bool(importlib.util.find_spec('coverage'))
-            else:
-                # noinspection PyDeprecation
-                import imp
-
-                try:
-                    # noinspection PyDeprecation
-                    imp.find_module('coverage')
-                    found = True
-                except ImportError:
-                    found = False
+            found = bool(importlib.util.find_spec('coverage'))
 
             if not found:
                 sys.exit('ERROR: Could not find `coverage` module. '
@@ -62,7 +47,7 @@ def find_program(name, executable):  # type: (str, bool) -> str
     Raises an exception if the program is not found.
     """
     path = os.environ.get('PATH', os.path.defpath)
-    seen = set([os.path.abspath(__file__)])
+    seen = {os.path.abspath(__file__)}
     mode = os.F_OK | os.X_OK if executable else os.F_OK
 
     for base in path.split(os.path.pathsep):

ansible_test/_util/target/pytest/plugins/ansible_forked.py

@@ -4,21 +4,14 @@
 # https://github.com/pytest-dev/pytest-forked
 # https://github.com/pytest-dev/py
 # TIP: Disable pytest-xdist when debugging internal errors in this plugin.
-from __future__ import absolute_import, division, print_function
-
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import pickle
 import tempfile
 import warnings
 
-from pytest import Item, hookimpl
-
-try:
-    from pytest import TestReport
-except ImportError:
-    from _pytest.runner import TestReport  # Backwards compatibility with pytest < 7. Remove once Python 2.7 is not supported.
+from pytest import Item, hookimpl, TestReport
 
 from _pytest.runner import runtestprotocol
 

ansible_test/_util/target/pytest/plugins/ansible_pytest_collections.py

@@ -1,6 +1,5 @@
 """Enable unit testing of Ansible collections. PYTEST_DONT_REWRITE"""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 
@@ -39,9 +38,6 @@ def enable_assertion_rewriting_hook():  # type: () -> None
     """
     import sys
 
-    if sys.version_info[0] == 2:
-        return  # Python 2.x is not supported
-
     hook_name = '_pytest.assertion.rewrite.AssertionRewritingHook'
     hooks = [hook for hook in sys.meta_path if hook.__class__.__module__ + '.' + hook.__class__.__qualname__ == hook_name]
 

ansible_test/_util/target/pytest/plugins/ansible_pytest_coverage.py

@@ -1,6 +1,5 @@
 """Monkey patch os._exit when running under coverage so we don't lose coverage data in forks, such as with `pytest --boxed`. PYTEST_DONT_REWRITE"""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 
 def pytest_configure():

ansible_test/_util/target/sanity/compile/compile.py

@@ -1,12 +1,10 @@
 """Python syntax checker with lint friendly output."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import sys
 
 ENCODING = 'utf-8'
 ERRORS = 'replace'
-Text = type(u'')
 
 
 def main():
@@ -29,21 +27,14 @@ def compile_source(path):
     else:
         return
 
-    # In some situations offset can be None. This can happen for syntax errors on Python 2.6
-    # (__future__ import following after a regular import).
-    offset = offset or 0
-
     result = "%s:%d:%d: %s: %s" % (path, lineno, offset, extype.__name__, safe_message(message))
 
-    if sys.version_info <= (3,):
-        result = result.encode(ENCODING, ERRORS)
-
     print(result)
 
 
 def safe_message(value):
-    """Given an input value as text or bytes, return the first non-empty line as text, ensuring it can be round-tripped as UTF-8."""
-    if isinstance(value, Text):
+    """Given an input value as str or bytes, return the first non-empty line as str, ensuring it can be round-tripped as UTF-8."""
+    if isinstance(value, str):
         value = value.encode(ENCODING, ERRORS)
 
     value = value.decode(ENCODING, ERRORS)

ansible_test/_util/target/sanity/import/importer.py

@@ -1,6 +1,5 @@
 """Import the given python module(s) and report error(s) encountered."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 
 def main():
@@ -542,16 +541,6 @@ def main():
                     "ignore",
                     "AnsibleCollectionFinder has already been configured")
 
-            if sys.version_info[0] == 2:
-                warnings.filterwarnings(
-                    "ignore",
-                    "Python 2 is no longer supported by the Python core team. Support for it is now deprecated in cryptography,"
-                    " and will be removed in a future release.")
-                warnings.filterwarnings(
-                    "ignore",
-                    "Python 2 is no longer supported by the Python core team. Support for it is now deprecated in cryptography,"
-                    " and will be removed in the next release.")
-
             # ansible.utils.unsafe_proxy attempts patching sys.intern generating a warning if it was already patched
             warnings.filterwarnings(
                 "ignore",