ansible-core 2.16.5__py3-none-any.whl → 2.17.0b1__py3-none-any.whl

ansible/module_utils/common/file.py

@@ -1,8 +1,7 @@
 # Copyright (c) 2018, Ansible Project
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import stat
@@ -45,9 +44,15 @@ USERS_RE = re.compile(r'[^ugo]')
 PERMS_RE = re.compile(r'[^rwxXstugo]')
 
 
-_PERM_BITS = 0o7777          # file mode permission bits
-_EXEC_PERM_BITS = 0o0111     # execute permission bits
-_DEFAULT_PERM = 0o0666       # default file permission bits
+S_IRANY = 0o0444  # read by user, group, others
+S_IWANY = 0o0222  # write by user, group, others
+S_IXANY = 0o0111  # execute by user, group, others
+S_IRWU_RWG_RWO = S_IRANY | S_IWANY  # read, write by user, group, others
+S_IRWU_RG_RO = S_IRANY | stat.S_IWUSR  # read by user, group, others and write only by user
+S_IRWXU_RXG_RXO = S_IRANY | S_IXANY | stat.S_IWUSR  # read, execute by user, group, others and write only by user
+_PERM_BITS = 0o7777             # file mode permission bits
+_EXEC_PERM_BITS = S_IXANY       # execute permission bits
+_DEFAULT_PERM = S_IRWU_RWG_RWO  # default file permission bits
 
 
 def is_executable(path):

ansible/module_utils/common/json.py

@@ -2,9 +2,7 @@
 # Copyright (c) 2019 Ansible Project
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import json
 

ansible/module_utils/common/locale.py

@@ -1,8 +1,7 @@
 # Copyright (c), Ansible Project
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
+from __future__ import annotations
 
 from ansible.module_utils.common.text.converters import to_native
 

ansible/module_utils/common/network.py

@@ -3,8 +3,7 @@
 
 # General networking tools that may be used by all modules
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 from struct import pack
@@ -62,7 +61,7 @@ def to_masklen(val):
 
 
 def to_subnet(addr, mask, dotted_notation=False):
-    """ coverts an addr / mask pair to a subnet in cidr notation """
+    """ converts an addr / mask pair to a subnet in cidr notation """
     try:
         if not is_masklen(mask):
             raise ValueError

ansible/module_utils/common/parameters.py

@@ -2,8 +2,7 @@
 # Copyright (c) 2019 Ansible Project
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
+from __future__ import annotations
 
 import datetime
 import os
@@ -83,14 +82,17 @@ _ADDITIONAL_CHECKS = (
 
 # if adding boolean attribute, also add to PASS_BOOL
 # some of this dupes defaults from controller config
+# keep in sync with copy in lib/ansible/module_utils/csharp/Ansible.Basic.cs
 PASS_VARS = {
     'check_mode': ('check_mode', False),
     'debug': ('_debug', False),
     'diff': ('_diff', False),
     'keep_remote_files': ('_keep_remote_files', False),
+    'ignore_unknown_opts': ('_ignore_unknown_opts', False),
     'module_name': ('_name', None),
     'no_log': ('no_log', False),
     'remote_tmp': ('_remote_tmp', None),
+    'target_log_info': ('_target_log_info', None),
     'selinux_special_fs': ('_selinux_special_fs', ['fuse', 'nfs', 'vboxsf', 'ramfs', '9p', 'vfat']),
     'shell_executable': ('_shell', '/bin/sh'),
     'socket': ('_socket_path', None),
@@ -101,7 +103,7 @@ PASS_VARS = {
     'version': ('ansible_version', '0.0'),
 }
 
-PASS_BOOLS = ('check_mode', 'debug', 'diff', 'keep_remote_files', 'no_log')
+PASS_BOOLS = ('check_mode', 'debug', 'diff', 'keep_remote_files', 'ignore_unknown_opts', 'no_log')
 
 DEFAULT_TYPE_VALIDATORS = {
     'str': check_type_str,
@@ -345,7 +347,7 @@ def _list_no_log_values(argument_spec, params):
                             sub_param = check_type_dict(sub_param)
 
                         if not isinstance(sub_param, Mapping):
-                            raise TypeError("Value '{1}' in the sub parameter field '{0}' must by a {2}, "
+                            raise TypeError("Value '{1}' in the sub parameter field '{0}' must be a {2}, "
                                             "not '{1.__class__.__name__}'".format(arg_name, sub_param, wanted_type))
 
                         no_log_values.update(_list_no_log_values(sub_argument_spec, sub_param))
@@ -363,12 +365,10 @@ def _return_datastructure_name(obj):
         return
     elif isinstance(obj, Mapping):
         for element in obj.items():
-            for subelement in _return_datastructure_name(element[1]):
-                yield subelement
+            yield from _return_datastructure_name(element[1])
     elif is_iterable(obj):
         for element in obj:
-            for subelement in _return_datastructure_name(element):
-                yield subelement
+            yield from _return_datastructure_name(element)
     elif obj is None or isinstance(obj, bool):
         # This must come before int because bools are also ints
         return
@@ -663,7 +663,7 @@ def _validate_argument_values(argument_spec, parameters, options_context=None, e
                     diff_list = [item for item in parameters[param] if item not in choices]
                     if diff_list:
                         choices_str = ", ".join([to_native(c) for c in choices])
-                        diff_str = ", ".join(diff_list)
+                        diff_str = ", ".join([to_native(c) for c in diff_list])
                         msg = "value of %s must be one or more of: %s. Got no match for: %s" % (param, choices_str, diff_str)
                         if options_context:
                             msg = "{0} found in {1}".format(msg, " -> ".join(options_context))

ansible/module_utils/common/process.py

@@ -1,25 +1,32 @@
 # Copyright (c) 2018, Ansible Project
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 
 from ansible.module_utils.common.file import is_executable
+from ansible.module_utils.common.warnings import deprecate
 
 
 def get_bin_path(arg, opt_dirs=None, required=None):
     '''
-    Find system executable in PATH. Raises ValueError if executable is not found.
+    Find system executable in PATH. Raises ValueError if the executable is not found.
     Optional arguments:
-       - required:  [Deprecated] Prior to 2.10, if executable is not found and required is true it raises an Exception.
-                    In 2.10 and later, an Exception is always raised. This parameter will be removed in 2.14.
+       - required:  [Deprecated] Before 2.10, if executable is not found and required is true it raises an Exception.
+                    In 2.10 and later, an Exception is always raised. This parameter will be removed in 2.21.
        - opt_dirs:  optional list of directories to search in addition to PATH
     In addition to PATH and opt_dirs, this function also looks through /sbin, /usr/sbin and /usr/local/sbin. A lot of
     modules, especially for gathering facts, depend on this behaviour.
     If found return full path, otherwise raise ValueError.
     '''
+    if required is not None:
+        deprecate(
+            msg="The `required` parameter in `get_bin_path` API is deprecated.",
+            version="2.21",
+            collection_name="ansible.builtin",
+        )
+
     opt_dirs = [] if opt_dirs is None else opt_dirs
 
     sbin_paths = ['/sbin', '/usr/sbin', '/usr/local/sbin']

ansible/module_utils/common/respawn.py

@@ -1,8 +1,7 @@
 # Copyright: (c) 2021, Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import subprocess
@@ -20,7 +19,7 @@ def respawn_module(interpreter_path):
     Respawn the currently-running Ansible Python module under the specified Python interpreter.
 
     Ansible modules that require libraries that are typically available only under well-known interpreters
-    (eg, ``yum``, ``apt``, ``dnf``) can use bespoke logic to determine the libraries they need are not
+    (eg, ``apt``, ``dnf``) can use bespoke logic to determine the libraries they need are not
     available, then call `respawn_module` to re-execute the current module under a different interpreter
     and exit the current process when the new subprocess has completed. The respawned process inherits only
     stdout/stderr from the current process.

ansible/module_utils/common/sys_info.py

@@ -2,8 +2,7 @@
 # Copyright (c), Toshio Kuratomi <tkuratomi@ansible.com> 2016
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
+from __future__ import annotations
 
 import platform
 

ansible/module_utils/common/text/converters.py

@@ -3,8 +3,7 @@
 # (c) 2016 Toshio Kuratomi <tkuratomi@ansible.com>
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
+from __future__ import annotations
 
 import codecs
 import datetime

ansible/module_utils/common/text/formatters.py

@@ -2,8 +2,7 @@
 # Copyright (c) 2019 Ansible Project
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 

ansible/module_utils/common/validation.py

@@ -2,15 +2,14 @@
 # Copyright (c) 2019 Ansible Project
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
+from __future__ import annotations
 
+import json
 import os
 import re
 
 from ast import literal_eval
 from ansible.module_utils.common.text.converters import to_native
-from ansible.module_utils.common._json_compat import json
 from ansible.module_utils.common.collections import is_iterable
 from ansible.module_utils.common.text.converters import jsonify
 from ansible.module_utils.common.text.formatters import human_to_bytes
@@ -543,7 +542,7 @@ def check_type_raw(value):
 def check_type_bytes(value):
     """Convert a human-readable string value to bytes
 
-    Raises :class:`TypeError` if unable to covert the value
+    Raises :class:`TypeError` if unable to convert the value
     """
     try:
         return human_to_bytes(value)
@@ -556,7 +555,7 @@ def check_type_bits(value):
 
     Example: ``check_type_bits('1Mb')`` returns integer 1048576.
 
-    Raises :class:`TypeError` if unable to covert the value.
+    Raises :class:`TypeError` if unable to convert the value.
     """
     try:
         return human_to_bytes(value, isbits=True)
@@ -568,7 +567,7 @@ def check_type_jsonarg(value):
     """Return a jsonified string. Sometimes the controller turns a json string
     into a dict/list so transform it back into json here
 
-    Raises :class:`TypeError` if unable to covert the value
+    Raises :class:`TypeError` if unable to convert the value
 
     """
     if isinstance(value, (text_type, binary_type)):

ansible/module_utils/common/warnings.py

@@ -2,8 +2,7 @@
 # Copyright (c) 2019 Ansible Project
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
+from __future__ import annotations
 
 from ansible.module_utils.six import string_types
 

ansible/module_utils/common/yaml.py

@@ -6,8 +6,7 @@ This file provides ease of use shortcuts for loading and dumping YAML,
 preferring the YAML compiled C extensions to reduce duplicated code.
 """
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 from functools import partial as _partial
 

ansible/module_utils/compat/datetime.py

@@ -1,9 +1,7 @@
 # Copyright (c) 2023 Ansible
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 from ansible.module_utils.six import PY3
 

ansible/module_utils/compat/importlib.py

@@ -1,18 +1,26 @@
 # Copyright (c) 2020 Matt Martz <matt@sivel.net>
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
-import sys
+from ansible.module_utils.common.warnings import deprecate
 
-try:
-    from importlib import import_module  # pylint: disable=unused-import
-except ImportError:
-    # importlib.import_module returns the tail
-    # whereas __import__ returns the head
-    # compat to work like importlib.import_module
-    def import_module(name):  # type: ignore[misc]
-        __import__(name)
-        return sys.modules[name]
+
+def __getattr__(importable_name):
+    """Inject import-time deprecation warnings.
+
+    Specifically, for ``import_module()``.
+    """
+    if importable_name == 'import_module':
+        deprecate(
+            msg=f'The `ansible.module_utils.compat.importlib.'
+            f'{importable_name}` function is deprecated.',
+            version='2.19',
+        )
+        from importlib import import_module
+        return import_module
+
+    raise AttributeError(
+        f'cannot import name {importable_name !r} '
+        f'has no attribute ({__file__ !s})',
+    )

ansible/module_utils/compat/paramiko.py

@@ -2,8 +2,7 @@
 # Copyright (c) 2019 Ansible Project
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
+from __future__ import annotations
 
 import types  # pylint: disable=unused-import
 import warnings

ansible/module_utils/compat/selectors.py

@@ -15,42 +15,18 @@
 # You should have received a copy of the GNU General Public License
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-'''
-Compat selectors library.  Python-3.5 has this builtin.  The selectors2
-package exists on pypi to backport the functionality as far as python-2.6.
-'''
-# The following makes it easier for us to script updates of the bundled code
-_BUNDLED_METADATA = {"pypi_name": "selectors2", "version": "1.1.1", "version_constraints": ">1.0,<2.0"}
-
-# Added these bugfix commits from 2.1.0:
-# * https://github.com/SethMichaelLarson/selectors2/commit/3bd74f2033363b606e1e849528ccaa76f5067590
-#   Wrap kqueue.control so that timeout is a keyword arg
-# * https://github.com/SethMichaelLarson/selectors2/commit/6f6a26f42086d8aab273b30be492beecb373646b
-#   Fix formatting of the kqueue.control patch for pylint
-# * https://github.com/SethMichaelLarson/selectors2/commit/f0c2c6c66cfa7662bc52beaf4e2d65adfa25e189
-#   Fix use of OSError exception for py3 and use the wrapper of kqueue.control so retries of
-#   interrupted syscalls work with kqueue
+from __future__ import annotations
 
+import selectors
 import sys
-import types  # pylint: disable=unused-import
 
-try:
-    # Python 3.4+
-    import selectors as _system_selectors
-except ImportError:
-    try:
-        # backport package installed in the system
-        import selectors2 as _system_selectors  # type: ignore[no-redef]
-    except ImportError:
-        _system_selectors = None  # type: types.ModuleType | None  # type: ignore[no-redef]
+from ansible.module_utils.common.warnings import deprecate
+
 
-if _system_selectors:
-    selectors = _system_selectors
-else:
-    # Our bundled copy
-    from ansible.module_utils.compat import _selectors2 as selectors  # type: ignore[no-redef]
 sys.modules['ansible.module_utils.compat.selectors'] = selectors
+
+
+deprecate(
+    msg='The `ansible.module_utils.compat.selectors` module is deprecated.',
+    version='2.19',
+)

ansible/module_utils/compat/selinux.py

@@ -1,8 +1,7 @@
 # Copyright: (c) 2021, Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import sys

ansible/module_utils/compat/typing.py

@@ -1,6 +1,5 @@
 """Compatibility layer for the `typing` module, providing all Python versions access to the newest type-hinting features."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 # pylint: disable=wildcard-import,unused-wildcard-import
 

ansible/module_utils/compat/version.py

@@ -25,8 +25,7 @@ Every version number class implements the following interface:
     of the same class, thus must follow the same rules)
 """
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 

ansible/module_utils/connection.py

@@ -26,8 +26,7 @@
 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 # USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import hashlib

ansible/module_utils/csharp/Ansible.Basic.cs

@@ -49,6 +49,7 @@ namespace Ansible.Basic
         private static List<string> BOOLEANS_TRUE = new List<string>() { "y", "yes", "on", "1", "true", "t", "1.0" };
         private static List<string> BOOLEANS_FALSE = new List<string>() { "n", "no", "off", "0", "false", "f", "0.0" };
 
+        private bool ignoreUnknownOpts = false;
         private string remoteTmp = Path.GetTempPath();
         private string tmpdir = null;
         private HashSet<string> noLogValues = new HashSet<string>();
@@ -60,10 +61,12 @@ namespace Ansible.Basic
         private Dictionary<string, string> passVars = new Dictionary<string, string>()
         {
             // null values means no mapping, not used in Ansible.Basic.AnsibleModule
+            // keep in sync with python counterpart in lib/ansible/module_utils/common/parameters.py
             { "check_mode", "CheckMode" },
             { "debug", "DebugMode" },
             { "diff", "DiffMode" },
             { "keep_remote_files", "KeepRemoteFiles" },
+            { "ignore_unknown_opts", "ignoreUnknownOpts" },
             { "module_name", "ModuleName" },
             { "no_log", "NoLog" },
             { "remote_tmp", "remoteTmp" },
@@ -72,11 +75,12 @@ namespace Ansible.Basic
             { "socket", null },
             { "string_conversion_action", null },
             { "syslog_facility", null },
+            { "target_log_info", "TargetLogInfo"},
             { "tmpdir", "tmpdir" },
             { "verbosity", "Verbosity" },
             { "version", "AnsibleVersion" },
         };
-        private List<string> passBools = new List<string>() { "check_mode", "debug", "diff", "keep_remote_files", "no_log" };
+        private List<string> passBools = new List<string>() { "check_mode", "debug", "diff", "keep_remote_files", "ignore_unknown_opts", "no_log" };
         private List<string> passInts = new List<string>() { "verbosity" };
         private Dictionary<string, List<object>> specDefaults = new Dictionary<string, List<object>>()
         {
@@ -125,6 +129,7 @@ namespace Ansible.Basic
         public bool KeepRemoteFiles { get; private set; }
         public string ModuleName { get; private set; }
         public bool NoLog { get; private set; }
+        public string TargetLogInfo { get; private set; }
         public int Verbosity { get; private set; }
         public string AnsibleVersion { get; private set; }
 
@@ -257,6 +262,7 @@ namespace Ansible.Basic
             DiffMode = false;
             KeepRemoteFiles = false;
             ModuleName = "undefined win module";
+            TargetLogInfo = "";
             NoLog = (bool)argumentSpec["no_log"];
             Verbosity = 0;
             AppDomain.CurrentDomain.ProcessExit += CleanupFiles;
@@ -372,9 +378,20 @@ namespace Ansible.Basic
                     logSource = "Application";
                 }
             }
+
+            if (String.IsNullOrWhiteSpace(TargetLogInfo))
+            {
+                message = String.Format("{0} - {1}", ModuleName, message);
+            }
+            else
+            {
+                message = String.Format("{0} {1} - {2}", ModuleName, TargetLogInfo, message);
+            }
+
             if (sanitise)
+            {
                 message = (string)RemoveNoLogValues(message, noLogValues);
-            message = String.Format("{0} - {1}", ModuleName, message);
+            }
 
             using (EventLog eventLog = new EventLog("Application"))
             {
@@ -1043,7 +1060,7 @@ namespace Ansible.Basic
             foreach (string parameter in removedParameters)
                 param.Remove(parameter);
 
-            if (unsupportedParameters.Count > 0)
+            if (unsupportedParameters.Count > 0 && !ignoreUnknownOpts)
             {
                 legalInputs.RemoveAll(x => passVars.Keys.Contains(x.Replace("_ansible_", "")));
                 string msg = String.Format("Unsupported parameters for ({0}) module: {1}", ModuleName, String.Join(", ", unsupportedParameters));

ansible/module_utils/distro/__init__.py

@@ -15,13 +15,12 @@
 # You should have received a copy of the GNU General Public License
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
 
 '''
 Compat distro library.
 '''
+from __future__ import annotations
+
 # The following makes it easier for us to script updates of the bundled code
 _BUNDLED_METADATA = {"pypi_name": "distro", "version": "1.6.0"}