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

ansible/plugins/connection/winrm.py

@@ -117,10 +117,6 @@ DOCUMENTATION = """
             - kerberos usage mode.
             - The managed option means Ansible will obtain kerberos ticket.
             - While the manual one means a ticket must already have been obtained by the user.
-            - If having issues with Ansible freezing when trying to obtain the
-              Kerberos ticket, you can either set this to V(manual) and obtain
-              it outside Ansible or install C(pexpect) through pip and try
-              again.
         choices: [managed, manual]
         vars:
           - name: ansible_winrm_kinit_mode
@@ -186,6 +182,7 @@ except ImportError:
 from ansible import constants as C
 from ansible.errors import AnsibleError, AnsibleConnectionFailure
 from ansible.errors import AnsibleFileNotFound
+from ansible.executor.powershell.module_manifest import _bootstrap_powershell_script
 from ansible.module_utils.json_utils import _filter_non_json_lines
 from ansible.module_utils.parsing.convert_bool import boolean
 from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
@@ -223,19 +220,6 @@ except ImportError as e:
     HAS_XMLTODICT = False
     XMLTODICT_IMPORT_ERR = e
 
-HAS_PEXPECT = False
-try:
-    import pexpect
-    # echo was added in pexpect 3.3+ which is newer than the RHEL package
-    # we can only use pexpect for kerb auth if echo is a valid kwarg
-    # https://github.com/ansible/ansible/issues/43462
-    if hasattr(pexpect, 'spawn'):
-        argspec = getfullargspec(pexpect.spawn.__init__)
-        if 'echo' in argspec.args:
-            HAS_PEXPECT = True
-except ImportError as e:
-    pass
-
 # used to try and parse the hostname and detect if IPv6 is being used
 try:
     import ipaddress
@@ -247,7 +231,7 @@ display = Display()
 
 
 class Connection(ConnectionBase):
-    '''WinRM connections over HTTP/HTTPS.'''
+    """WinRM connections over HTTP/HTTPS."""
 
     transport = 'winrm'
     module_implementation_preferences = ('.ps1', '.exe', '')
@@ -350,6 +334,7 @@ class Connection(ConnectionBase):
     def _kerb_auth(self, principal: str, password: str) -> None:
         if password is None:
             password = ""
+        b_password = to_bytes(password, encoding='utf-8', errors='surrogate_or_strict')
 
         self._kerb_ccache = tempfile.NamedTemporaryFile()
         display.vvvvv("creating Kerberos CC at %s" % self._kerb_ccache.name)
@@ -376,60 +361,28 @@ class Connection(ConnectionBase):
 
         kinit_cmdline.append(principal)
 
-        # pexpect runs the process in its own pty so it can correctly send
-        # the password as input even on MacOS which blocks subprocess from
-        # doing so. Unfortunately it is not available on the built in Python
-        # so we can only use it if someone has installed it
-        if HAS_PEXPECT:
-            proc_mechanism = "pexpect"
-            command = kinit_cmdline.pop(0)
-            password = to_text(password, encoding='utf-8',
-                               errors='surrogate_or_strict')
-
-            display.vvvv("calling kinit with pexpect for principal %s"
-                         % principal)
-            try:
-                child = pexpect.spawn(command, kinit_cmdline, timeout=60,
-                                      env=krb5env, echo=False)
-            except pexpect.ExceptionPexpect as err:
-                err_msg = "Kerberos auth failure when calling kinit cmd " \
-                          "'%s': %s" % (command, to_native(err))
-                raise AnsibleConnectionFailure(err_msg)
-
-            try:
-                child.expect(".*:")
-                child.sendline(password)
-            except OSError as err:
-                # child exited before the pass was sent, Ansible will raise
-                # error based on the rc below, just display the error here
-                display.vvvv("kinit with pexpect raised OSError: %s"
-                             % to_native(err))
-
-            # technically this is the stdout + stderr but to match the
-            # subprocess error checking behaviour, we will call it stderr
-            stderr = child.read()
-            child.wait()
-            rc = child.exitstatus
-        else:
-            proc_mechanism = "subprocess"
-            b_password = to_bytes(password, encoding='utf-8',
-                                  errors='surrogate_or_strict')
+        display.vvvv(f"calling kinit for principal {principal}")
 
-            display.vvvv("calling kinit with subprocess for principal %s"
-                         % principal)
-            try:
-                p = subprocess.Popen(kinit_cmdline, stdin=subprocess.PIPE,
-                                     stdout=subprocess.PIPE,
-                                     stderr=subprocess.PIPE,
-                                     env=krb5env)
+        # It is important to use start_new_session which spawns the process
+        # with setsid() to avoid it inheriting the current tty. On macOS it
+        # will force it to read from stdin rather than the tty.
+        try:
+            p = subprocess.Popen(
+                kinit_cmdline,
+                start_new_session=True,
+                stdin=subprocess.PIPE,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                env=krb5env,
+            )
 
-            except OSError as err:
-                err_msg = "Kerberos auth failure when calling kinit cmd " \
-                          "'%s': %s" % (self._kinit_cmd, to_native(err))
-                raise AnsibleConnectionFailure(err_msg)
+        except OSError as err:
+            err_msg = "Kerberos auth failure when calling kinit cmd " \
+                      "'%s': %s" % (self._kinit_cmd, to_native(err))
+            raise AnsibleConnectionFailure(err_msg)
 
-            stdout, stderr = p.communicate(b_password + b'\n')
-            rc = p.returncode != 0
+        stdout, stderr = p.communicate(b_password + b'\n')
+        rc = p.returncode
 
         if rc != 0:
             # one last attempt at making sure the password does not exist
@@ -437,16 +390,15 @@ class Connection(ConnectionBase):
             exp_msg = to_native(stderr.strip())
             exp_msg = exp_msg.replace(to_native(password), "<redacted>")
 
-            err_msg = "Kerberos auth failure for principal %s with %s: %s" \
-                      % (principal, proc_mechanism, exp_msg)
+            err_msg = f"Kerberos auth failure for principal {principal}: {exp_msg}"
             raise AnsibleConnectionFailure(err_msg)
 
         display.vvvvv("kinit succeeded for principal %s" % principal)
 
     def _winrm_connect(self) -> winrm.Protocol:
-        '''
+        """
         Establish a WinRM connection over HTTP/HTTPS.
-        '''
+        """
         display.vvv("ESTABLISH WINRM CONNECTION FOR USER: %s on PORT %s TO %s" %
                     (self._winrm_user, self._winrm_port, self._winrm_host), host=self._winrm_host)
 
@@ -627,7 +579,7 @@ class Connection(ConnectionBase):
     def _winrm_exec(
         self,
         command: str,
-        args: t.Iterable[bytes] = (),
+        args: t.Iterable[bytes | str] = (),
         from_exec: bool = False,
         stdin_iterator: t.Iterable[tuple[bytes, bool]] = None,
     ) -> tuple[int, bytes, bytes]:
@@ -652,9 +604,7 @@ class Connection(ConnectionBase):
                     self._winrm_write_stdin(command_id, stdin_iterator)
 
             except Exception as ex:
-                display.warning("ERROR DURING WINRM SEND INPUT - attempting to recover: %s %s"
-                                % (type(ex).__name__, to_text(ex)))
-                display.debug(traceback.format_exc())
+                display.error_as_warning("ERROR DURING WINRM SEND INPUT. Attempting to recover.", ex)
                 stdin_push_failed = True
 
             # Even on a failure above we try at least once to get the output
@@ -771,7 +721,13 @@ class Connection(ConnectionBase):
 
     def exec_command(self, cmd: str, in_data: bytes | None = None, sudoable: bool = True) -> tuple[int, bytes, bytes]:
         super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
-        cmd_parts = self._shell._encode_script(cmd, as_list=True, strict_mode=False, preserve_rc=False)
+
+        encoded_prefix = self._shell._encode_script('', as_list=False, strict_mode=False, preserve_rc=False)
+        if cmd.startswith(encoded_prefix):
+            # Avoid double encoding the script
+            cmd_parts = cmd.split(" ")
+        else:
+            cmd_parts = self._shell._encode_script(cmd, as_list=True, strict_mode=False, preserve_rc=False)
 
         # TODO: display something meaningful here
         display.vvv("EXEC (via pipeline wrapper)")
@@ -784,7 +740,15 @@ class Connection(ConnectionBase):
         return self._winrm_exec(cmd_parts[0], cmd_parts[1:], from_exec=True, stdin_iterator=stdin_iterator)
 
     # FUTURE: determine buffer size at runtime via remote winrm config?
-    def _put_file_stdin_iterator(self, in_path: str, out_path: str, buffer_size: int = 250000) -> t.Iterable[tuple[bytes, bool]]:
+    def _put_file_stdin_iterator(
+        self,
+        initial_stdin: bytes,
+        in_path: str,
+        out_path: str,
+        buffer_size: int = 250000,
+    ) -> t.Iterable[tuple[bytes, bool]]:
+        yield initial_stdin, False
+
         in_size = os.path.getsize(to_bytes(in_path, errors='surrogate_or_strict'))
         offset = 0
         with open(to_bytes(in_path, errors='surrogate_or_strict'), 'rb') as in_file:
@@ -806,40 +770,16 @@ class Connection(ConnectionBase):
         if not os.path.exists(to_bytes(in_path, errors='surrogate_or_strict')):
             raise AnsibleFileNotFound('file or module does not exist: "%s"' % to_native(in_path))
 
-        script_template = u'''
-            begin {{
-                $path = '{0}'
-
-                $DebugPreference = "Continue"
-                $ErrorActionPreference = "Stop"
-                Set-StrictMode -Version 2
-
-                $fd = [System.IO.File]::Create($path)
-
-                $sha1 = [System.Security.Cryptography.SHA1CryptoServiceProvider]::Create()
-
-                $bytes = @() #initialize for empty file case
-            }}
-            process {{
-               $bytes = [System.Convert]::FromBase64String($input)
-               $sha1.TransformBlock($bytes, 0, $bytes.Length, $bytes, 0) | Out-Null
-               $fd.Write($bytes, 0, $bytes.Length)
-            }}
-            end {{
-                $sha1.TransformFinalBlock($bytes, 0, 0) | Out-Null
-
-                $hash = [System.BitConverter]::ToString($sha1.Hash).Replace("-", "").ToLowerInvariant()
-
-                $fd.Close()
-
-                Write-Output "{{""sha1"":""$hash""}}"
-            }}
-        '''
-
-        script = script_template.format(self._shell._escape(out_path))
-        cmd_parts = self._shell._encode_script(script, as_list=True, strict_mode=False, preserve_rc=False)
+        copy_script, copy_script_stdin = _bootstrap_powershell_script('winrm_put_file.ps1', {
+            'Path': out_path,
+        }, has_input=True)
+        cmd_parts = self._shell._encode_script(copy_script, as_list=True, strict_mode=False, preserve_rc=False)
 
-        status_code, b_stdout, b_stderr = self._winrm_exec(cmd_parts[0], cmd_parts[1:], stdin_iterator=self._put_file_stdin_iterator(in_path, out_path))
+        status_code, b_stdout, b_stderr = self._winrm_exec(
+            cmd_parts[0],
+            cmd_parts[1:],
+            stdin_iterator=self._put_file_stdin_iterator(copy_script_stdin, in_path, out_path),
+        )
         stdout = to_text(b_stdout)
         stderr = to_text(b_stderr)
 
@@ -873,36 +813,14 @@ class Connection(ConnectionBase):
             offset = 0
             while True:
                 try:
-                    script = '''
-                        $path = '%(path)s'
-                        If (Test-Path -LiteralPath $path -PathType Leaf)
-                        {
-                            $buffer_size = %(buffer_size)d
-                            $offset = %(offset)d
-
-                            $stream = New-Object -TypeName IO.FileStream($path, [IO.FileMode]::Open, [IO.FileAccess]::Read, [IO.FileShare]::ReadWrite)
-                            $stream.Seek($offset, [System.IO.SeekOrigin]::Begin) > $null
-                            $buffer = New-Object -TypeName byte[] $buffer_size
-                            $bytes_read = $stream.Read($buffer, 0, $buffer_size)
-                            if ($bytes_read -gt 0) {
-                                $bytes = $buffer[0..($bytes_read - 1)]
-                                [System.Convert]::ToBase64String($bytes)
-                            }
-                            $stream.Close() > $null
-                        }
-                        ElseIf (Test-Path -LiteralPath $path -PathType Container)
-                        {
-                            Write-Host "[DIR]";
-                        }
-                        Else
-                        {
-                            Write-Error "$path does not exist";
-                            Exit 1;
-                        }
-                    ''' % dict(buffer_size=buffer_size, path=self._shell._escape(in_path), offset=offset)
+                    script, in_data = _bootstrap_powershell_script('winrm_fetch_file.ps1', {
+                        'Path': in_path,
+                        'BufferSize': buffer_size,
+                        'Offset': offset,
+                    })
                     display.vvvvv('WINRM FETCH "%s" to "%s" (offset=%d)' % (in_path, out_path, offset), host=self._winrm_host)
                     cmd_parts = self._shell._encode_script(script, as_list=True, preserve_rc=False)
-                    status_code, b_stdout, b_stderr = self._winrm_exec(cmd_parts[0], cmd_parts[1:])
+                    status_code, b_stdout, b_stderr = self._winrm_exec(cmd_parts[0], cmd_parts[1:], stdin_iterator=self._wrapper_payload_stream(in_data))
                     stdout = to_text(b_stdout)
                     stderr = to_text(b_stderr)
 

ansible/plugins/doc_fragments/action_common_attributes.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 attributes:
     check_mode:
       description: Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.
@@ -16,17 +16,17 @@ attributes:
     platform:
       description: Target OS/families that can be operated against
       support: N/A
-'''
+"""
 
-    ACTIONGROUPS = r'''
+    ACTIONGROUPS = r"""
 attributes:
     action_group:
       description: Action is part of action_group(s), for convenient setting of module_defaults.
       support: N/A
       membership: []
-'''
+"""
 
-    CONN = r'''
+    CONN = r"""
 attributes:
     become:
       description: Is usable alongside become keywords
@@ -34,23 +34,23 @@ attributes:
       description: Uses the target's configured connection information to execute code on it
     delegation:
       description: Can be used in conjunction with delegate_to and related keywords
-'''
+"""
 
-    FACTS = r'''
+    FACTS = r"""
 attributes:
     facts:
       description: Action returns an C(ansible_facts) dictionary that will update existing host facts
-'''
+"""
 
-    FILES = r'''
+    FILES = r"""
 attributes:
     safe_file_operations:
       description: Uses Ansible's strict file operation functions to ensure proper permissions and avoid data corruption
     vault:
       description: Can automatically decrypt Ansible vaulted files
-'''
+"""
 
-    FLOW = r'''
+    FLOW = r"""
 attributes:
     action:
       description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller
@@ -62,9 +62,9 @@ attributes:
               throttle and other loop considerations
             - Conditionals will work as if C(run_once) is being used, variables used will be from the first available host
             - This action will not work normally outside of lockstep strategies
-'''
-    RAW = r'''
+"""
+    RAW = r"""
 attributes:
     raw:
       description: Indicates if an action takes a 'raw' or 'free form' string as an option and has it's own special parsing of it
-'''
+"""

ansible/plugins/doc_fragments/action_core.py

@@ -8,7 +8,7 @@ from __future__ import annotations
 class ModuleDocFragment(object):
 
     # requires action_common
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 attributes:
     async:
       support: none
@@ -33,10 +33,10 @@ attributes:
     tags:
       description: Allows for the 'tags' keyword to control the selection of this action for execution
       support: full
-'''
+"""
 
     # also requires core above
-    IMPORT = r'''
+    IMPORT = r"""
 attributes:
     action:
       details: While this action executes locally on the controller it is not governed by an action plugin
@@ -59,9 +59,9 @@ attributes:
       support: none
     until:
       support: none
-'''
+"""
     # also requires core above
-    INCLUDE = r'''
+    INCLUDE = r"""
 attributes:
     action:
       details: While this action executes locally on the controller it is not governed by an action plugin
@@ -76,4 +76,4 @@ attributes:
     tags:
       details: Tags are interpreted by this action but are not automatically inherited by the include tasks, see C(apply)
       support: partial
-'''
+"""

ansible/plugins/doc_fragments/backup.py

@@ -8,7 +8,7 @@ from __future__ import annotations
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   backup:
     description:
@@ -16,4 +16,4 @@ options:
       the original file back if you somehow clobbered it incorrectly.
     type: bool
     default: no
-'''
+"""

ansible/plugins/doc_fragments/checksum_common.py

@@ -0,0 +1,27 @@
+# Copyright (c) 2024 ShIRann Chen <shirannx@gmail.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import annotations
+
+
+class ModuleDocFragment(object):
+
+    DOCUMENTATION = r"""
+options:
+    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.
+        - Availability might be restricted by the target system, for example FIPS systems won't allow md5 use
+        type: str
+        choices: [ md5, sha1, sha224, sha256, sha384, sha512 ]
+        default: sha1
+        aliases: [ checksum, checksum_algo ]
+        version_added: "2.0"
+    get_checksum:
+        description:
+        - Whether to return a checksum of the file.
+        type: bool
+        default: yes
+"""

ansible/plugins/doc_fragments/constructed.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 
 class ModuleDocFragment(object):
 
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   strict:
     description:
@@ -79,4 +79,8 @@ options:
     type: boolean
     default: True
     version_added: '2.11'
-'''
+notes:
+  - Inventories are not finalized at this stage, so the auto populated C(all) and C(ungrouped) groups will
+    only reflect what previous inventory sources explicitly added to them.
+  - Runtime 'magic variables' are not available during inventory construction. For example, C(groups) and C(hostvars) do not exist yet.
+"""

ansible/plugins/doc_fragments/decrypt.py

@@ -8,7 +8,7 @@ from __future__ import annotations
 class ModuleDocFragment(object):
 
     # Standard files documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   decrypt:
     description:
@@ -16,4 +16,4 @@ options:
     type: bool
     default: yes
     version_added: '2.4'
-'''
+"""

ansible/plugins/doc_fragments/default_callback.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 
 class ModuleDocFragment(object):
 
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
     options:
       display_skipped_hosts:
         name: Show skipped hosts
@@ -89,4 +89,4 @@ class ModuleDocFragment(object):
           - key: show_task_path_on_failure
             section: defaults
         version_added: '2.11'
-'''
+"""

ansible/plugins/doc_fragments/files.py

@@ -11,7 +11,7 @@ class ModuleDocFragment(object):
 
     # Note: mode is overridden by the copy and template modules so if you change the description
     # here, you should also change it there.
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   mode:
     description:
@@ -88,4 +88,4 @@ options:
     type: str
     aliases: [ attr ]
     version_added: '2.3'
-'''
+"""

ansible/plugins/doc_fragments/inventory_cache.py

@@ -8,7 +8,7 @@ from __future__ import annotations
 class ModuleDocFragment(object):
 
     # inventory cache
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   cache:
     description:
@@ -70,4 +70,4 @@ options:
         key: fact_caching_prefix
       - section: inventory
         key: cache_prefix
-'''
+"""

ansible/plugins/doc_fragments/result_format_callback.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 
 class ModuleDocFragment(object):
 
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
     options:
       result_format:
         name: Format of the task result
@@ -46,4 +46,4 @@ class ModuleDocFragment(object):
           - key: callback_format_pretty
             section: defaults
         version_added: '2.13'
-'''
+"""

ansible/plugins/doc_fragments/return_common.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 
 class ModuleDocFragment(object):
     # Standard documentation fragment
-    RETURN = r'''
+    RETURN = r"""
 changed:
   description: Whether the module affected changes on the target.
   returned: always
@@ -38,4 +38,4 @@ exception:
   returned: on some errors
   type: str
   sample: Unknown error
-'''
+"""

ansible/plugins/doc_fragments/template_common.py

@@ -9,11 +9,11 @@ from __future__ import annotations
 class ModuleDocFragment(object):
 
     # Standard template documentation fragment, use by template and win_template.
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 description:
-- Templates are processed by the L(Jinja2 templating language,http://jinja.pocoo.org/docs/).
+- Templates are processed by the L(Jinja2 templating language,https://jinja.palletsprojects.com/en/stable/).
 - Documentation on the template formatting can be found in the
-  L(Template Designer Documentation,http://jinja.pocoo.org/docs/templates/).
+  L(Template Designer Documentation,https://jinja.palletsprojects.com/en/stable/templates/).
 - Additional variables listed below can be used in templates.
 - C(ansible_managed) (configurable via the C(defaults) section of C(ansible.cfg)) contains a string which can be used to
   describe the template name, host, modification time of the template file and the owner uid.
@@ -117,4 +117,4 @@ notes:
   This is the best way to prevent evaluation of things that look like, but should not be Jinja2.
 - To find Byte Order Marks in files, use C(Format-Hex <file> -Count 16) on Windows, and use C(od -a -t x1 -N 16 <file>)
   on Linux.
-'''
+"""

ansible/plugins/doc_fragments/url.py

@@ -8,7 +8,7 @@ from __future__ import annotations
 class ModuleDocFragment(object):
 
     # Standard files documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   url:
     description:
@@ -71,4 +71,20 @@ options:
     type: bool
     default: no
     version_added: '2.11'
+"""
+
+    URL_REDIRECT = r'''
+options:
+  follow_redirects:
+    description:
+      - Whether or not the URI module should follow redirects.
+    type: str
+    default: safe
+    choices:
+      all: Will follow all redirects.
+      none: Will not follow any redirects.
+      safe: Only redirects doing GET or HEAD requests will be followed.
+      urllib2: Defer to urllib2 behavior (As of writing this follows HTTP redirects).
+      'no': (DEPRECATED, removed in 2.22) alias of V(none).
+      'yes': (DEPRECATED, removed in 2.22) alias of V(all).
 '''

ansible/plugins/doc_fragments/url_windows.py

@@ -9,7 +9,7 @@ from __future__ import annotations
 class ModuleDocFragment:
 
     # Common options for Ansible.ModuleUtils.WebRequest
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   method:
     description:
@@ -145,4 +145,4 @@ options:
     type: bool
 seealso:
 - module: community.windows.win_inet_proxy
-'''
+"""

ansible/plugins/doc_fragments/validate.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 
 class ModuleDocFragment(object):
     # Standard documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   validate:
     description:
@@ -17,4 +17,4 @@ options:
     - For an example on how to handle more complex validation than what this
       option provides, see R(handling complex validation,complex_configuration_validation).
     type: str
-'''
+"""

ansible/plugins/doc_fragments/vars_plugin_staging.py

@@ -8,7 +8,7 @@ from __future__ import annotations
 
 class ModuleDocFragment(object):
 
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   stage:
     description:
@@ -20,4 +20,4 @@ options:
     choices: ['all', 'task', 'inventory']
     version_added: "2.10"
     type: str
-'''
+"""