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

ansible/module_utils/common/yaml.py

@@ -26,7 +26,7 @@ else:
 
 # DTFIX-FUTURE: refactor this to share the implementation with the controller version
 #              use an abstract base class, with __init_subclass__ for representer registration, and instance methods for overridable representers
-#              then tests can be consolidated intead of having two nearly identical copies
+#              then tests can be consolidated instead of having two nearly identical copies
 
 if HAS_YAML:
     try:

ansible/module_utils/csharp/Ansible.Basic.cs

@@ -1696,7 +1696,7 @@ namespace Ansible.Basic
                 if ((attr & FileAttributes.ReadOnly) != 0)
                 {
                     // Windows does not allow files set with ReadOnly to be
-                    // deleted. Pre-emptively unset the attribute.
+                    // deleted. Preemptively unset the attribute.
                     // FILE_DISPOSITION_IGNORE_READONLY_ATTRIBUTE is quite new,
                     // look at using that flag with POSIX delete once Server 2019
                     // is the baseline.

ansible/module_utils/csharp/Ansible.Privilege.cs

@@ -228,7 +228,7 @@ namespace Ansible.Privilege
         }
 
         /// <summary>
-        /// Get's the status of all the privileges on the token specified
+        /// Gets the status of all the privileges on the token specified
         /// </summary>
         /// <param name="token">The process token to get the privilege status on</param>
         /// <returns>Dictionary where the key is the privilege constant and the value is the PrivilegeAttributes flags</returns>
@@ -342,7 +342,7 @@ namespace Ansible.Privilege
                 // Need to manually marshal the bytes requires for newState as the constant size
                 // of LUID_AND_ATTRIBUTES is set to 1 and can't be overridden at runtime, TOKEN_PRIVILEGES
                 // always contains at least 1 entry so we need to calculate the extra size if there are
-                // nore than 1 LUID_AND_ATTRIBUTES entry
+                // more than 1 LUID_AND_ATTRIBUTES entry
                 int tokenPrivilegesSize = Marshal.SizeOf(typeof(NativeHelpers.TOKEN_PRIVILEGES));
                 int luidAttrSize = 0;
                 if (newState.Length > 1)

ansible/module_utils/facts/hardware/base.py

@@ -49,7 +49,7 @@ class HardwareCollector(BaseFactCollector):
     _fact_ids = set(['processor',
                      'processor_cores',
                      'processor_count',
-                     # TODO: mounts isnt exactly hardware
+                     # TODO: mounts isn't exactly hardware
                      'mounts',
                      'devices'])  # type: t.Set[str]
     _fact_class = Hardware

ansible/module_utils/facts/other/facter.py

@@ -61,7 +61,7 @@ class FacterFactCollector(BaseFactCollector):
         return out
 
     def collect(self, module=None, collected_facts=None):
-        # Note that this mirrors previous facter behavior, where there isnt
+        # Note that this mirrors previous facter behavior, where there isn't
         # a 'ansible_facter' key in the main fact dict, but instead, 'facter_whatever'
         # items are added to the main dict.
         facter_dict = {}

ansible/module_utils/facts/system/distribution.py

@@ -100,7 +100,7 @@ class DistributionFiles:
         return get_file_content(path)
 
     def _get_dist_file_content(self, path, allow_empty=False):
-        # cant find that dist file or it is incorrectly empty
+        # can't find that dist file, or it is incorrectly empty
         if not _file_exists(path, allow_empty=allow_empty):
             return False, None
 
@@ -585,7 +585,7 @@ class Distribution(object):
             distribution_facts.update(dist_file_facts)
 
         distro = distribution_facts['distribution']
-        # look for a os family alias for the 'distribution', if there isnt one, use 'distribution'
+        # look for an os family alias for the 'distribution', if there isn't one, use 'distribution'
         distribution_facts['os_family'] = self.OS_FAMILY.get(distro, None) or distro
 
         return distribution_facts

ansible/module_utils/powershell/Ansible.ModuleUtils.AddType.psm1

@@ -5,7 +5,7 @@ Function Add-CSharpType {
     <#
     .SYNOPSIS
     Compiles one or more C# scripts similar to Add-Type. This exposes
-    more configuration options that are useable within Ansible and it
+    more configuration options that are usable within Ansible and it
     also allows multiple C# sources to be compiled together.
 
     .PARAMETER References

ansible/module_utils/powershell/Ansible.ModuleUtils.CamelConversion.psm1

@@ -21,7 +21,7 @@ Function Convert-StringToSnakeCase($string) {
     return $string
 }
 
-# used by Convert-DictToSnakeCase to covert list entries from camelCase
+# used by Convert-DictToSnakeCase to convert list entries from camelCase
 # to snake_case
 Function Convert-ListToSnakeCase($list) {
     $snake_list = [System.Collections.ArrayList]@()

ansible/module_utils/powershell/Ansible.ModuleUtils.CommandUtil.psm1

@@ -6,7 +6,7 @@
 Function Get-ExecutablePath {
     <#
     .SYNOPSIS
-    Get's the full path to an executable, will search the directory specified or ones in the PATH env var.
+    Gets the full path to an executable, will search the directory specified or ones in the PATH env var.
 
     .PARAMETER executable
     [String]The executable to search for.

ansible/module_utils/powershell/Ansible.ModuleUtils.WebRequest.psm1

@@ -17,7 +17,7 @@ Function Get-AnsibleWebRequest {
     The protocol method to use, if omitted, will use the default value for the URI protocol specified.
 
     .PARAMETER FollowRedirects
-    Whether to follow redirect reponses. This is only valid when using a HTTP URI.
+    Whether to follow redirect responses. This is only valid when using a HTTP URI.
         all - Will follow all redirects
         none - Will follow no redirects
         safe - Will only follow redirects when GET or HEAD is used as the Method

ansible/module_utils/urls.py

@@ -1155,7 +1155,7 @@ def url_argument_spec():
 
 def url_redirect_argument_spec():
     """
-    Creates an addition arugment spec to `url_argument_spec`
+    Creates an addition argument spec to `url_argument_spec`
     for  `follow_redirects` argument
     """
     return dict(

ansible/modules/apt.py

@@ -855,6 +855,7 @@ def install_deb(
         allow_downgrade,
         allow_change_held_packages,
         dpkg_options,
+        lock_timeout,
 ):
     changed = False
     deps_to_install = []
@@ -903,13 +904,14 @@ def install_deb(
     # install the deps through apt
     retvals = {}
     if deps_to_install:
+        install_dpkg_options = f"{expand_dpkg_options(dpkg_options)} -o DPkg::Lock::Timeout={lock_timeout}"
         (success, retvals) = install(m=m, pkgspec=deps_to_install, cache=cache,
                                      install_recommends=install_recommends,
                                      fail_on_autoremove=fail_on_autoremove,
                                      allow_unauthenticated=allow_unauthenticated,
                                      allow_downgrade=allow_downgrade,
                                      allow_change_held_packages=allow_change_held_packages,
-                                     dpkg_options=expand_dpkg_options(dpkg_options))
+                                     dpkg_options=install_dpkg_options)
         if not success:
             m.fail_json(**retvals)
         changed = retvals.get('changed', False)
@@ -1269,7 +1271,7 @@ def main():
 
     p = module.params
     install_recommends = p['install_recommends']
-    dpkg_options = expand_dpkg_options(p['dpkg_options'])
+    dpkg_options = f"{expand_dpkg_options(p['dpkg_options'])} -o DPkg::Lock::Timeout={p['lock_timeout']}"
 
     if not HAS_PYTHON_APT:
         # This interpreter can't see the apt Python library- we'll do the following to try and fix that:
@@ -1470,7 +1472,11 @@ def main():
                             allow_unauthenticated=allow_unauthenticated,
                             allow_change_held_packages=allow_change_held_packages,
                             allow_downgrade=allow_downgrade,
-                            force=force_yes, fail_on_autoremove=fail_on_autoremove, dpkg_options=p['dpkg_options'])
+                            force=force_yes,
+                            fail_on_autoremove=fail_on_autoremove,
+                            dpkg_options=p['dpkg_options'],
+                            lock_timeout=p['lock_timeout']
+                            )
 
             unfiltered_packages = p['package'] or ()
             packages = [package.strip() for package in unfiltered_packages if package != '*']

ansible/modules/assemble.py

@@ -80,7 +80,7 @@ attributes:
     bypass_host_loop:
       support: none
     check_mode:
-      support: none
+      support: full
     diff_mode:
       support: full
     platform:
@@ -212,6 +212,7 @@ def main():
             decrypt=dict(type='bool', default=True),
         ),
         add_file_common_args=True,
+        supports_check_mode=True,
     )
 
     changed = False
@@ -266,12 +267,13 @@ def main():
         if backup and dest_hash is not None:
             result['backup_file'] = module.backup_local(dest)
 
-        module.atomic_move(path, dest, unsafe_writes=module.params['unsafe_writes'])
+        if not module.check_mode:
+            module.atomic_move(path, dest, unsafe_writes=module.params['unsafe_writes'])
         changed = True
 
     cleanup(module, path, result)
 
-    # handle file permissions
+    # handle file permissions (check mode aware)
     file_args = module.load_file_common_arguments(module.params)
     result['changed'] = module.set_fs_attributes_if_different(file_args, changed)
 

ansible/modules/expect.py

@@ -218,7 +218,7 @@ def main():
                 rc=0
             )
 
-    startd = datetime.datetime.now()
+    start_date = datetime.datetime.now()
 
     try:
         try:
@@ -246,8 +246,8 @@ def main():
     except pexpect.ExceptionPexpect as e:
         module.fail_json(msg='%s' % to_native(e))
 
-    endd = datetime.datetime.now()
-    delta = endd - startd
+    end_date = datetime.datetime.now()
+    delta = end_date - start_date
 
     if b_out is None:
         b_out = b''
@@ -256,8 +256,8 @@ def main():
         cmd=args,
         stdout=to_native(b_out).rstrip('\r\n'),
         rc=rc,
-        start=str(startd),
-        end=str(endd),
+        start=str(start_date),
+        end=str(end_date),
         delta=str(delta),
         changed=True,
     )

ansible/modules/hostname.py

@@ -608,8 +608,8 @@ class Hostname(object):
         self.use = module.params['use']
 
         if self.use is not None:
-            strat = globals()['%sStrategy' % STRATS[self.use]]
-            self.strategy = strat(module)
+            strategy = globals()['%sStrategy' % STRATS[self.use]]
+            self.strategy = strategy(module)
         elif platform.system() == 'Linux' and ServiceMgrFactCollector.is_systemd_managed(module):
             # This is Linux and systemd is active
             self.strategy = SystemdStrategy(module)

ansible/modules/pip.py

@@ -60,7 +60,7 @@ options:
   virtualenv_python:
     description:
       - The Python executable used for creating the virtual environment.
-        For example V(python3.12), V(python2.7). When not specified, the
+        For example V(python3.13). When not specified, the
         Python version used to run the ansible module is used. This parameter
         should not be used when O(virtualenv_command) is using V(pyvenv) or
         the C(-m venv) module.
@@ -93,8 +93,8 @@ options:
     description:
       - The explicit executable or pathname for the C(pip) executable,
         if different from the Ansible Python interpreter. For
-        example V(pip3.3), if there are both Python 2.7 and 3.3 installations
-        in the system and you want to run pip for the Python 3.3 installation.
+        example V(pip3.13), if there are multiple Python installations
+        in the system and you want to run pip for the Python 3.13 installation.
       - Mutually exclusive with O(virtualenv) (added in 2.1).
       - Does not affect the Ansible Python interpreter.
       - The C(setuptools) package must be installed for both the Ansible Python interpreter
@@ -134,7 +134,7 @@ notes:
      the virtualenv needs to be created.
    - Although it executes using the Ansible Python interpreter, the pip module shells out to
      run the actual pip command, so it can use any pip version you specify with O(executable).
-     By default, it uses the pip version for the Ansible Python interpreter. For example, pip3 on python 3, and pip2 or pip on python 2.
+     By default, it uses the pip version for the Ansible Python interpreter.
    - The interpreter used by Ansible
      (see R(ansible_python_interpreter, ansible_python_interpreter))
      requires the setuptools package, regardless of the version of pip set with
@@ -197,11 +197,11 @@ EXAMPLES = """
     virtualenv: /my_app/venv
     virtualenv_site_packages: yes
 
-- name: Install bottle into the specified (virtualenv), using Python 2.7
+- name: Install bottle into the specified (virtualenv), using Python 3.13
   ansible.builtin.pip:
     name: bottle
     virtualenv: /my_app/venv
-    virtualenv_command: virtualenv-2.7
+    virtualenv_command: virtualenv-3.13
 
 - name: Install bottle within a user home directory
   ansible.builtin.pip:
@@ -227,10 +227,10 @@ EXAMPLES = """
     requirements: /my_app/requirements.txt
     extra_args: "--no-index --find-links=file:///my_downloaded_packages_dir"
 
-- name: Install bottle for Python 3.3 specifically, using the 'pip3.3' executable
+- name: Install bottle for Python 3.13 specifically, using the 'pip3.13' executable
   ansible.builtin.pip:
     name: bottle
-    executable: pip3.3
+    executable: pip3.13
 
 - name: Install bottle, forcing reinstallation if it's already installed
   ansible.builtin.pip:
@@ -460,9 +460,7 @@ def _get_pip(module, env=None, executable=None):
             candidate_pip_basenames = (executable,)
     elif executable is None and env is None and _have_pip_module():
         # If no executable or virtualenv were specified, use the pip module for the current Python interpreter if available.
-        # Use of `__main__` is required to support Python 2.6 since support for executing packages with `runpy` was added in Python 2.7.
-        # Without it Python 2.6 gives the following error: pip is a package and cannot be directly executed
-        pip = [sys.executable, '-m', 'pip.__main__']
+        pip = [sys.executable, '-m', 'pip']
 
     if pip is None:
         if env is None:

ansible/modules/raw.py

@@ -73,8 +73,8 @@ author:
 """
 
 EXAMPLES = r"""
-- name: Bootstrap a host without python2 installed
-  ansible.builtin.raw: dnf install -y python2 python2-dnf libselinux-python
+- name: Bootstrap a host without Python installed
+  ansible.builtin.raw: dnf install -y python3 python3-libdnf
 
 - name: Run a command that uses non-posix shell-isms (in this example /bin/sh doesn't handle redirection and wildcards together but bash does)
   ansible.builtin.raw: cat < /tmp/*txt

ansible/modules/stat.py

@@ -408,7 +408,7 @@ def format_output(module, path, st):
             ('st_blksize', 'block_size'),
             ('st_rdev', 'device_type'),
             ('st_flags', 'flags'),
-            # Some Berkley based
+            # Some Berkeley based
             ('st_gen', 'generation'),
             ('st_birthtime', 'birthtime'),
             # RISCOS

ansible/modules/wait_for.py

@@ -76,6 +76,8 @@ options:
     description:
       - Can be used to match a string in either a file or a socket connection.
       - Defaults to a multiline regex.
+      - When inspecting a system log file and a static string, remember that Ansible by default logs its own actions there;
+        see the notes and examples for information.
     type: str
     version_added: "1.4"
   exclude_hosts:
@@ -105,13 +107,13 @@ attributes:
     platform:
         platforms: posix
 notes:
-  - The ability to use search_regex with a port connection was added in Ansible 1.7.
-  - Prior to Ansible 2.4, testing for the absence of a directory or UNIX socket did not work correctly.
-  - Prior to Ansible 2.4, testing for the presence of a file did not work correctly if the remote user did not have read access to that file.
   - Under some circumstances when using mandatory access control, a path may always be treated as being absent even if it exists, but
     can't be modified or created by the remote user either.
   - When waiting for a path, symbolic links will be followed.  Many other modules that manipulate files do not follow symbolic links,
     so operations on the path using other modules may not work exactly as expected.
+  - When searching a static string within a system log file, it is important to account for potential self-matching against log entries
+    generated by the Ansible modules.  To prevent this, add a regular expression construct into the search string. For example, to match
+    a literal string 'this thing', one could use a regular expression like 'this t[h]ing'.
 seealso:
 - module: ansible.builtin.wait_for_connection
 - module: ansible.windows.win_wait_for
@@ -156,6 +158,11 @@ EXAMPLES = r"""
     path: /tmp/foo
     search_regex: completed
 
+- name: Wait until the string "tomcat up" is in syslog, use regex character set to avoid self match
+  ansible.builtin.wait_for:
+    path: /var/log/syslog
+    search_regex: 'tomcat [u]p'
+
 - name: Wait until regex pattern matches in the file /tmp/foo and print the matched group
   ansible.builtin.wait_for:
     path: /tmp/foo

ansible/parsing/mod_args.py

@@ -20,17 +20,17 @@ from __future__ import annotations
 import ansible.constants as C
 from ansible.errors import AnsibleParserError, AnsibleError, AnsibleAssertionError
 from ansible.module_utils._internal._datatag import AnsibleTagHelper
-from ansible.module_utils.six import string_types
 from ansible.module_utils.common.sentinel import Sentinel
 from ansible.module_utils.common.text.converters import to_text
 from ansible.parsing.splitter import parse_kv, split_args
 from ansible.parsing.vault import EncryptedString
 from ansible.plugins.loader import module_loader, action_loader
-from ansible._internal._templating._engine import TemplateEngine
+from ansible._internal._templating import _jinja_bits
+from ansible.utils.display import Display
 from ansible.utils.fqcn import add_internal_fqcns
 
 
-# modules formated for user msg
+# modules formatted for user msg
 _BUILTIN_RAW_PARAM_MODULES_SIMPLE = set([
     'include_vars',
     'include_tasks',
@@ -152,38 +152,43 @@ class ModuleArgsParser:
         arguments can be fuzzy.  Deal with all the forms.
         """
 
-        additional_args = {} if additional_args is None else additional_args
-
         # final args are the ones we'll eventually return, so first update
         # them with any additional args specified, which have lower priority
         # than those which may be parsed/normalized next
         final_args = dict()
-        if additional_args:
-            if isinstance(additional_args, (str, EncryptedString)):
-                # DTFIX5: should this be is_possibly_template?
-                if TemplateEngine().is_template(additional_args):
-                    final_args['_variable_params'] = additional_args
-                else:
-                    raise AnsibleParserError("Complex args containing variables cannot use bare variables (without Jinja2 delimiters), "
-                                             "and must use the full variable style ('{{var_name}}')")
+
+        if additional_args is not Sentinel:
+            if isinstance(additional_args, str) and _jinja_bits.is_possibly_all_template(additional_args):
+                final_args['_variable_params'] = additional_args
             elif isinstance(additional_args, dict):
                 final_args.update(additional_args)
+            elif additional_args is None:
+                Display().deprecated(
+                    msg="Ignoring empty task `args` keyword.",
+                    version="2.23",
+                    help_text='A mapping or template which resolves to a mapping is required.',
+                    obj=self._task_ds,
+                )
             else:
-                raise AnsibleParserError('Complex args must be a dictionary or variable string ("{{var}}").')
+                raise AnsibleParserError(
+                    message='The value of the task `args` keyword is invalid.',
+                    help_text='A mapping or template which resolves to a mapping is required.',
+                    obj=additional_args,
+                )
 
         # how we normalize depends if we figured out what the module name is
         # yet.  If we have already figured it out, it's a 'new style' invocation.
         # otherwise, it's not
 
         if action is not None:
-            args = self._normalize_new_style_args(thing, action)
+            args = self._normalize_new_style_args(thing, action, additional_args)
         else:
             (action, args) = self._normalize_old_style_args(thing)
 
             # this can occasionally happen, simplify
             if args and 'args' in args:
                 tmp_args = args.pop('args')
-                if isinstance(tmp_args, string_types):
+                if isinstance(tmp_args, str):
                     tmp_args = parse_kv(tmp_args)
                 args.update(tmp_args)
 
@@ -206,7 +211,7 @@ class ModuleArgsParser:
 
         return (action, final_args)
 
-    def _normalize_new_style_args(self, thing, action):
+    def _normalize_new_style_args(self, thing, action, additional_args):
         """
         deals with fuzziness in new style module invocations
         accepting key=value pairs and dictionaries, and returns
@@ -222,11 +227,23 @@ class ModuleArgsParser:
         if isinstance(thing, dict):
             # form is like: { xyz: { x: 2, y: 3 } }
             args = thing
-        elif isinstance(thing, string_types):
+        elif isinstance(thing, str):
             # form is like: copy: src=a dest=b
             check_raw = action in FREEFORM_ACTIONS
             args = parse_kv(thing, check_raw=check_raw)
+            args_keys = set(args) - {'_raw_params'}
+
+            if args_keys and additional_args is not Sentinel:
+                kv_args = ', '.join(repr(arg) for arg in sorted(args_keys))
+
+                Display().deprecated(
+                    msg=f"Merging legacy k=v args ({kv_args}) into task args.",
+                    help_text="Include all task args in the task `args` mapping.",
+                    version="2.23",
+                    obj=thing,
+                )
         elif isinstance(thing, EncryptedString):
+            # k=v parsing intentionally omitted
             args = dict(_raw_params=thing)
         elif thing is None:
             # this can happen with modules which take no params, like ping:
@@ -253,6 +270,7 @@ class ModuleArgsParser:
 
         if isinstance(thing, dict):
             # form is like:  action: { module: 'copy', src: 'a', dest: 'b' }
+            Display().deprecated("Using a mapping for `action` is deprecated.", version='2.23', help_text='Use a string value for `action`.', obj=thing)
             thing = thing.copy()
             if 'module' in thing:
                 action, module_args = self._split_module_string(thing['module'])
@@ -261,7 +279,7 @@ class ModuleArgsParser:
                 args.update(parse_kv(module_args, check_raw=check_raw))
                 del args['module']
 
-        elif isinstance(thing, string_types):
+        elif isinstance(thing, str):
             # form is like:  action: copy src=a dest=b
             (action, args) = self._split_module_string(thing)
             check_raw = action in FREEFORM_ACTIONS
@@ -287,7 +305,7 @@ class ModuleArgsParser:
         # This is the standard YAML form for command-type modules. We grab
         # the args and pass them in as additional arguments, which can/will
         # be overwritten via dict updates from the other arg sources below
-        additional_args = self._task_ds.get('args', dict())
+        additional_args = self._task_ds.get('args', Sentinel)
 
         # We can have one of action, local_action, or module specified
         # action

ansible/parsing/vault/__init__.py

@@ -570,8 +570,8 @@ def match_encrypt_secret(secrets, encrypt_vault_id=None):
         return match_encrypt_vault_id_secret(secrets,
                                              encrypt_vault_id=encrypt_vault_id)
 
-    # Find the best/first secret from secrets since we didnt specify otherwise
-    # ie, consider all of the available secrets as matches
+    # Find the best/first secret from secrets since we didn't specify otherwise
+    # ie, consider all the available secrets as matches
     _vault_id_matchers = [_vault_id for _vault_id, dummy in secrets]
     best_secret = match_best_secret(secrets, _vault_id_matchers)
 
@@ -1413,7 +1413,7 @@ class EncryptedString(AnsibleTaggedObject):
             'ljust',
             'lower',
             'lstrip',
-            'maketrans',  # static, but implemented for simplicty/consistency
+            'maketrans',  # static, but implemented for simplicity/consistency
             'partition',
             'removeprefix',
             'removesuffix',

ansible/playbook/base.py

@@ -221,8 +221,6 @@ class FieldAttributeBase:
 
     def validate(self, all_vars=None):
         """ validation that is done at parse time, not load time """
-        all_vars = {} if all_vars is None else all_vars
-
         if not self._validated:
             # walk all fields in the object
             for (name, attribute) in self.fattributes.items():

ansible/playbook/helpers.py

@@ -122,7 +122,7 @@ def load_list_of_tasks(ds, play, block=None, role=None, task_include=None, use_h
             except AnsibleParserError as ex:
                 # if the raises exception was created with obj=ds args, then it includes the detail
                 # so we dont need to add it so we can just re raise.
-                if ex.obj:
+                if ex.obj is not None:
                     raise
                 # But if it wasn't, we can add the yaml object now to get more detail
                 # DTFIX-FUTURE: this *should* be unnecessary- check code coverage.