ansible-core 2.18.7rc1__py3-none-any.whl → 2.19.0__py3-none-any.whl

ansible/modules/setup.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: setup
 version_added: historical
@@ -110,7 +110,7 @@ notes:
 author:
     - "Ansible Core Team"
     - "Michael DeHaan"
-'''
+"""
 
 EXAMPLES = r"""
 # Display facts from all hosts and store them indexed by `hostname` at `/tmp/facts`.

ansible/modules/shell.py

@@ -10,7 +10,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: shell
 short_description: Execute shell commands on targets
@@ -99,9 +99,9 @@ seealso:
 author:
     - Ansible Core Team
     - Michael DeHaan
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Execute the command in remote shell; stdout goes to the specified file on the remote
   ansible.builtin.shell: somescript.sh >> somelog.txt
 
@@ -150,9 +150,9 @@ EXAMPLES = r'''
   args:
     executable: /usr/bin/expect
   delegate_to: localhost
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 msg:
     description: changed
     returned: always
@@ -203,4 +203,4 @@ stderr_lines:
     returned: always
     type: list
     sample: [u'ls cannot access foo: No such file or directory', u'ls …']
-'''
+"""

ansible/modules/slurp.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: slurp
 version_added: historical
@@ -39,9 +39,9 @@ seealso:
 author:
     - Ansible Core Team
     - Michael DeHaan (@mpdehaan)
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Find out what the remote machine's mounts are
   ansible.builtin.slurp:
     src: /proc/mounts
@@ -61,9 +61,9 @@ EXAMPLES = r'''
 # }
 # $ echo MjE3OQo= | base64 -d
 # 2179
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 content:
     description: Encoded file content
     returned: success
@@ -79,13 +79,12 @@ source:
     returned: success
     type: str
     sample: "/var/run/sshd.pid"
-'''
+"""
 
 import base64
 import errno
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.common.text.converters import to_native
 
 
 def main():
@@ -99,20 +98,18 @@ def main():
 
     try:
         with open(source, 'rb') as source_fh:
-            source_content = source_fh.read()
-    except (IOError, OSError) as e:
-        if e.errno == errno.ENOENT:
-            msg = "file not found: %s" % source
-        elif e.errno == errno.EACCES:
-            msg = "file is not readable: %s" % source
-        elif e.errno == errno.EISDIR:
-            msg = "source is a directory and must be a file: %s" % source
+            data = base64.b64encode(source_fh.read())
+    except OSError as ex:
+        if ex.errno == errno.ENOENT:
+            msg = f"File not found: {source}"
+        elif ex.errno == errno.EACCES:
+            msg = f"File is not readable: {source}"
+        elif ex.errno == errno.EISDIR:
+            msg = f"Source is a directory and must be a file: {source}"
         else:
-            msg = "unable to slurp file: %s" % to_native(e, errors='surrogate_then_replace')
+            msg = "Unable to slurp file: {source}"
 
-        module.fail_json(msg)
-
-    data = base64.b64encode(source_content)
+        module.fail_json(msg, exception=ex)
 
     module.exit_json(content=data, source=source, encoding='base64')
 

ansible/modules/stat.py

@@ -5,7 +5,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: stat
 version_added: "1.3"
@@ -25,23 +25,6 @@ options:
       - Whether to follow symlinks.
     type: bool
     default: no
-  get_checksum:
-    description:
-      - Whether to return a checksum of the file.
-    type: bool
-    default: yes
-    version_added: "1.8"
-  checksum_algorithm:
-    description:
-      - Algorithm to determine checksum of file.
-      - Will throw an error if the host is unable to use specified algorithm.
-      - The remote host has to support the hashing method specified, V(md5)
-        can be unavailable if the host is FIPS-140 compliant.
-    type: str
-    choices: [ md5, sha1, sha224, sha256, sha384, sha512 ]
-    default: sha1
-    aliases: [ checksum, checksum_algo ]
-    version_added: "2.0"
   get_mime:
     description:
       - Use file magic and return data about the nature of the file. This uses
@@ -59,8 +42,11 @@ options:
     default: yes
     aliases: [ attr, attributes ]
     version_added: "2.3"
+  get_checksum:
+    version_added: "1.8"
 extends_documentation_fragment:
   -  action_common_attributes
+  -  checksum_common
 attributes:
     check_mode:
         support: full
@@ -72,9 +58,9 @@ seealso:
 - module: ansible.builtin.file
 - module: ansible.windows.win_stat
 author: Bruce Pennypacker (@bpennypacker)
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 # Obtain the stats of /etc/foo.conf, and check that the file still belongs
 # to 'root'. Fail otherwise.
 - name: Get stats of a file
@@ -137,9 +123,9 @@ EXAMPLES = r'''
   ansible.builtin.stat:
     path: /path/to/something
     checksum_algorithm: sha256
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 stat:
     description: Dictionary containing all the stat data, some platforms might add additional fields.
     returned: success
@@ -366,9 +352,8 @@ stat:
             type: str
             sample: "381700746"
             version_added: 2.3
-'''
+"""
 
-import errno
 import grp
 import os
 import pwd
@@ -423,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
@@ -470,12 +455,11 @@ def main():
             st = os.stat(b_path)
         else:
             st = os.lstat(b_path)
-    except OSError as e:
-        if e.errno == errno.ENOENT:
-            output = {'exists': False}
-            module.exit_json(changed=False, stat=output)
-
-        module.fail_json(msg=e.strerror)
+    except FileNotFoundError:
+        output = {'exists': False}
+        module.exit_json(changed=False, stat=output)
+    except OSError as ex:
+        module.fail_json(msg=ex.strerror, exception=ex)
 
     # process base results
     output = format_output(module, path, st)

ansible/modules/subversion.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: subversion
 short_description: Deploys a subversion repository
@@ -106,9 +106,9 @@ notes:
 
 requirements:
     - subversion (the command line tool with C(svn) entrypoint)
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Checkout subversion repository to specified folder
   ansible.builtin.subversion:
     repo: svn+ssh://an.example.org/path/to/repo
@@ -126,9 +126,9 @@ EXAMPLES = '''
     dest: /src/checkout
     checkout: no
     update: no
-'''
+"""
 
-RETURN = r'''#'''
+RETURN = r"""#"""
 
 import os
 import re
@@ -161,7 +161,7 @@ class Subversion(object):
         return LooseVersion(version) >= LooseVersion('1.10.0')
 
     def _exec(self, args, check_rc=True):
-        '''Execute a subversion command, and return output. If check_rc is False, returns the return code instead of the output.'''
+        """Execute a subversion command, and return output. If check_rc is False, returns the return code instead of the output."""
         bits = [
             self.svn_path,
             '--non-interactive',
@@ -189,12 +189,12 @@ class Subversion(object):
             return rc
 
     def is_svn_repo(self):
-        '''Checks if path is a SVN Repo.'''
+        """Checks if path is a SVN Repo."""
         rc = self._exec(["info", self.dest], check_rc=False)
         return rc == 0
 
     def checkout(self, force=False):
-        '''Creates new svn working directory if it does not already exist.'''
+        """Creates new svn working directory if it does not already exist."""
         cmd = ["checkout"]
         if force:
             cmd.append("--force")
@@ -202,7 +202,7 @@ class Subversion(object):
         self._exec(cmd)
 
     def export(self, force=False):
-        '''Export svn repo to directory'''
+        """Export svn repo to directory"""
         cmd = ["export"]
         if force:
             cmd.append("--force")
@@ -211,7 +211,7 @@ class Subversion(object):
         self._exec(cmd)
 
     def switch(self):
-        '''Change working directory's repo.'''
+        """Change working directory's repo."""
         # switch to ensure we are pointing at correct repo.
         # it also updates!
         output = self._exec(["switch", "--revision", self.revision, self.repo, self.dest])
@@ -221,7 +221,7 @@ class Subversion(object):
         return False
 
     def update(self):
-        '''Update existing svn working directory.'''
+        """Update existing svn working directory."""
         output = self._exec(["update", "-r", self.revision, self.dest])
 
         for line in output:
@@ -230,7 +230,7 @@ class Subversion(object):
         return False
 
     def revert(self):
-        '''Revert svn working directory.'''
+        """Revert svn working directory."""
         output = self._exec(["revert", "-R", self.dest])
         for line in output:
             if re.search(r'^Reverted ', line) is None:
@@ -238,7 +238,7 @@ class Subversion(object):
         return False
 
     def get_revision(self):
-        '''Revision and URL of subversion working directory.'''
+        """Revision and URL of subversion working directory."""
         text = '\n'.join(self._exec(["info", self.dest]))
         rev = re.search(self.REVISION_RE, text, re.MULTILINE)
         if rev:
@@ -255,7 +255,7 @@ class Subversion(object):
         return rev, url
 
     def get_remote_revision(self):
-        '''Revision and URL of subversion working directory.'''
+        """Revision and URL of subversion working directory."""
         text = '\n'.join(self._exec(["info", self.repo]))
         rev = re.search(self.REVISION_RE, text, re.MULTILINE)
         if rev:
@@ -265,7 +265,7 @@ class Subversion(object):
         return rev
 
     def has_local_mods(self):
-        '''True if revisioned files have been added or modified. Unrevisioned files are ignored.'''
+        """True if revisioned files have been added or modified. Unrevisioned files are ignored."""
         lines = self._exec(["status", "--quiet", "--ignore-externals", self.dest])
         # The --quiet option will return only modified files.
         # Match only revisioned files, i.e. ignore status '?'.

ansible/modules/systemd.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 module: systemd_service
 author:
     - Ansible Core Team
@@ -34,7 +34,7 @@ options:
         choices: [ reloaded, restarted, started, stopped ]
     enabled:
         description:
-            - Whether the unit should start on boot. At least one of O(state) and O(enabled) are required.
+            - Whether the unit should start on boot. At least one of O(state) or O(enabled) are required.
             - If set, requires O(name).
         type: bool
     force:
@@ -98,9 +98,9 @@ notes:
       It has been reported that C(systemctl) can behave differently depending on the order of operations if you do the same manually.
 requirements:
     - A system managed by systemd.
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Make sure a service unit is running
   ansible.builtin.systemd_service:
     state: started
@@ -149,9 +149,9 @@ EXAMPLES = '''
     scope: user
   environment:
     XDG_RUNTIME_DIR: "/run/user/{{ myuid }}"
-'''
+"""
 
-RETURN = '''
+RETURN = """
 status:
     description: A dictionary with the key=value pairs returned from C(systemctl show).
     returned: success
@@ -279,7 +279,7 @@ status:
             "WatchdogTimestampMonotonic": "0",
             "WatchdogUSec": "0",
         }
-'''  # NOQA
+"""  # NOQA
 
 import os
 

ansible/modules/systemd_service.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 module: systemd_service
 author:
     - Ansible Core Team
@@ -34,7 +34,7 @@ options:
         choices: [ reloaded, restarted, started, stopped ]
     enabled:
         description:
-            - Whether the unit should start on boot. At least one of O(state) and O(enabled) are required.
+            - Whether the unit should start on boot. At least one of O(state) or O(enabled) are required.
             - If set, requires O(name).
         type: bool
     force:
@@ -98,9 +98,9 @@ notes:
       It has been reported that C(systemctl) can behave differently depending on the order of operations if you do the same manually.
 requirements:
     - A system managed by systemd.
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Make sure a service unit is running
   ansible.builtin.systemd_service:
     state: started
@@ -149,9 +149,9 @@ EXAMPLES = '''
     scope: user
   environment:
     XDG_RUNTIME_DIR: "/run/user/{{ myuid }}"
-'''
+"""
 
-RETURN = '''
+RETURN = """
 status:
     description: A dictionary with the key=value pairs returned from C(systemctl show).
     returned: success
@@ -279,7 +279,7 @@ status:
             "WatchdogTimestampMonotonic": "0",
             "WatchdogUSec": "0",
         }
-'''  # NOQA
+"""  # NOQA
 
 import os
 

ansible/modules/sysvinit.py

@@ -7,7 +7,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 module: sysvinit
 author:
     - "Ansible Core Team"
@@ -77,9 +77,9 @@ notes:
     - The service names might vary by specific OS/distribution.
 requirements:
     - That the service managed has a corresponding init script.
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Make sure apache2 is started
   ansible.builtin.sysvinit:
       name: apache2
@@ -88,9 +88,9 @@ EXAMPLES = '''
 
 - name: Sleep for 5 seconds between stop and start command of badly behaving service
   ansible.builtin.sysvinit:
-    name: apache2
-    state: restarted
-    sleep: 5
+      name: apache2
+      state: restarted
+      sleep: 5
 
 - name: Make sure apache2 is started on runlevels 3 and 5
   ansible.builtin.sysvinit:
@@ -100,9 +100,9 @@ EXAMPLES = '''
       runlevels:
         - 3
         - 5
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 results:
     description: results from actions taken
     returned: always
@@ -131,7 +131,7 @@ results:
              "stdout": "Stopping web server: apache2.\n"
           }
         }
-'''
+"""
 
 import re
 from time import sleep

ansible/modules/tempfile.py

@@ -7,7 +7,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: tempfile
 version_added: "2.3"
@@ -53,7 +53,7 @@ seealso:
 - module: ansible.windows.win_tempfile
 author:
   - Krzysztof Magosa (@krzysztof-magosa)
-'''
+"""
 
 EXAMPLES = """
 - name: Create temporary build directory
@@ -80,17 +80,16 @@ EXAMPLES = """
   when: tempfile_1.path is defined
 """
 
-RETURN = '''
+RETURN = """
 path:
   description: Path to created file or directory.
   returned: success
   type: str
   sample: "/tmp/ansible.bMlvdk"
-'''
+"""
 
 from os import close
 from tempfile import mkstemp, mkdtemp
-from traceback import format_exc
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.common.text.converters import to_native
@@ -123,7 +122,7 @@ def main():
 
         module.exit_json(changed=True, path=path)
     except Exception as e:
-        module.fail_json(msg=to_native(e), exception=format_exc())
+        module.fail_json(msg=to_native(e))
 
 
 if __name__ == '__main__':

ansible/modules/template.py

@@ -8,7 +8,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: template
 version_added: historical
@@ -60,9 +60,9 @@ attributes:
       support: full
     vault:
       support: full
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Template a file to /etc/file.conf
   ansible.builtin.template:
     src: /mytemplates/foo.j2
@@ -108,9 +108,9 @@ EXAMPLES = r'''
     mode: '0600'
     validate: /usr/sbin/sshd -t -f %s
     backup: yes
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 dest:
     description: Destination file/path, equal to the value passed to I(dest).
     returned: success
@@ -161,4 +161,4 @@ src:
     returned: changed
     type: str
     sample: /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source
-'''
+"""