ansible-core 2.18.4rc1__py3-none-any.whl → 2.19.0b1__py3-none-any.whl

ansible/modules/dnf.py

@@ -9,7 +9,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: dnf
 version_added: 1.9
@@ -306,9 +306,9 @@ author:
   - Cristian van Ee (@DJMuggs) <cristian at cvee.org>
   - Berend De Schouwer (@berenddeschouwer)
   - Adam Miller (@maxamillion) <admiller@redhat.com>
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Install the latest version of Apache
   ansible.builtin.dnf:
     name: httpd
@@ -394,7 +394,7 @@ EXAMPLES = '''
   ansible.builtin.dnf:
     name: '@postgresql/client'
     state: present
-'''
+"""
 
 import os
 import sys
@@ -408,10 +408,10 @@ from ansible.module_utils.common.respawn import has_respawned, probe_interpreter
 from ansible.module_utils.yumdnf import YumDnf, yumdnf_argument_spec
 
 
-# NOTE dnf Python bindings import is postponed, see DnfModule._ensure_dnf(),
-# because we need AnsibleModule object to use get_best_parsable_locale()
-# to set proper locale before importing dnf to be able to scrape
-# the output in some cases (FIXME?).
+# FIXME: NOTE dnf Python bindings import is postponed, see DnfModule._ensure_dnf(),
+#  because we need AnsibleModule object to use get_best_parsable_locale()
+#  to set proper locale before importing dnf to be able to scrape
+#  the output in some cases.
 dnf = None
 
 

ansible/modules/dnf5.py

@@ -14,6 +14,12 @@ description:
     provides are implemented in M(ansible.builtin.dnf5), please consult specific options for more information."
 short_description: Manages packages with the I(dnf5) package manager
 options:
+  auto_install_module_deps:
+    description:
+      - Automatically install dependencies required to run this module.
+    type: bool
+    default: yes
+    version_added: 2.19
   name:
     description:
       - "A package name or package specifier with version, like C(name-1.0).
@@ -246,6 +252,10 @@ attributes:
         platforms: rhel
 requirements:
   - "python3-libdnf5"
+notes:
+  - If the interpreter can't import C(python3-libdnf5) the module will check for it in system-owned interpreters as well.
+    If the dependency can't be found, depending on the value of O(auto_install_module_deps) the module will attempt to install it.
+    If the dependency is found or installed, the module will be respawned under the correct interpreter.
 version_added: 2.15
 """
 
@@ -354,6 +364,8 @@ from ansible.module_utils.common.respawn import has_respawned, probe_interpreter
 from ansible.module_utils.yumdnf import YumDnf, yumdnf_argument_spec
 
 libdnf5 = None
+# Through dnf5-5.2.12 all exceptions raised through swig became RuntimeError
+LIBDNF5_ERROR = RuntimeError
 
 
 def is_installed(base, spec):
@@ -411,7 +423,7 @@ def is_newer_version_installed(base, spec):
 
     try:
         spec_nevra = next(iter(libdnf5.rpm.Nevra.parse(spec)))
-    except (RuntimeError, StopIteration):
+    except (LIBDNF5_ERROR, StopIteration):
         return False
 
     spec_version = spec_nevra.get_version()
@@ -470,6 +482,8 @@ def get_unneeded_pkgs(base):
 class Dnf5Module(YumDnf):
     def __init__(self, module):
         super(Dnf5Module, self).__init__(module)
+        self.auto_install_module_deps = self.module.params["auto_install_module_deps"]
+
         self._ensure_dnf()
 
         self.pkg_mgr_name = "dnf5"
@@ -503,12 +517,19 @@ class Dnf5Module(YumDnf):
         os.environ["LANGUAGE"] = os.environ["LANG"] = locale
 
         global libdnf5
+        global LIBDNF5_ERROR
         has_dnf = True
         try:
             import libdnf5  # type: ignore[import]
         except ImportError:
             has_dnf = False
 
+        try:
+            import libdnf5.exception  # type: ignore[import-not-found]
+            LIBDNF5_ERROR = libdnf5.exception.Error
+        except (ImportError, AttributeError):
+            pass
+
         if has_dnf:
             return
 
@@ -519,21 +540,30 @@ class Dnf5Module(YumDnf):
         ]
 
         if not has_respawned():
-            # probe well-known system Python locations for accessible bindings, favoring py3
-            interpreter = probe_interpreters_for_module(system_interpreters, "libdnf5")
-
-            if interpreter:
-                # respawn under the interpreter where the bindings should be found
-                respawn_module(interpreter)
-                # end of the line for this module, the process will exit here once the respawned module completes
+            for attempt in (1, 2):
+                # probe well-known system Python locations for accessible bindings
+                interpreter = probe_interpreters_for_module(system_interpreters, "libdnf5")
+                if interpreter:
+                    # respawn under the interpreter where the bindings should be found
+                    respawn_module(interpreter)
+                    # end of the line for this module, the process will exit here once the respawned module completes
+                if attempt == 1:
+                    if self.module.check_mode:
+                        self.module.fail_json(
+                            msg="python3-libdnf5 must be installed to use check mode. "
+                                "If run normally this module can auto-install it, "
+                                "see the auto_install_module_deps option.",
+                        )
+                    elif self.auto_install_module_deps:
+                        self.module.run_command(["dnf", "install", "-y", "python3-libdnf5"], check_rc=True)
+                    else:
+                        break
 
-        # done all we can do, something is just broken (auto-install isn't useful anymore with respawn, so it was removed)
+        py_version = sys.version.replace("\n", "")
         self.module.fail_json(
-            msg="Could not import the libdnf5 python module using {0} ({1}). "
-            "Please install python3-libdnf5 package or ensure you have specified the "
-            "correct ansible_python_interpreter. (attempted {2})".format(
-                sys.executable, sys.version.replace("\n", ""), system_interpreters
-            ),
+            msg=f"Could not import the libdnf5 python module using {sys.executable} ({py_version}). "
+            "Ensure python3-libdnf5 package is installed (either manually or via the auto_install_module_deps option) "
+            f"or that you have specified the correct ansible_python_interpreter. (attempted {system_interpreters}).",
             failures=[],
         )
 
@@ -553,7 +583,7 @@ class Dnf5Module(YumDnf):
 
         try:
             base.load_config()
-        except RuntimeError as e:
+        except LIBDNF5_ERROR as e:
             self.module.fail_json(
                 msg=str(e),
                 conf_file=self.conf_file,
@@ -716,7 +746,7 @@ class Dnf5Module(YumDnf):
             for spec in self.names:
                 try:
                     goal.add_remove(spec, settings)
-                except RuntimeError as e:
+                except LIBDNF5_ERROR as e:
                     self.module.fail_json(msg=str(e), failures=[], rc=1)
             if self.autoremove:
                 for pkg in get_unneeded_pkgs(base):
@@ -725,7 +755,7 @@ class Dnf5Module(YumDnf):
         goal.set_allow_erasing(self.allowerasing)
         try:
             transaction = goal.resolve()
-        except RuntimeError as e:
+        except LIBDNF5_ERROR as e:
             self.module.fail_json(msg=str(e), failures=[], rc=1)
 
         if transaction.get_problems():
@@ -797,6 +827,11 @@ class Dnf5Module(YumDnf):
 
 
 def main():
+    yumdnf_argument_spec["argument_spec"].update(
+        dict(
+            auto_install_module_deps=dict(type="bool", default=True),
+        )
+    )
     Dnf5Module(AnsibleModule(**yumdnf_argument_spec)).run()
 
 

ansible/modules/dpkg_selections.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: dpkg_selections
 short_description: Dpkg package selection selections
@@ -39,8 +39,8 @@ attributes:
         platforms: debian
 notes:
     - This module will not cause any packages to be installed/removed/purged, use the M(ansible.builtin.apt) module for that.
-'''
-EXAMPLES = '''
+"""
+EXAMPLES = """
 - name: Prevent python from being upgraded
   ansible.builtin.dpkg_selections:
     name: python
@@ -50,7 +50,7 @@ EXAMPLES = '''
   ansible.builtin.dpkg_selections:
     name: python
     selection: install
-'''
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.common.locale import get_best_parsable_locale

ansible/modules/expect.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: expect
 version_added: '2.0'
@@ -83,9 +83,9 @@ seealso:
 - module: ansible.builtin.script
 - module: ansible.builtin.shell
 author: "Matt Martz (@sivel)"
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Case insensitive password string match
   ansible.builtin.expect:
     command: passwd username
@@ -116,18 +116,17 @@ EXAMPLES = r'''
             - "{{ db_username }}"
         "Database password":
             - "{{ db_password }}"
-'''
+"""
 
 import datetime
 import os
-import traceback
 
 PEXPECT_IMP_ERR = None
 try:
     import pexpect
     HAS_PEXPECT = True
-except ImportError:
-    PEXPECT_IMP_ERR = traceback.format_exc()
+except ImportError as ex:
+    PEXPECT_IMP_ERR = ex
     HAS_PEXPECT = False
 
 from ansible.module_utils.basic import AnsibleModule, missing_required_lib
@@ -164,8 +163,7 @@ def main():
     )
 
     if not HAS_PEXPECT:
-        module.fail_json(msg=missing_required_lib("pexpect"),
-                         exception=PEXPECT_IMP_ERR)
+        module.fail_json(msg=missing_required_lib("pexpect"), exception=PEXPECT_IMP_ERR)
 
     chdir = module.params['chdir']
     args = module.params['command']
@@ -246,7 +244,7 @@ def main():
                              '(%s), this module requires pexpect>=3.3. '
                              'Error was %s' % (pexpect.__version__, to_native(e)))
     except pexpect.ExceptionPexpect as e:
-        module.fail_json(msg='%s' % to_native(e), exception=traceback.format_exc())
+        module.fail_json(msg='%s' % to_native(e))
 
     endd = datetime.datetime.now()
     delta = endd - startd

ansible/modules/fail.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: fail
 short_description: Fail with custom message
@@ -52,11 +52,11 @@ seealso:
 - module: ansible.builtin.meta
 author:
 - Dag Wieers (@dagwieers)
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Example using fail and when together
   ansible.builtin.fail:
     msg: The system may not be provisioned according to the CMDB status.
   when: cmdb_status != "to-be-staged"
-'''
+"""

ansible/modules/fetch.py

@@ -8,7 +8,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: fetch
 short_description: Fetch files from remote nodes
@@ -95,9 +95,9 @@ seealso:
 author:
 - Ansible Core Team
 - Michael DeHaan
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Store file into /tmp/fetched/host.example.com/tmp/somefile
   ansible.builtin.fetch:
     src: /tmp/somefile
@@ -120,4 +120,4 @@ EXAMPLES = r'''
     src: /tmp/uniquefile
     dest: special/prefix-{{ inventory_hostname }}
     flat: yes
-'''
+"""