ansible-core 2.17.6rc1__py3-none-any.whl → 2.18.0__py3-none-any.whl

ansible/module_utils/facts/packages.py

@@ -3,24 +3,29 @@
 
 from __future__ import annotations
 
+import ansible.module_utils.compat.typing as t
+
 from abc import ABCMeta, abstractmethod
 
 from ansible.module_utils.six import with_metaclass
+from ansible.module_utils.basic import missing_required_lib
 from ansible.module_utils.common.process import get_bin_path
+from ansible.module_utils.common.respawn import has_respawned, probe_interpreters_for_module, respawn_module
 from ansible.module_utils.common._utils import get_all_subclasses
 
 
 def get_all_pkg_managers():
 
-    return {obj.__name__.lower(): obj for obj in get_all_subclasses(PkgMgr) if obj not in (CLIMgr, LibMgr)}
+    return {obj.__name__.lower(): obj for obj in get_all_subclasses(PkgMgr) if obj not in (CLIMgr, LibMgr, RespawningLibMgr)}
 
 
 class PkgMgr(with_metaclass(ABCMeta, object)):  # type: ignore[misc]
 
     @abstractmethod
-    def is_available(self):
+    def is_available(self, handle_exceptions):
         # This method is supposed to return True/False if the package manager is currently installed/usable
         # It can also 'prep' the required systems in the process of detecting availability
+        # If handle_exceptions is false it should raise exceptions related to manager discovery instead of handling them.
         pass
 
     @abstractmethod
@@ -58,16 +63,50 @@ class LibMgr(PkgMgr):
         self._lib = None
         super(LibMgr, self).__init__()
 
-    def is_available(self):
+    def is_available(self, handle_exceptions=True):
         found = False
         try:
             self._lib = __import__(self.LIB)
             found = True
         except ImportError:
-            pass
+            if not handle_exceptions:
+                raise Exception(missing_required_lib(self.LIB))
         return found
 
 
+class RespawningLibMgr(LibMgr):
+
+    CLI_BINARIES = []   # type: t.List[str]
+    INTERPRETERS = ['/usr/bin/python3']
+
+    def is_available(self, handle_exceptions=True):
+        if super(RespawningLibMgr, self).is_available():
+            return True
+
+        for binary in self.CLI_BINARIES:
+            try:
+                bin_path = get_bin_path(binary)
+            except ValueError:
+                # Not an interesting exception to raise, just a speculative probe
+                continue
+            else:
+                # It looks like this package manager is installed
+                if not has_respawned():
+                    # See if respawning will help
+                    interpreter_path = probe_interpreters_for_module(self.INTERPRETERS, self.LIB)
+                    if interpreter_path:
+                        respawn_module(interpreter_path)
+                        # The module will exit when the respawned copy completes
+
+                if not handle_exceptions:
+                    raise Exception(f'Found executable at {bin_path}. {missing_required_lib(self.LIB)}')
+
+        if not handle_exceptions:
+            raise Exception(missing_required_lib(self.LIB))
+
+        return False
+
+
 class CLIMgr(PkgMgr):
 
     CLI = None  # type: str | None
@@ -77,9 +116,12 @@ class CLIMgr(PkgMgr):
         self._cli = None
         super(CLIMgr, self).__init__()
 
-    def is_available(self):
+    def is_available(self, handle_exceptions=True):
+        found = False
         try:
             self._cli = get_bin_path(self.CLI)
+            found = True
         except ValueError:
-            return False
-        return True
+            if not handle_exceptions:
+                raise
+        return found

ansible/module_utils/facts/sysctl.py

@@ -21,41 +21,43 @@ from ansible.module_utils.common.text.converters import to_text
 
 
 def get_sysctl(module, prefixes):
-    sysctl_cmd = module.get_bin_path('sysctl')
-    cmd = [sysctl_cmd]
-    cmd.extend(prefixes)
 
     sysctl = dict()
-
-    try:
-        rc, out, err = module.run_command(cmd)
-    except (IOError, OSError) as e:
-        module.warn('Unable to read sysctl: %s' % to_text(e))
-        rc = 1
-
-    if rc == 0:
-        key = ''
-        value = ''
-        for line in out.splitlines():
-            if not line.strip():
-                continue
-
-            if line.startswith(' '):
-                # handle multiline values, they will not have a starting key
-                # Add the newline back in so people can split on it to parse
-                # lines if they need to.
-                value += '\n' + line
-                continue
+    sysctl_cmd = module.get_bin_path('sysctl')
+    if sysctl_cmd is not None:
+
+        cmd = [sysctl_cmd]
+        cmd.extend(prefixes)
+
+        try:
+            rc, out, err = module.run_command(cmd)
+        except (IOError, OSError) as e:
+            module.warn('Unable to read sysctl: %s' % to_text(e))
+            rc = 1
+
+        if rc == 0:
+            key = ''
+            value = ''
+            for line in out.splitlines():
+                if not line.strip():
+                    continue
+
+                if line.startswith(' '):
+                    # handle multiline values, they will not have a starting key
+                    # Add the newline back in so people can split on it to parse
+                    # lines if they need to.
+                    value += '\n' + line
+                    continue
+
+                if key:
+                    sysctl[key] = value.strip()
+
+                try:
+                    (key, value) = re.split(r'\s?=\s?|: ', line, maxsplit=1)
+                except Exception as e:
+                    module.warn('Unable to split sysctl line (%s): %s' % (to_text(line), to_text(e)))
 
             if key:
                 sysctl[key] = value.strip()
 
-            try:
-                (key, value) = re.split(r'\s?=\s?|: ', line, maxsplit=1)
-            except Exception as e:
-                module.warn('Unable to split sysctl line (%s): %s' % (to_text(line), to_text(e)))
-
-        if key:
-            sysctl[key] = value.strip()
-
     return sysctl

ansible/module_utils/facts/system/distribution.py

@@ -517,7 +517,7 @@ class Distribution(object):
                                 'Linux Mint', 'SteamOS', 'Devuan', 'Kali', 'Cumulus Linux',
                                 'Pop!_OS', 'Parrot', 'Pardus GNU/Linux', 'Uos', 'Deepin', 'OSMC'],
                      'Suse': ['SuSE', 'SLES', 'SLED', 'openSUSE', 'openSUSE Tumbleweed',
-                              'SLES_SAP', 'SUSE_LINUX', 'openSUSE Leap', 'ALP-Dolomite'],
+                              'SLES_SAP', 'SUSE_LINUX', 'openSUSE Leap', 'ALP-Dolomite', 'SL-Micro'],
                      'Archlinux': ['Archlinux', 'Antergos', 'Manjaro'],
                      'Mandrake': ['Mandrake', 'Mandriva'],
                      'Solaris': ['Solaris', 'Nexenta', 'OmniOS', 'OpenIndiana', 'SmartOS'],

ansible/module_utils/facts/system/local.py

@@ -1,17 +1,5 @@
-# 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/>.
+# Copyright: Contributors to the Ansible project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import annotations
 
@@ -25,7 +13,6 @@ import ansible.module_utils.compat.typing as t
 from ansible.module_utils.common.text.converters import to_text
 from ansible.module_utils.facts.utils import get_file_content
 from ansible.module_utils.facts.collector import BaseFactCollector
-from ansible.module_utils.six import PY3
 from ansible.module_utils.six.moves import configparser, StringIO
 
 
@@ -91,12 +78,9 @@ class LocalFactCollector(BaseFactCollector):
                 # if that fails read it with ConfigParser
                 cp = configparser.ConfigParser()
                 try:
-                    if PY3:
-                        cp.read_file(StringIO(out))
-                    else:
-                        cp.readfp(StringIO(out))
+                    cp.read_file(StringIO(out))
                 except configparser.Error:
-                    fact = "error loading facts as JSON or ini - please check content: %s" % fn
+                    fact = f"error loading facts as JSON or ini - please check content: {fn}"
                     module.warn(fact)
                 else:
                     fact = {}
@@ -104,8 +88,14 @@ class LocalFactCollector(BaseFactCollector):
                         if sect not in fact:
                             fact[sect] = {}
                         for opt in cp.options(sect):
-                            val = cp.get(sect, opt)
-                            fact[sect][opt] = val
+                            try:
+                                val = cp.get(sect, opt)
+                            except configparser.Error as ex:
+                                fact = f"error loading facts as ini - please check content: {fn} ({ex})"
+                                module.warn(fact)
+                                continue
+                            else:
+                                fact[sect][opt] = val
             except Exception as e:
                 fact = "Failed to convert (%s) to JSON: %s" % (fn, to_text(e))
                 module.warn(fact)

ansible/module_utils/facts/system/service_mgr.py

@@ -106,7 +106,7 @@ class ServiceMgrFactCollector(BaseFactCollector):
             proc_1 = proc_1.strip()
 
         if proc_1 is not None and (proc_1 == 'init' or proc_1.endswith('sh')):
-            # many systems return init, so this cannot be trusted, if it ends in 'sh' it probalby is a shell in a container
+            # many systems return init, so this cannot be trusted, if it ends in 'sh' it probably is a shell in a container
             proc_1 = None
 
         # if not init/None it should be an identifiable or custom init, so we are done!
@@ -144,6 +144,8 @@ class ServiceMgrFactCollector(BaseFactCollector):
                 service_mgr_name = 'systemd'
             elif os.path.exists('/etc/init.d/'):
                 service_mgr_name = 'sysvinit'
+            elif os.path.exists('/etc/dinit.d/'):
+                service_mgr_name = 'dinit'
 
         if not service_mgr_name:
             # if we cannot detect, fallback to generic 'service'

ansible/module_utils/facts/system/systemd.py

@@ -0,0 +1,47 @@
+# Get systemd version and features
+#
+# 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
+
+import ansible.module_utils.compat.typing as t
+
+from ansible.module_utils.facts.collector import BaseFactCollector
+from ansible.module_utils.facts.system.service_mgr import ServiceMgrFactCollector
+
+
+class SystemdFactCollector(BaseFactCollector):
+    name = "systemd"
+    _fact_ids = set()  # type: t.Set[str]
+
+    def collect(self, module=None, collected_facts=None):
+        systemctl_bin = module.get_bin_path("systemctl")
+        systemd_facts = {}
+        if systemctl_bin and ServiceMgrFactCollector.is_systemd_managed(module):
+            rc, stdout, dummy = module.run_command(
+                [systemctl_bin, "--version"],
+                check_rc=False,
+            )
+
+            if rc != 0:
+                return systemd_facts
+
+            systemd_facts["systemd"] = {
+                "features": str(stdout.split("\n")[1]),
+                "version": int(stdout.split(" ")[1]),
+            }
+
+        return systemd_facts

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

@@ -37,7 +37,7 @@ Function Add-CSharpType {
     .PARAMETER CompileSymbols
     [String[]] A list of symbols to be defined during compile time. These are
     added to the existing symbols, 'CORECLR', 'WINDOWS', 'UNIX' that are set
-    conditionalls in this cmdlet.
+    conditionals in this cmdlet.
 
     .NOTES
     The following features were added to control the compiling options from the

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

@@ -4,7 +4,7 @@
 # used by Convert-DictToSnakeCase to convert a string in camelCase
 # format to snake_case
 Function Convert-StringToSnakeCase($string) {
-    # cope with pluralized abbreaviations such as TargetGroupARNs
+    # cope with pluralized abbreviations such as TargetGroupARNs
     if ($string -cmatch "[A-Z]{3,}s") {
         $replacement_string = $string -creplace $matches[0], "_$($matches[0].ToLower())"
 

ansible/module_utils/splitter.py

@@ -81,7 +81,7 @@ def split_args(args):
     '''
 
     # the list of params parsed out of the arg string
-    # this is going to be the result value when we are donei
+    # this is going to be the result value when we are done
     params = []
 
     # here we encode the args, so we have a uniform charset to

ansible/modules/add_host.py

@@ -61,7 +61,7 @@ notes:
 - The alias O(host) of the parameter O(name) is only available on Ansible 2.4 and newer.
 - Since Ansible 2.4, the C(inventory_dir) variable is now set to V(None) instead of the 'global inventory source',
   because you can now have multiple sources.  An example was added that shows how to partially restore the previous behaviour.
-- Though this module does not change the remote host, we do provide 'changed' status as it can be useful for those trying to track inventory changes.
+- Though this module does not change the remote host, we do provide C(changed) status as it can be useful for those trying to track inventory changes.
 - The hosts added will not bypass the C(--limit) from the command line, so both of those need to be in agreement to make them available as play targets.
   They are still available from hostvars and for delegation as a normal part of the inventory.
 seealso:

ansible/modules/apt.py

@@ -21,6 +21,7 @@ options:
     description:
       - A list of package names, like V(foo), or package specifier with version, like V(foo=1.0) or V(foo>=1.0).
         Name wildcards (fnmatch) like V(apt*) and version wildcards like V(foo=1.0*) are also supported.
+      - Do not use single or double quotes around the version when referring to the package name with a specific version, such as V(foo=1.0) or V(foo>=1.0).
     aliases: [ package, pkg ]
     type: list
     elements: str
@@ -62,21 +63,20 @@ options:
     default: 'no'
   default_release:
     description:
-      - Corresponds to the C(-t) option for I(apt) and sets pin priorities
+      - Corresponds to the C(-t) option for I(apt) and sets pin priorities.
     aliases: [ default-release ]
     type: str
   install_recommends:
     description:
-      - Corresponds to the C(--no-install-recommends) option for I(apt). V(true) installs recommended packages.  V(false) does not install
+      - Corresponds to the C(--no-install-recommends) option for C(apt). V(true) installs recommended packages. V(false) does not install
         recommended packages. By default, Ansible will use the same defaults as the operating system. Suggested packages are never installed.
     aliases: [ install-recommends ]
     type: bool
   force:
     description:
-      - 'Corresponds to the C(--force-yes) to I(apt-get) and implies O(allow_unauthenticated=yes) and O(allow_downgrade=yes)'
-      - "This option will disable checking both the packages' signatures and the certificates of the
-        web servers they are downloaded from."
-      - 'This option *is not* the equivalent of passing the C(-f) flag to I(apt-get) on the command line'
+      - 'Corresponds to the C(--force-yes) to C(apt-get) and implies O(allow_unauthenticated=yes) and O(allow_downgrade=yes).'
+      - "This option will disable checking both the packages' signatures and the certificates of the web servers they are downloaded from."
+      - 'This option *is not* the equivalent of passing the C(-f) flag to C(apt-get) on the command line.'
       - '**This is a destructive operation with the potential to destroy your system, and it should almost never be used.**
          Please also see C(man apt-get) for more information.'
     type: bool
@@ -84,7 +84,7 @@ options:
   clean:
     description:
       - Run the equivalent of C(apt-get clean) to clear out the local repository of retrieved package files. It removes everything but
-        the lock file from /var/cache/apt/archives/ and /var/cache/apt/archives/partial/.
+        the lock file from C(/var/cache/apt/archives/) and C(/var/cache/apt/archives/partial/).
       - Can be run as part of the package installation (clean runs before install) or as a separate step.
     type: bool
     default: 'no'
@@ -92,7 +92,7 @@ options:
   allow_unauthenticated:
     description:
       - Ignore if packages cannot be authenticated. This is useful for bootstrapping environments that manage their own apt-key setup.
-      - 'O(allow_unauthenticated) is only supported with O(state): V(install)/V(present)'
+      - 'O(allow_unauthenticated) is only supported with O(state): V(install)/V(present).'
     aliases: [ allow-unauthenticated ]
     type: bool
     default: 'no'
@@ -110,7 +110,7 @@ options:
     version_added: "2.12"
   allow_change_held_packages:
     description:
-      - Allows changing the version of a package which is on the apt hold list
+      - Allows changing the version of a package which is on the apt hold list.
     type: bool
     default: 'no'
     version_added: '2.13'
@@ -127,14 +127,14 @@ options:
     type: str
   dpkg_options:
     description:
-      - Add dpkg options to apt command. Defaults to '-o "Dpkg::Options::=--force-confdef" -o "Dpkg::Options::=--force-confold"'
-      - Options should be supplied as comma separated list
+      - Add C(dpkg) options to C(apt) command. Defaults to C(-o "Dpkg::Options::=--force-confdef" -o "Dpkg::Options::=--force-confold").
+      - Options should be supplied as comma separated list.
     default: force-confdef,force-confold
     type: str
   deb:
      description:
        - Path to a .deb package on the remote machine.
-       - If :// in the path, ansible will attempt to download deb before installing. (Version added 2.1)
+       - If C(://) in the path, ansible will attempt to download deb before installing. (Version added 2.1)
        - Requires the C(xz-utils) package to extract the control file of the deb package to install.
      type: path
      required: false
@@ -142,7 +142,8 @@ options:
   autoremove:
     description:
       - If V(true), remove unused dependency packages for all module states except V(build-dep). It can also be used as the only option.
-      - Previous to version 2.4, autoclean was also an alias for autoremove, now it is its own separate command. See documentation for further information.
+      - Previous to version 2.4, O(autoclean) was also an alias for O(autoremove), now it is its own separate command.
+        See documentation for further information.
     type: bool
     default: 'no'
     version_added: "2.1"
@@ -154,10 +155,10 @@ options:
     version_added: "2.4"
   policy_rc_d:
     description:
-      - Force the exit code of /usr/sbin/policy-rc.d.
-      - For example, if I(policy_rc_d=101) the installed package will not trigger a service start.
-      - If /usr/sbin/policy-rc.d already exists, it is backed up and restored after the package installation.
-      - If V(null), the /usr/sbin/policy-rc.d isn't created/changed.
+      - Force the exit code of C(/usr/sbin/policy-rc.d).
+      - For example, if O(policy_rc_d=101) the installed package will not trigger a service start.
+      - If C(/usr/sbin/policy-rc.d) already exists, it is backed up and restored after the package installation.
+      - If V(null), the C(/usr/sbin/policy-rc.d) is not created/changed.
     type: int
     default: null
     version_added: "2.8"
@@ -178,7 +179,7 @@ options:
     version_added: "2.11"
   force_apt_get:
     description:
-      - Force usage of apt-get instead of aptitude
+      - Force usage of apt-get instead of aptitude.
     type: bool
     default: 'no'
     version_added: "2.4"
@@ -204,22 +205,22 @@ attributes:
         platforms: debian
 notes:
    - Three of the upgrade modes (V(full), V(safe) and its alias V(true)) required C(aptitude) up to 2.3, since 2.4 C(apt-get) is used as a fall-back.
-   - In most cases, packages installed with apt will start newly installed services by default. Most distributions have mechanisms to avoid this.
+   - In most cases, packages installed with I(apt) will start newly installed services by default. Most distributions have mechanisms to avoid this.
      For example when installing Postgresql-9.5 in Debian 9, creating an executable shell script (/usr/sbin/policy-rc.d) that throws
-     a return code of 101 will stop Postgresql 9.5 starting up after install. Remove the file or  its execute permission afterward.
-   - The apt-get commandline supports implicit regex matches here but we do not because it can let typos through easier
+     a return code of 101 will stop Postgresql 9.5 starting up after install. Remove the file or its execute permission afterward.
+   - The C(apt-get) commandline supports implicit regex matches here but we do not because it can let typos through easier
      (If you typo C(foo) as C(fo) apt-get would install packages that have "fo" in their name with a warning and a prompt for the user.
-     Since we don't have warnings and prompts before installing, we disallow this.Use an explicit fnmatch pattern if you want wildcarding)
+     Since there are no warnings and prompts before installing, we disallow this. Use an explicit fnmatch pattern if you want wildcarding).
    - When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly to the O(name) option.
    - When O(default_release) is used, an implicit priority of 990 is used. This is the same behavior as C(apt-get -t).
    - When an exact version is specified, an implicit priority of 1001 is used.
-   - If the interpreter can't import ``python-apt``/``python3-apt`` the module will check for it in system-owned interpreters as well.
+   - If the interpreter can't import C(python-apt)/C(python3-apt) the module will check for it in system-owned interpreters as well.
      If the dependency can't be found, the module will attempt to install it.
      If the dependency is found or installed, the module will be respawned under the correct interpreter.
 '''
 
 EXAMPLES = '''
-- name: Install apache httpd  (state=present is optional)
+- name: Install apache httpd (state=present is optional)
   ansible.builtin.apt:
     name: apache2
     state: present
@@ -364,8 +365,8 @@ import datetime
 import fnmatch
 import locale as locale_module
 import os
-import random
 import re
+import secrets
 import shutil
 import sys
 import tempfile
@@ -380,8 +381,8 @@ from ansible.module_utils.six import string_types
 from ansible.module_utils.urls import fetch_file
 
 DPKG_OPTIONS = 'force-confdef,force-confold'
-APT_GET_ZERO = "\n0 upgraded, 0 newly installed"
-APTITUDE_ZERO = "\n0 packages upgraded, 0 newly installed"
+APT_GET_ZERO = "\n0 upgraded, 0 newly installed, 0 to remove"
+APTITUDE_ZERO = "\n0 packages upgraded, 0 newly installed, 0 to remove"
 APT_LISTS_PATH = "/var/lib/apt/lists"
 APT_UPDATE_SUCCESS_STAMP_PATH = "/var/lib/apt/periodic/update-success-stamp"
 APT_MARK_INVALID_OP = 'Invalid operation'
@@ -506,7 +507,7 @@ def package_best_match(pkgname, version_cmp, version, release, cache):
         policy.create_pin('Release', pkgname, release, 990)
     if version_cmp == "=":
         # Installing a specific version from command line overrides all pinning
-        # We don't mimmic this exactly, but instead set a priority which is higher than all APT built-in pin priorities.
+        # We don't mimic this exactly, but instead set a priority which is higher than all APT built-in pin priorities.
         policy.create_pin('Version', pkgname, version, 1001)
     pkg = cache[pkgname]
     pkgver = policy.get_candidate_ver(pkg)
@@ -1251,6 +1252,7 @@ def main():
         LC_ALL=locale,
         LC_MESSAGES=locale,
         LC_CTYPE=locale,
+        LANGUAGE=locale,
     )
     module.run_command_environ_update = APT_ENV_VARS
 
@@ -1386,23 +1388,32 @@ def main():
                     err = ''
                     update_cache_retries = module.params.get('update_cache_retries')
                     update_cache_retry_max_delay = module.params.get('update_cache_retry_max_delay')
-                    randomize = random.randint(0, 1000) / 1000.0
+                    randomize = secrets.randbelow(1000) / 1000.0
 
                     for retry in range(update_cache_retries):
                         try:
                             if not module.check_mode:
                                 cache.update()
                             break
-                        except apt.cache.FetchFailedException as e:
-                            err = to_native(e)
+                        except apt.cache.FetchFailedException as fetch_failed_exc:
+                            err = fetch_failed_exc
+                            module.warn(
+                                f"Failed to update cache after {retry + 1} retries due "
+                                f"to {to_native(fetch_failed_exc)}, retrying"
+                            )
 
                         # Use exponential backoff plus a little bit of randomness
                         delay = 2 ** retry + randomize
                         if delay > update_cache_retry_max_delay:
                             delay = update_cache_retry_max_delay + randomize
                         time.sleep(delay)
+                        module.warn(f"Sleeping for {int(round(delay))} seconds, before attempting to refresh the cache again")
                     else:
-                        module.fail_json(msg='Failed to update apt cache: %s' % (err if err else 'unknown reason'))
+                        msg = (
+                            f"Failed to update apt cache after {update_cache_retries} retries: "
+                            f"{err if err else 'unknown reason'}"
+                        )
+                        module.fail_json(msg=msg)
 
                     cache.open(progress=None)
                     mtimestamp, post_cache_update_time = get_updated_cache_time()

ansible/modules/apt_key.py

@@ -26,13 +26,13 @@ attributes:
     platform:
         platforms: debian
 notes:
-    - The apt-key command used by this module has been deprecated. See the L(Debian wiki,https://wiki.debian.org/DebianRepository/UseThirdParty) for details.
-      This module is kept for backwards compatibility for systems that still use apt-key as the main way to manage apt repository keys.
+    - The C(apt-key) command used by this module has been deprecated. See the L(Debian wiki,https://wiki.debian.org/DebianRepository/UseThirdParty) for details.
+      This module is kept for backwards compatibility for systems that still use C(apt-key) as the main way to manage apt repository keys.
     - As a sanity check, downloaded key id must match the one specified.
     - "Use full fingerprint (40 characters) key ids to avoid key collisions.
       To generate a full-fingerprint imported key: C(apt-key adv --list-public-keys --with-fingerprint --with-colons)."
-    - If you specify both the key id and the URL with O(state=present), the task can verify or add the key as needed.
-    - Adding a new key requires an apt cache update (e.g. using the M(ansible.builtin.apt) module's update_cache option).
+    - If you specify both the key O(id) and the O(url) with O(state=present), the task can verify or add the key as needed.
+    - Adding a new key requires an apt cache update (e.g. using the M(ansible.builtin.apt) module's C(update_cache) option).
 requirements:
     - gpg
 seealso:
@@ -42,7 +42,7 @@ options:
         description:
             - The identifier of the key.
             - Including this allows check mode to correctly report the changed state.
-            - If specifying a subkey's id be aware that apt-key does not understand how to remove keys via a subkey id.  Specify the primary key's id instead.
+            - If specifying a subkey's id be aware that apt-key does not understand how to remove keys via a subkey id. Specify the primary key's id instead.
             - This parameter is required when O(state) is set to V(absent).
         type: str
     data:
@@ -188,7 +188,7 @@ def lang_env(module):
 
     if not hasattr(lang_env, 'result'):
         locale = get_best_parsable_locale(module)
-        lang_env.result = dict(LANG=locale, LC_ALL=locale, LC_MESSAGES=locale)
+        lang_env.result = dict(LANG=locale, LC_ALL=locale, LC_MESSAGES=locale, LANGUAGE=locale)
 
     return lang_env.result