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

ansible/modules/git.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: git
 author:
@@ -21,6 +21,10 @@ options:
     repo:
         description:
             - git, SSH, or HTTP(S) protocol address of the git repository.
+            - Avoid embedding usernames and passwords within Git repository URLs.
+              This practice is insecure and can lead to unauthorized access to your repositories.
+              For secure authentication, configure SSH keys (recommended) or use a credential helper.
+              See Git documentation on SSH keys/credential helpers for instructions.
         type: str
         required: true
         aliases: [ name ]
@@ -236,9 +240,9 @@ notes:
       one solution is to use the option accept_hostkey. Another solution is to
       add the remote host public key in C(/etc/ssh/ssh_known_hosts) before calling
       the git module, with the following command: C(ssh-keyscan -H remote_host.com >> /etc/ssh/ssh_known_hosts)."
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Git checkout
   ansible.builtin.git:
     repo: 'https://github.com/ansible/ansible.git'
@@ -295,9 +299,9 @@ EXAMPLES = '''
   environment:
     GIT_TERMINAL_PROMPT: 0 # reports "terminal prompts disabled" on missing password
     # or GIT_ASKPASS: /bin/true # for git before version 2.3.0, reports "Authentication failed" on missing password
-'''
+"""
 
-RETURN = '''
+RETURN = """
 after:
     description: Last commit revision of the repository retrieved during the update.
     returned: success
@@ -313,11 +317,6 @@ remote_url_changed:
     returned: success
     type: bool
     sample: True
-warnings:
-    description: List of warnings if requested features were not available due to a too old git version.
-    returned: error
-    type: str
-    sample: git version is too old to fully support the depth argument. Falling back to full checkouts.
 git_dir_now:
     description: Contains the new path of .git directory if it is changed.
     returned: success
@@ -328,7 +327,7 @@ git_dir_before:
     returned: success
     type: str
     sample: /path/to/old/git/dir
-'''
+"""
 
 import filecmp
 import os
@@ -358,24 +357,23 @@ def relocate_repo(module, result, repo_dir, old_repo_dir, worktree_dir):
                 dot_git_file.write('gitdir: %s' % repo_dir)
             result['git_dir_before'] = old_repo_dir
             result['git_dir_now'] = repo_dir
-        except (IOError, OSError) as err:
+        except OSError as ex:
             # if we already moved the .git dir, roll it back
             if os.path.exists(repo_dir):
                 shutil.move(repo_dir, old_repo_dir)
-            module.fail_json(msg=u'Unable to move git dir. %s' % to_text(err))
+            raise Exception('Unable to move git dir.') from ex
 
 
 def head_splitter(headfile, remote, module=None, fail_on_error=False):
-    '''Extract the head reference'''
+    """Extract the head reference"""
     # https://github.com/ansible/ansible-modules-core/pull/907
 
     res = None
     if os.path.exists(headfile):
         rawdata = None
         try:
-            f = open(headfile, 'r')
-            rawdata = f.readline()
-            f.close()
+            with open(headfile, 'r') as f:
+                rawdata = f.readline()
         except Exception:
             if fail_on_error and module:
                 module.fail_json(msg="Unable to read %s" % headfile)
@@ -429,11 +427,11 @@ def get_submodule_update_params(module, git_path, cwd):
 
 
 def write_ssh_wrapper(module):
-    '''
+    """
         This writes an shell wrapper for ssh options to be used with git
         this is only relevant for older versions of gitthat cannot
         handle the options themselves. Returns path to the script
-    '''
+    """
     try:
         # make sure we have full permission to the module_dir, which
         # may not be the case if we're sudo'ing to a non-root user
@@ -441,7 +439,7 @@ def write_ssh_wrapper(module):
             fd, wrapper_path = tempfile.mkstemp(prefix=module.tmpdir + '/')
         else:
             raise OSError
-    except (IOError, OSError):
+    except OSError:
         fd, wrapper_path = tempfile.mkstemp()
 
     # use existing git_ssh/ssh_command, fallback to 'ssh'
@@ -466,10 +464,10 @@ def write_ssh_wrapper(module):
 
 
 def set_git_ssh_env(key_file, ssh_opts, git_version, module):
-    '''
+    """
         use environment variables to configure git's ssh execution,
         which varies by version but this function should handle all.
-    '''
+    """
 
     # initialise to existing ssh opts and/or append user provided
     if ssh_opts is None:
@@ -519,7 +517,7 @@ def set_git_ssh_env(key_file, ssh_opts, git_version, module):
 
 
 def get_version(module, git_path, dest, ref="HEAD"):
-    ''' samples the version of the git repo '''
+    """ samples the version of the git repo """
 
     cmd = "%s rev-parse %s" % (git_path, ref)
     rc, stdout, stderr = module.run_command(cmd, cwd=dest)
@@ -571,7 +569,7 @@ def get_submodule_versions(git_path, module, dest, version='HEAD'):
 
 def clone(git_path, module, repo, dest, remote, depth, version, bare,
           reference, refspec, git_version_used, verify_commit, separate_git_dir, result, gpg_allowlist, single_branch):
-    ''' makes a new git repo if it does not already exist '''
+    """ makes a new git repo if it does not already exist """
     dest_dirname = os.path.dirname(dest)
     try:
         os.makedirs(dest_dirname)
@@ -653,17 +651,17 @@ def has_local_mods(module, git_path, dest, bare):
 
 
 def reset(git_path, module, dest):
-    '''
+    """
     Resets the index and working tree to HEAD.
     Discards any changes to tracked files in working
     tree since that commit.
-    '''
+    """
     cmd = "%s reset --hard HEAD" % (git_path,)
     return module.run_command(cmd, check_rc=True, cwd=dest)
 
 
 def get_diff(module, git_path, dest, repo, remote, depth, bare, before, after):
-    ''' Return the difference between 2 versions '''
+    """ Return the difference between 2 versions """
     if before is None:
         return {'prepared': '>> Newly checked out %s' % after}
     elif before != after:
@@ -817,22 +815,23 @@ def get_repo_path(dest, bare):
 
 
 def get_head_branch(git_path, module, dest, remote, bare=False):
-    '''
+    """
     Determine what branch HEAD is associated with.  This is partly
     taken from lib/ansible/utils/__init__.py.  It finds the correct
     path to .git/HEAD and reads from that file the branch that HEAD is
     associated with.  In the case of a detached HEAD, this will look
     up the branch in .git/refs/remotes/<remote>/HEAD.
-    '''
+    """
     try:
         repo_path = get_repo_path(dest, bare)
-    except (IOError, ValueError) as err:
+    except (OSError, ValueError) as ex:
         # No repo path found
         # ``.git`` file does not have a valid format for detached Git dir.
         module.fail_json(
             msg='Current repo does not have a valid reference to a '
             'separate Git dir or it refers to the invalid path',
-            details=to_text(err),
+            details=str(ex),
+            exception=ex,
         )
     # Read .git/HEAD for the name of the branch.
     # If we're in a detached HEAD state, look up the branch associated with
@@ -845,7 +844,7 @@ def get_head_branch(git_path, module, dest, remote, bare=False):
 
 
 def get_remote_url(git_path, module, dest, remote):
-    '''Return URL of remote source for repo.'''
+    """Return URL of remote source for repo."""
     command = [git_path, 'ls-remote', '--get-url', remote]
     (rc, out, err) = module.run_command(command, cwd=dest)
     if rc != 0:
@@ -856,7 +855,7 @@ def get_remote_url(git_path, module, dest, remote):
 
 
 def set_remote_url(git_path, module, repo, dest, remote):
-    ''' updates repo from remote sources '''
+    """ updates repo from remote sources """
     # Return if remote URL isn't changing.
     remote_url = get_remote_url(git_path, module, dest, remote)
     if remote_url == repo or unfrackgitpath(remote_url) == unfrackgitpath(repo):
@@ -874,7 +873,7 @@ def set_remote_url(git_path, module, repo, dest, remote):
 
 
 def fetch(git_path, module, repo, dest, version, remote, depth, bare, refspec, git_version_used, force=False):
-    ''' updates repo from remote sources '''
+    """ updates repo from remote sources """
     set_remote_url(git_path, module, repo, dest, remote)
     commands = []
 
@@ -981,7 +980,7 @@ def submodules_fetch(git_path, module, remote, track_submodules, dest):
 
 
 def submodule_update(git_path, module, dest, track_submodules, force=False):
-    ''' init and update any submodules '''
+    """ init and update any submodules """
 
     # get the valid submodule params
     params = get_submodule_update_params(module, git_path, dest)
@@ -1237,7 +1236,7 @@ def main():
     archive_prefix = module.params['archive_prefix']
     separate_git_dir = module.params['separate_git_dir']
 
-    result = dict(changed=False, warnings=list())
+    result = dict(changed=False)
 
     if module.params['accept_hostkey']:
         if ssh_opts is not None:
@@ -1292,13 +1291,14 @@ def main():
                 if not module.check_mode:
                     relocate_repo(module, result, separate_git_dir, repo_path, dest)
                     repo_path = separate_git_dir
-        except (IOError, ValueError) as err:
+        except (OSError, ValueError) as ex:
             # No repo path found
             # ``.git`` file does not have a valid format for detached Git dir.
             module.fail_json(
                 msg='Current repo does not have a valid reference to a '
                 'separate Git dir or it refers to the invalid path',
-                details=to_text(err),
+                details=str(ex),
+                exception=ex,
             )
         gitconfig = os.path.join(repo_path, 'config')
 

ansible/modules/group.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: group
 version_added: "0.0.2"
@@ -91,9 +91,9 @@ seealso:
 - module: ansible.windows.win_group
 author:
 - Stephen Fromm (@sfromm)
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Ensure group "somegroup" exists
   ansible.builtin.group:
     name: somegroup
@@ -104,9 +104,9 @@ EXAMPLES = '''
     name: docker
     state: present
     gid: 1750
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 gid:
   description: Group ID of the group.
   returned: When O(state) is C(present)
@@ -127,7 +127,7 @@ system:
   returned: When O(state) is C(present)
   type: bool
   sample: False
-'''
+"""
 
 import grp
 import os

ansible/modules/group_by.py

@@ -7,7 +7,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: group_by
 short_description: Create Ansible groups based on facts
@@ -65,9 +65,9 @@ seealso:
 - module: ansible.builtin.add_host
 author:
 - Jeroen Hoekx (@jhoekx)
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Create groups based on the machine architecture
   ansible.builtin.group_by:
     key: machine_{{ ansible_machine }}
@@ -85,4 +85,4 @@ EXAMPLES = r'''
 - name: Add all active hosts to a static group
   ansible.builtin.group_by:
     key: done
-'''
+"""

ansible/modules/hostname.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python
 # -*- coding: utf-8 -*-
 
 # Copyright: (c) 2013, Hiroaki Nakamura <hnakamur@gmail.com>
@@ -7,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: hostname
 author:
@@ -52,9 +51,9 @@ attributes:
         support: full
     platform:
         platforms: posix
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Set a hostname
   ansible.builtin.hostname:
     name: web01
@@ -63,14 +62,12 @@ EXAMPLES = '''
   ansible.builtin.hostname:
     name: web01
     use: systemd
-'''
+"""
 
 import os
 import platform
 import socket
-import traceback
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.basic import (
     AnsibleModule,
@@ -209,17 +206,14 @@ class FileStrategy(BaseStrategy):
             return get_file_content(self.FILE, default='', strip=True)
         except Exception as e:
             self.module.fail_json(
-                msg="failed to read hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+                msg="failed to read hostname: %s" % to_native(e))
 
     def set_permanent_hostname(self, name):
         try:
             with open(self.FILE, 'w+') as f:
                 f.write("%s\n" % name)
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to update hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to update hostname: %s" % to_native(e))
 
 
 class SLESStrategy(FileStrategy):
@@ -249,8 +243,7 @@ class RedHatStrategy(BaseStrategy):
             )
         except Exception as e:
             self.module.fail_json(
-                msg="failed to read hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+                msg="failed to read hostname: %s" % to_native(e))
 
     def set_permanent_hostname(self, name):
         try:
@@ -269,9 +262,7 @@ class RedHatStrategy(BaseStrategy):
             with open(self.NETWORK_FILE, 'w+') as f:
                 f.writelines(lines)
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to update hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to update hostname: %s" % to_native(e))
 
 
 class AlpineStrategy(FileStrategy):
@@ -361,9 +352,7 @@ class OpenRCStrategy(BaseStrategy):
                 if line.startswith('hostname='):
                     return line[10:].strip('"')
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to read hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to read hostname: %s" % to_native(e))
 
     def set_permanent_hostname(self, name):
         try:
@@ -377,9 +366,7 @@ class OpenRCStrategy(BaseStrategy):
             with open(self.FILE, 'w') as f:
                 f.write('\n'.join(lines) + '\n')
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to update hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to update hostname: %s" % to_native(e))
 
 
 class OpenBSDStrategy(FileStrategy):
@@ -481,9 +468,7 @@ class FreeBSDStrategy(BaseStrategy):
                 if line.startswith('hostname='):
                     return line[10:].strip('"')
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to read hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to read hostname: %s" % to_native(e))
 
     def set_permanent_hostname(self, name):
         try:
@@ -500,9 +485,7 @@ class FreeBSDStrategy(BaseStrategy):
             with open(self.FILE, 'w') as f:
                 f.write('\n'.join(lines) + '\n')
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to update hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to update hostname: %s" % to_native(e))
 
 
 class DarwinStrategy(BaseStrategy):
@@ -625,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/import_playbook.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 author: Ansible Core Team (@ansible)
 module: import_playbook
@@ -42,9 +42,9 @@ seealso:
 - module: ansible.builtin.include_tasks
 - ref: playbooks_reuse
   description: More information related to including and importing playbooks, roles and tasks.
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - hosts: localhost
   tasks:
     - ansible.builtin.debug:
@@ -69,8 +69,8 @@ EXAMPLES = r'''
 
     - name: This fails because I'm inside a play already
       ansible.builtin.import_playbook: stuff.yaml
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 # This module does not return anything except plays to execute.
-'''
+"""

ansible/modules/import_role.py

@@ -5,7 +5,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 author: Ansible Core Team (@ansible)
 module: import_role
@@ -87,9 +87,9 @@ seealso:
 - module: ansible.builtin.include_tasks
 - ref: playbooks_reuse
   description: More information related to including and importing playbooks, roles and tasks.
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - hosts: all
   tasks:
     - ansible.builtin.import_role:
@@ -110,8 +110,8 @@ EXAMPLES = r'''
       ansible.builtin.import_role:
         name: myrole
       when: not idontwanttorun
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 # This module does not return anything except tasks to execute.
-'''
+"""

ansible/modules/import_tasks.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 author: Ansible Core Team (@ansible)
 module: import_tasks
@@ -46,9 +46,9 @@ seealso:
 - module: ansible.builtin.include_tasks
 - ref: playbooks_reuse
   description: More information related to including and importing playbooks, roles and tasks.
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - hosts: all
   tasks:
     - ansible.builtin.debug:
@@ -69,8 +69,8 @@ EXAMPLES = r'''
     - name: Apply conditional to all imported tasks
       ansible.builtin.import_tasks: stuff.yaml
       when: hostvar is defined
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 # This module does not return anything except tasks to execute.
-'''
+"""

ansible/modules/include_role.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 author: Ansible Core Team (@ansible)
 module: include_role
@@ -92,9 +92,9 @@ seealso:
 - module: ansible.builtin.include_tasks
 - ref: playbooks_reuse
   description: More information related to including and importing playbooks, roles and tasks.
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - ansible.builtin.include_role:
     name: myrole
 
@@ -131,8 +131,8 @@ EXAMPLES = r'''
         - install
   tags:
     - always
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 # This module does not return anything except tasks to execute.
-'''
+"""

ansible/modules/include_tasks.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 author: Ansible Core Team (@ansible)
 module: include_tasks
@@ -50,9 +50,9 @@ seealso:
 - module: ansible.builtin.include_role
 - ref: playbooks_reuse
   description: More information related to including and importing playbooks, roles and tasks.
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - hosts: all
   tasks:
     - ansible.builtin.debug:
@@ -91,8 +91,8 @@ EXAMPLES = r'''
         - install
   tags:
     - always
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 # This module does not return anything except tasks to execute.
-'''
+"""

ansible/modules/include_vars.py

@@ -5,7 +5,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 author: Allen Sanabria (@linuxdynasty)
 module: include_vars
@@ -112,9 +112,9 @@ seealso:
 - module: ansible.builtin.set_fact
 - ref: playbooks_delegation
   description: More information related to task delegation.
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Include vars of stuff.yaml into the 'stuff' variable (2.2).
   ansible.builtin.include_vars:
     file: stuff.yaml
@@ -179,9 +179,9 @@ EXAMPLES = r'''
       - 'yaml'
       - 'yml'
       - 'json'
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 ansible_facts:
   description: Variables that were included and their values
   returned: success
@@ -193,4 +193,4 @@ ansible_included_var_files:
   type: list
   sample: [ /path/to/file.json, /path/to/file.yaml ]
   version_added: '2.4'
-'''
+"""