Update docs: expected is not optional

Author: penguinolog

doc/source/ExecResult.rst

@@ -10,7 +10,7 @@ API: ExecResult
 
     Command execution result.
 
-    .. py:method:: __init__(cmd, stdin=None, stdout=None, stderr=None, exit_code=ExitCodes.EX_INVALID)
+    .. py:method:: __init__(cmd, stdin=None, stdout=None, stderr=None, exit_code=0xDEADBEEF)
 
         :param cmd: command
         :type cmd: ``str``

doc/source/SSHClient.rst

@@ -182,7 +182,7 @@ API: SSHClient and SSHAuth.
 
         .. versionadded:: 3.3.0
 
-    .. py:method:: check_call(command, verbose=False, timeout=1*60*60, error_info=None, expected=None, raise_on_err=True, *, exception_class=CalledProcessError, **kwargs)
+    .. py:method:: check_call(command, verbose=False, timeout=1*60*60, error_info=None, expected=(0,), raise_on_err=True, *, exception_class=CalledProcessError, **kwargs)
 
         Execute command and check for return code.
 
@@ -195,7 +195,7 @@ API: SSHClient and SSHAuth.
         :param error_info: Text for error details, if fail happens
         :type error_info: ``typing.Optional[str]``
         :param expected: expected return codes (0 by default)
-        :type expected: ``typing.Optional[typing.Iterable[int]]``
+        :type expected: typing.Iterable[typing.Union[int, ExitCodes]]
         :param raise_on_err: Raise exception on unexpected return code
         :type raise_on_err: ``bool``
         :param exception_class: Exception class for errors. Subclass of CalledProcessError is mandatory.
@@ -206,8 +206,9 @@ API: SSHClient and SSHAuth.
 
         .. versionchanged:: 1.2.0 default timeout 1 hour
         .. versionchanged:: 3.2.0 Exception class can be substituted
+        .. versionchanged:: 3.4.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, *, expected=None, exception_class=CalledProcessError, **kwargs)
+    .. py:method:: check_stderr(command, verbose=False, timeout=1*60*60, error_info=None, raise_on_err=True, *, expected=(0,), exception_class=CalledProcessError, **kwargs)
 
         Execute command expecting return code 0 and empty STDERR.
 
@@ -222,7 +223,7 @@ API: SSHClient and SSHAuth.
         :param raise_on_err: Raise exception on unexpected return code
         :type raise_on_err: ``bool``
         :param expected: expected return codes (0 by default)
-        :type expected: typing.Optional[typing.Iterable[typing.Union[int, ExitCodes]]]
+        :type expected: typing.Iterable[typing.Union[int, ExitCodes]]
         :param exception_class: Exception class for errors. Subclass of CalledProcessError is mandatory.
         :type exception_class: typing.Type[CalledProcessError]
         :rtype: ExecResult
@@ -260,8 +261,9 @@ API: SSHClient and SSHAuth.
         .. versionchanged:: 1.2.0 default timeout 1 hour
         .. versionchanged:: 3.2.0 Expose pty options as optional keyword-only arguments
         .. versionchanged:: 3.2.0 Exception class can be substituted
+        .. versionchanged:: 3.4.0 Expected is not optional, defaults os dependent
 
-    .. py:classmethod:: execute_together(remotes, command, timeout=1*60*60, expected=None, raise_on_err=True, *, exception_class=ParallelCallProcessError, **kwargs)
+    .. py:classmethod:: execute_together(remotes, command, timeout=1*60*60, expected=(0,), raise_on_err=True, *, exception_class=ParallelCallProcessError, **kwargs)
 
         Execute command on multiple remotes in async mode.
 
@@ -272,7 +274,7 @@ API: SSHClient and SSHAuth.
         :param timeout: Timeout for command execution.
         :type timeout: ``typing.Union[int, float, None]``
         :param expected: expected return codes (0 by default)
-        :type expected: ``typing.Optional[typing.Iterable[]]``
+        :type expected: typing.Iterable[typing.Union[int, ExitCodes]]
         :param raise_on_err: Raise exception on unexpected return code
         :type raise_on_err: ``bool``
         :param exception_class: Exception to raise on error. Mandatory subclass of ParallelCallProcessError
@@ -284,6 +286,7 @@ API: SSHClient and SSHAuth.
 
         .. versionchanged:: 1.2.0 default timeout 1 hour
         .. versionchanged:: 3.2.0 Exception class can be substituted
+        .. versionchanged:: 3.4.0 Expected is not optional, defaults os dependent
 
     .. py:method:: open(path, mode='r')
 

doc/source/Subprocess.rst

@@ -106,7 +106,7 @@ API: Subprocess
         .. note:: stdin channel is closed after the input processing
         .. versionadded:: 3.3.0
 
-    .. py:method:: check_call(command, verbose=False, timeout=1*60*60, error_info=None, expected=None, raise_on_err=True, *, exception_class=CalledProcessError, **kwargs)
+    .. py:method:: check_call(command, verbose=False, timeout=1*60*60, error_info=None, expected=(0,), raise_on_err=True, *, exception_class=CalledProcessError, **kwargs)
 
         Execute command and check for return code.
 
@@ -119,7 +119,7 @@ API: Subprocess
         :param error_info: Text for error details, if fail happens
         :type error_info: ``typing.Optional[str]``
         :param expected: expected return codes (0 by default)
-        :type expected: ``typing.Optional[typing.Iterable[int]]``
+        :type expected: typing.Iterable[typing.Union[int, ExitCodes]]
         :param raise_on_err: Raise exception on unexpected return code
         :type raise_on_err: ``bool``
         :param exception_class: Exception class for errors. Subclass of CalledProcessError is mandatory.
@@ -131,8 +131,9 @@ API: Subprocess
         .. versionchanged:: 1.1.0 make method
         .. versionchanged:: 1.2.0 default timeout 1 hour
         .. versionchanged:: 3.2.0 Exception class can be substituted
+        .. versionchanged:: 3.4.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, *, expected=None, exception_class=CalledProcessError, **kwargs)
+    .. py:method:: check_stderr(command, verbose=False, timeout=1*60*60, error_info=None, raise_on_err=True, *, expected=(0,), exception_class=CalledProcessError, **kwargs)
 
         Execute command expecting return code 0 and empty STDERR.
 
@@ -147,7 +148,7 @@ API: Subprocess
         :param raise_on_err: Raise exception on unexpected return code
         :type raise_on_err: ``bool``
         :param expected: expected return codes (0 by default)
-        :type expected: typing.Optional[typing.Iterable[typing.Union[int, ExitCodes]]]
+        :type expected: typing.Iterable[typing.Union[int, ExitCodes]]
         :param exception_class: Exception class for errors. Subclass of CalledProcessError is mandatory.
         :type exception_class: typing.Type[CalledProcessError]
         :rtype: ExecResult
@@ -157,6 +158,7 @@ API: Subprocess
         .. versionchanged:: 1.1.0 make method
         .. versionchanged:: 1.2.0 default timeout 1 hour
         .. versionchanged:: 3.2.0 Exception class can be substituted
+        .. versionchanged:: 3.4.0 Expected is not optional, defaults os dependent
 
 
 .. py:class:: SubprocessExecuteAsyncResult

doc/source/exceptions.rst

@@ -18,21 +18,11 @@ API: exceptions
 
     Base class for process call errors.
 
-.. py:exception:: ExecHelperTimeoutError(ExecCalledProcessError)
+class ExecHelperTimeoutProcessError(ExecCalledProcessError):
+    
+    Timeout based errors.
 
-    Execution timeout.
-
-    .. versionchanged:: 1.3.0 provide full result and timeout inside.
-    .. versionchanged:: 1.3.0 subclass ExecCalledProcessError
-
-    .. py:method:: __init__(self, result, timeout)
-
-        Exception for error on process calls.
-
-        :param result: execution result
-        :type result: exec_result.ExecResult
-        :param timeout: timeout for command
-        :type timeout: typing.Union[int, float]
+    .. versionadded:: 3.4.0
 
     .. py:attribute:: timeout
 
@@ -54,18 +44,54 @@ API: exceptions
         ``str``
         stdout string or brief string
 
+
+.. py:exception:: ExecHelperNoKillError(ExecHelperTimeoutProcessError)
+    
+    Impossible to kill process.
+
+    .. versionadded:: 3.4.0
+
+    .. py:method:: __init__(self, result, timeout)
+        
+        Exception for error on process calls.
+
+        :param result: execution result
+        :type result: exec_result.ExecResult
+        :param timeout: timeout for command
+        :type timeout: typing.Union[int, float]
+
+
+.. py:exception:: ExecHelperTimeoutError(ExecHelperTimeoutProcessError)
+
+    Execution timeout.
+
+    .. versionchanged:: 1.3.0 provide full result and timeout inside.
+    .. versionchanged:: 1.3.0 subclass ExecCalledProcessError
+
+    .. py:method:: __init__(self, result, timeout)
+
+        Exception for error on process calls.
+
+        :param result: execution result
+        :type result: exec_result.ExecResult
+        :param timeout: timeout for command
+        :type timeout: typing.Union[int, float]
+
+
 .. py:exception:: CalledProcessError(ExecCalledProcessError)
 
     Exception for error on process calls.
 
     .. versionchanged:: 1.1.1 - provide full result
 
-    .. py:method:: __init__(result, expected=None)
+    .. py:method:: __init__(result, expected=(0,))
 
         :param result: execution result
         :type result: ExecResult
-        :param returncode: return code
-        :type returncode: typing.Union[int, ExitCodes]
+        :param expected: expected return codes
+        :type expected: typing.Iterable[typing.Union[int, ExitCodes]]
+
+        .. versionchanged:: 3.4.0 Expected is not optional, defaults os dependent
 
     .. py:attribute:: result
 
@@ -104,7 +130,7 @@ API: exceptions
 
     Exception during parallel execution.
 
-    .. py:method:: __init__(command, errors, results, expected=None, )
+    .. py:method:: __init__(command, errors, results, expected=(0,), )
 
         :param command: command
         :type command: ``str``
@@ -113,9 +139,10 @@ API: exceptions
         :param results: all results
         :type results: typing.Dict[typing.Tuple[str, int], ExecResult]
         :param expected: expected return codes
-        :type expected: typing.Optional[typing.List[typing.List[typing.Union[int, ExitCodes]]]
+        :type expected: typing.Iterable[typing.Union[int, ExitCodes]]
 
         .. versionchanged:: 1.0 - fixed inheritance
+        .. versionchanged:: 3.4.0 Expected is not optional, defaults os dependent
 
     .. py:attribute:: cmd
 
@@ -144,7 +171,7 @@ API: exceptions
 
     Exception raised during parallel call as result of exceptions.
 
-    .. py:method:: __init__(command, exceptions, errors, results, expected=None, )
+    .. py:method:: __init__(command, exceptions, errors, results, expected=(0,), )
 
         :param command: command
         :type command: ``str``
@@ -155,9 +182,10 @@ API: exceptions
         :param results: all results
         :type results: typing.Dict[typing.Tuple[str, int], ExecResult]
         :param expected: expected return codes
-        :type expected: typing.Optional[typing.List[typing.List[typing.Union[int, ExitCodes]]]
+        :type expected: typing.Iterable[typing.Union[int, ExitCodes]]
 
         .. versionchanged:: 1.0 - fixed inheritance
+        .. versionchanged:: 3.4.0 Expected is not optional, defaults os dependent
 
     .. py:attribute:: cmd