Make typing annotations in docstrings better

Author: penguinolog

exec_helpers/_helpers.py

@@ -61,7 +61,7 @@ def mask_command(text: str, *rules: str | None) -> str:
     :param text: source text
     :type text: str
     :param rules: regex rules to mask.
-    :type rules: typing.Optional[str]
+    :type rules: str | None
     :return: source with all MATCHED groups replaced by '<*masked*>'
     :rtype: str
     """

exec_helpers/_ssh_base.py

@@ -448,7 +448,7 @@ class SSHClientBase(api.ExecHelper):
     :param ssh_auth_map: SSH authentication information mapped to host names. Useful for complex SSH Proxy cases.
     :type ssh_auth_map: dict[str, ssh_auth.SSHAuth] | ssh_auth.SSHAuthMapping | None
     :param sock: socket for connection. Useful for ssh proxies support
-    :type sock: typing.Optional[typing.Union[paramiko.ProxyCommand, paramiko.Channel, socket.socket]]
+    :type sock: paramiko.ProxyCommand | paramiko.Channel | socket.socket | None
     :param keepalive: keepalive period
     :type keepalive: int | bool
 

exec_helpers/_ssh_helpers.py

@@ -34,7 +34,7 @@ def _parse_ssh_config_file(file_path: pathlib.Path) -> paramiko.SSHConfig | None
     :param file_path: file path for parsing
     :type file_path: pathlib.Path
     :return: SSH config if file found and parsed else None
-    :rtype: typing.Optional[paramiko.SSHConfig]
+    :rtype: paramiko.SSHConfig | None
     """
     if not file_path.exists():
         return None

exec_helpers/api.py

@@ -378,9 +378,9 @@ def _execute_async(
                     'ExecuteAsyncResult',
                     [
                         ('interface', typing.Any),
-                        ('stdin', typing.Optional[typing.Any]),
-                        ('stderr', typing.Optional[typing.Any]),
-                        ('stdout', typing.Optional[typing.Any]),
+                        ('stdin', typing.Any | None),
+                        ('stderr', typing.Any | None),
+                        ('stdout', typing.Any | None),
                         ("started", datetime.datetime),
                     ]
                 )
@@ -640,7 +640,7 @@ def check_call(
         """Execute command and check for return code.
 
         :param command: Command for execution
-        :type command: typing.Union[str, typing.Iterable[str]]
+        :type command: str | Iterable[str]
         :param verbose: Produce log.info records for command call and output
         :type verbose: bool
         :param timeout: Timeout for command execution.
@@ -755,7 +755,7 @@ def check_stderr(
         """Execute command expecting return code 0 and empty STDERR.
 
         :param command: Command for execution
-        :type command: typing.Union[str, typing.Iterable[str]]
+        :type command: str | Iterable[str]
         :param verbose: Produce log.info records for command call and output
         :type verbose: bool
         :param timeout: Timeout for command execution.

exec_helpers/async_api/api.py

@@ -611,7 +611,7 @@ async def check_call(
         :param error_info: Text for error details, if fail happens
         :type error_info: str | None
         :param expected: expected return codes (0 by default)
-        :type expected: typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]
+        :type expected: Iterable[int | proc_enums.ExitCodes]
         :param raise_on_err: Raise exception on unexpected return code
         :type raise_on_err: bool
         :param log_mask_re: regex lookup rule to mask command for logger.
@@ -726,7 +726,7 @@ async def check_stderr(
         :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.Iterable[typing.Union[int, proc_enums.ExitCodes]]
+        :type expected: Iterable[int | proc_enums.ExitCodes]
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: str | None

exec_helpers/async_api/subprocess.py

@@ -385,7 +385,7 @@ async def _execute_async(
         :param command: Command for execution
         :type command: str
         :param stdin: pass STDIN text to the process
-        :type stdin: typing.Union[str, bytes, bytearray, None]
+        :type stdin: str | bytes | bytearray | None
         :param open_stdout: open STDOUT stream for read
         :type open_stdout: bool
         :param open_stderr: open STDERR stream for read

exec_helpers/exec_result.py

@@ -156,7 +156,7 @@ def __getitem__(
         """Access magic.
 
         :param item: index
-        :type item: typing.Union[int, slice, Iterable[typing.Union[int, slice, ellipsis]]]
+        :type item: int | slice | Iterable[int | slice | ellipsis]
         :return: Joined selected lines
         :rtype: str
         :raises TypeError: Unexpected key
@@ -238,7 +238,7 @@ def __init__(
         :param cmd: command
         :type cmd: str
         :param stdin: string STDIN
-        :type stdin: typing.Union[bytes, str, bytearray, None]
+        :type stdin: bytes | str | bytearray | None
         :param stdout: binary STDOUT
         :type stdout: Iterable[bytes] | None
         :param stderr: binary STDERR
@@ -327,7 +327,7 @@ def _get_brief(cls, data: tuple[bytes, ...]) -> str:
         """Get brief output: 7 lines maximum (3 first + ... + 3 last).
 
         :param data: source to process
-        :type data: typing.Tuple[bytes, ...]
+        :type data: tuple[bytes, ...]
         :return: brief from source
         :rtype: str
         """
@@ -349,7 +349,7 @@ def stdin(self) -> str | None:
         """Stdin input as string.
 
         :return: STDIN content if applicable.
-        :rtype: typing.Optional[str]
+        :rtype: str | None
         """
         return self.__stdin
 
@@ -358,7 +358,7 @@ def stdout(self) -> tuple[bytes, ...]:
         """Stdout output as list of binaries.
 
         :return: STDOUT as tuple of binary strings
-        :rtype: typing.Tuple[bytes, ...]
+        :rtype: tuple[bytes, ...]
         """
         return self._stdout
 
@@ -367,7 +367,7 @@ def stderr(self) -> tuple[bytes, ...]:
         """Stderr output as list of binaries.
 
         :return: STDERR as tuple of binary strings
-        :rtype: typing.Tuple[bytes, ...]
+        :rtype: tuple[bytes, ...]
         """
         return self._stderr
 

exec_helpers/ssh_auth.py

@@ -65,9 +65,9 @@ def __init__(
         :param key: Main connection key
         :type key: paramiko.PKey | None
         :param keys: Alternate connection keys
-        :type keys: Sequence[tparamiko.PKey | None] | None
+        :type keys: Sequence[paramiko.PKey | None] | None
         :param key_filename: filename(s) for additional key files
-        :type key_filename: typing.Union[Iterable[str], str, None]
+        :type key_filename: Iterable[str] | str | None
         :param passphrase: passphrase for keys. Need, if differs from password
         :type passphrase: str | None
 

exec_helpers/subprocess.py

@@ -397,7 +397,7 @@ def _execute_async(
         :param command: Command for execution
         :type command: str
         :param stdin: pass STDIN text to the process
-        :type stdin: typing.Union[str, bytes, bytearray, None]
+        :type stdin: str | bytes | bytearray | None
         :param open_stdout: open STDOUT stream for read
         :type open_stdout: bool
         :param open_stderr: open STDERR stream for read