Update docs

Signed-off-by: Aleksei Stepanov <penguinolog@gmail.com>

(cherry picked from commit 9460417)
Signed-off-by: Aleksei Stepanov <penguinolog@gmail.com>

Author: penguinolog

README.rst

@@ -132,6 +132,7 @@ This methods are almost the same for `SSHCleint` and `Subprocess`, except specif
         timeout=1 * 60 * 60,  # type: typing.Union[int, float, None]
         # Keyword only:
         log_mask_re=None,  # type: typing.Optional[str]
+        stdin=None,  # type: typing.Union[bytes, str, bytearray, None]
         **kwargs
     )
 
@@ -147,6 +148,7 @@ This methods are almost the same for `SSHCleint` and `Subprocess`, except specif
         raise_on_err=True,  # type: bool
         # Keyword only:
         log_mask_re=None,  # type: typing.Optional[str]
+        stdin=None,  # type: typing.Union[bytes, str, bytearray, None]
         exception_class=CalledProcessError,  # typing.Type[CalledProcessError]
         **kwargs
     )
@@ -160,8 +162,9 @@ This methods are almost the same for `SSHCleint` and `Subprocess`, except specif
         error_info=None,  # type: typing.Optional[str]
         raise_on_err=True,  # type: bool
         # Keyword only:
-        log_mask_re=None,  # type: typing.Optional[str]
         expected=(0,),  # typing.Iterable[typing.Union[int, ExitCodes]]
+        log_mask_re=None,  # type: typing.Optional[str]
+        stdin=None,  # type: typing.Union[bytes, str, bytearray, None]
         exception_class=CalledProcessError,  # typing.Type[CalledProcessError]
     )
 
@@ -173,6 +176,7 @@ This methods are almost the same for `SSHCleint` and `Subprocess`, except specif
         timeout=1 * 60 * 60,  # type: typing.Union[int, float, None]
         # Keyword only:
         log_mask_re=None,  # type: typing.Optional[str]
+        stdin=None,  # type: typing.Union[bytes, str, bytearray, None]
         **kwargs
     )
 

doc/source/SSHClient.rst

@@ -166,7 +166,7 @@ API: SSHClient and SSHAuth.
         .. versionchanged:: 2.1.0 Use typed NamedTuple as result
         .. versionchanged:: 3.2.0 Expose pty options as optional keyword-only arguments
 
-    .. py:method:: execute(command, verbose=False, timeout=1*60*60, *, log_mask_re=None, **kwargs)
+    .. py:method:: execute(command, verbose=False, timeout=1*60*60, *, log_mask_re=None, stdin=None, **kwargs)
 
         Execute command and wait for return code.
 
@@ -179,12 +179,14 @@ API: SSHClient and SSHAuth.
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: ``typing.Optional[str]``
+        :param stdin: pass STDIN text to the process
+        :type stdin: ``typing.Union[bytes, str, bytearray, None]``
         :rtype: ExecResult
         :raises ExecHelperTimeoutError: Timeout exceeded
 
         .. versionchanged:: 1.2.0 default timeout 1 hour
 
-    .. py:method:: __call__(command, verbose=False, timeout=1*60*60, *, log_mask_re=None, **kwargs)
+    .. py:method:: __call__(command, verbose=False, timeout=1*60*60, *, log_mask_re=None, stdin=None, **kwargs)
 
         Execute command and wait for return code.
 
@@ -197,12 +199,14 @@ API: SSHClient and SSHAuth.
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: ``typing.Optional[str]``
+        :param stdin: pass STDIN text to the process
+        :type stdin: ``typing.Union[bytes, str, bytearray, None]``
         :rtype: ExecResult
         :raises ExecHelperTimeoutError: Timeout exceeded
 
         .. versionadded:: 2.9.4
 
-    .. py:method:: check_call(command, verbose=False, timeout=1*60*60, error_info=None, expected=(0,), raise_on_err=True, *, log_mask_re=None, exception_class=CalledProcessError, **kwargs)
+    .. py:method:: check_call(command, verbose=False, timeout=1*60*60, error_info=None, expected=(0,), raise_on_err=True, *, log_mask_re=None, stdin=None, exception_class=CalledProcessError, **kwargs)
 
         Execute command and check for return code.
 
@@ -221,6 +225,8 @@ API: SSHClient and SSHAuth.
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: ``typing.Optional[str]``
+        :param stdin: pass STDIN text to the process
+        :type stdin: ``typing.Union[bytes, str, bytearray, None]``
         :param exception_class: Exception class for errors. Subclass of CalledProcessError is mandatory.
         :type exception_class: typing.Type[CalledProcessError]
         :rtype: ExecResult
@@ -231,7 +237,7 @@ API: SSHClient and SSHAuth.
         .. versionchanged:: 3.2.0 Exception class can be substituted
         .. versionchanged:: 2.11.0 Expected is not optional, defaults os dependent
 
-    .. py:method:: check_stderr(command, verbose=False, timeout=1*60*60, error_info=None, raise_on_err=True, *, log_mask_re=None, expected=(0,), exception_class=CalledProcessError, **kwargs)
+    .. py:method:: check_stderr(command, verbose=False, timeout=1*60*60, error_info=None, raise_on_err=True, *, expected=(0,), log_mask_re=None, stdin=None, exception_class=CalledProcessError, **kwargs)
 
         Execute command expecting return code 0 and empty STDERR.
 
@@ -250,6 +256,8 @@ API: SSHClient and SSHAuth.
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: ``typing.Optional[str]``
+        :param stdin: pass STDIN text to the process
+        :type stdin: ``typing.Union[bytes, str, bytearray, None]``
         :param exception_class: Exception class for errors. Subclass of CalledProcessError is mandatory.
         :type exception_class: typing.Type[CalledProcessError]
         :rtype: ExecResult

doc/source/Subprocess.rst

@@ -86,7 +86,7 @@ API: Subprocess
         .. versionchanged:: 2.1.0 Use typed NamedTuple as result
         .. versionchanged:: 2.9.3 Expose cwd and env as optional keyword-only arguments
 
-    .. py:method:: execute(command, verbose=False, timeout=1*60*60, *, log_mask_re=None, **kwargs)
+    .. py:method:: execute(command, verbose=False, timeout=1*60*60, *, log_mask_re=None, stdin=None, **kwargs)
 
         Execute command and wait for return code.
 
@@ -99,6 +99,8 @@ API: Subprocess
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: ``typing.Optional[str]``
+        :param stdin: pass STDIN text to the process
+        :type stdin: ``typing.Union[bytes, str, bytearray, None]``
         :rtype: ExecResult
         :raises ExecHelperTimeoutError: Timeout exceeded
 
@@ -108,7 +110,7 @@ API: Subprocess
         .. versionchanged:: 1.2.0 default timeout 1 hour
         .. versionchanged:: 1.2.0 stdin data
 
-    .. py:method:: __call__(command, verbose=False, timeout=1*60*60, *, log_mask_re=None, **kwargs)
+    .. py:method:: __call__(command, verbose=False, timeout=1*60*60, *, log_mask_re=None, stdin=None, **kwargs)
 
         Execute command and wait for return code.
 
@@ -121,13 +123,15 @@ API: Subprocess
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: ``typing.Optional[str]``
+        :param stdin: pass STDIN text to the process
+        :type stdin: ``typing.Union[bytes, str, bytearray, None]``
         :rtype: ExecResult
         :raises ExecHelperTimeoutError: Timeout exceeded
 
         .. note:: stdin channel is closed after the input processing
         .. versionadded:: 2.9.4
 
-    .. py:method:: check_call(command, verbose=False, timeout=1*60*60, error_info=None, expected=(0,), raise_on_err=True, *, log_mask_re=None, exception_class=CalledProcessError, **kwargs)
+    .. py:method:: check_call(command, verbose=False, timeout=1*60*60, error_info=None, expected=(0,), raise_on_err=True, *, log_mask_re=None, stdin=None, exception_class=CalledProcessError, **kwargs)
 
         Execute command and check for return code.
 
@@ -146,6 +150,8 @@ API: Subprocess
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: ``typing.Optional[str]``
+        :param stdin: pass STDIN text to the process
+        :type stdin: ``typing.Union[bytes, str, bytearray, None]``
         :param exception_class: Exception class for errors. Subclass of CalledProcessError is mandatory.
         :type exception_class: typing.Type[CalledProcessError]
         :rtype: ExecResult
@@ -157,7 +163,7 @@ API: Subprocess
         .. versionchanged:: 2.9.3 Exception class can be substituted
         .. versionchanged:: 2.11.0 Expected is not optional, defaults os dependent
 
-    .. py:method:: check_stderr(command, verbose=False, timeout=1*60*60, error_info=None, raise_on_err=True, *, log_mask_re=None, expected=(0,), exception_class=CalledProcessError, **kwargs)
+    .. py:method:: check_stderr(command, verbose=False, timeout=1*60*60, error_info=None, raise_on_err=True, *, expected=(0,), log_mask_re=None, stdin=None, exception_class=CalledProcessError, **kwargs)
 
         Execute command expecting return code 0 and empty STDERR.
 
@@ -176,6 +182,8 @@ API: Subprocess
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: ``typing.Optional[str]``
+        :param stdin: pass STDIN text to the process
+        :type stdin: ``typing.Union[bytes, str, bytearray, None]``
         :param exception_class: Exception class for errors. Subclass of CalledProcessError is mandatory.
         :type exception_class: typing.Type[CalledProcessError]
         :rtype: ExecResult