exec-helpers 8.0.0.post0__tar.gz → 8.1.0__tar.gz

{exec-helpers-8.0.0.post0 → exec_helpers-8.1.0}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
     - id: check-yaml
     - id: end-of-file-fixer
@@ -8,7 +8,7 @@ repos:
     - id: mixed-line-ending
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
     - id: isort
       name: isort (python)
@@ -20,7 +20,7 @@ repos:
       types: [pyi]
 
   - repo: https://github.com/psf/black
-    rev: 23.7.0
+    rev: 24.4.2
     hooks:
     - id: black
       # It is recommended to specify the latest version of Python
@@ -30,7 +30,7 @@ repos:
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.1.5
+    rev: v0.4.6
     hooks:
     - id: ruff
       args: [ --fix, --exit-non-zero-on-fix ]

{exec-helpers-8.0.0.post0 → exec_helpers-8.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: exec-helpers
-Version: 8.0.0.post0
+Version: 8.1.0
 Summary: Execution helpers for simplified usage of subprocess and ssh.
 Home-page: https://github.com/python-useful-helpers/exec-helpers
 Author-email: Alexey Stepanov <penguinolog@gmail.com>
@@ -156,7 +156,7 @@ Creation from scratch:
         password='password',  # str | None
         key=None,  # type: paramiko.PKey | None
         keys=None,  # type: Iterable[paramiko.PKey] | None
-        key_filename=None,  # type: List[str] | None
+        key_filename=None,  # type: list[str] | None
         passphrase=None,  # str | None
     )
 
@@ -286,9 +286,10 @@ Execution result object has a set of useful properties:
 
 * `cmd` - Command
 * `exit_code` - Command return code. If possible to decode using enumerators for Linux -> it used.
+* `ok` -> `bool`. Command return code is 0 (EX_OK).
 * `stdin` -> `str`. Text representation of stdin.
-* `stdout` -> `Tuple[bytes]`. Raw stdout output.
-* `stderr` -> `Tuple[bytes]`. Raw stderr output.
+* `stdout` -> `tuple[bytes]`. Raw stdout output.
+* `stderr` -> `tuple[bytes]`. Raw stderr output.
 * `stdout_bin` -> `bytearray`. Binary stdout output.
 * `stderr_bin` -> `bytearray`. Binary stderr output.
 * `stdout_str` -> `str`. Text representation of output.
@@ -319,7 +320,7 @@ Possible to call commands in parallel on multiple hosts if it's not produce huge
 
 .. code-block:: python
 
-    results: Dict[Tuple[str, int], ExecResult] = SSHClient.execute_together(
+    results: dict[tuple[str, int], ExecResult] = SSHClient.execute_together(
         remotes,  # type: Iterable[SSHClient]
         command,  # type: str | Iterable[str]
         timeout=1 * 60 * 60,  # type: type: int | float | None
@@ -332,7 +333,7 @@ Possible to call commands in parallel on multiple hosts if it's not produce huge
         log_mask_re=None,  # str | None
         exception_class=ParallelCallProcessError  # type[ParallelCallProcessError]
     )
-    results  # type: dict[Tuple[str, int], exec_result.ExecResult]
+    results  # type: dict[tuple[str, int], exec_result.ExecResult]
 
 Results is a dict with keys = (hostname, port) and and results in values.
 By default execute_together raises exception if unexpected return code on any remote.

{exec-helpers-8.0.0.post0 → exec_helpers-8.1.0}/README.rst

@@ -110,7 +110,7 @@ Creation from scratch:
         password='password',  # str | None
         key=None,  # type: paramiko.PKey | None
         keys=None,  # type: Iterable[paramiko.PKey] | None
-        key_filename=None,  # type: List[str] | None
+        key_filename=None,  # type: list[str] | None
         passphrase=None,  # str | None
     )
 
@@ -240,9 +240,10 @@ Execution result object has a set of useful properties:
 
 * `cmd` - Command
 * `exit_code` - Command return code. If possible to decode using enumerators for Linux -> it used.
+* `ok` -> `bool`. Command return code is 0 (EX_OK).
 * `stdin` -> `str`. Text representation of stdin.
-* `stdout` -> `Tuple[bytes]`. Raw stdout output.
-* `stderr` -> `Tuple[bytes]`. Raw stderr output.
+* `stdout` -> `tuple[bytes]`. Raw stdout output.
+* `stderr` -> `tuple[bytes]`. Raw stderr output.
 * `stdout_bin` -> `bytearray`. Binary stdout output.
 * `stderr_bin` -> `bytearray`. Binary stderr output.
 * `stdout_str` -> `str`. Text representation of output.
@@ -273,7 +274,7 @@ Possible to call commands in parallel on multiple hosts if it's not produce huge
 
 .. code-block:: python
 
-    results: Dict[Tuple[str, int], ExecResult] = SSHClient.execute_together(
+    results: dict[tuple[str, int], ExecResult] = SSHClient.execute_together(
         remotes,  # type: Iterable[SSHClient]
         command,  # type: str | Iterable[str]
         timeout=1 * 60 * 60,  # type: type: int | float | None
@@ -286,7 +287,7 @@ Possible to call commands in parallel on multiple hosts if it's not produce huge
         log_mask_re=None,  # str | None
         exception_class=ParallelCallProcessError  # type[ParallelCallProcessError]
     )
-    results  # type: dict[Tuple[str, int], exec_result.ExecResult]
+    results  # type: dict[tuple[str, int], exec_result.ExecResult]
 
 Results is a dict with keys = (hostname, port) and and results in values.
 By default execute_together raises exception if unexpected return code on any remote.

{exec-helpers-8.0.0.post0 → exec_helpers-8.1.0}/exec_helpers/__init__.py

@@ -20,7 +20,7 @@ import importlib
 import typing
 import warnings
 
-try:  # noqa: SIM105
+try:  # noqa: FURB107,SIM105,RUF100
     from ._version import version as __version__  # noqa: F401
 except ImportError:
     pass
@@ -28,31 +28,28 @@ except ImportError:
 if typing.TYPE_CHECKING:
     from collections.abc import Sequence
 
+
 # noinspection PyUnresolvedReferences
 __all__ = (
     # pylint: disable=undefined-all-variable
-    # lazy load
-    # API
-    "async_api",
-    "ExitCodes",
-    "ExecResult",
+    "CalledProcessError",
+    "ExecCalledProcessError",
     "ExecHelper",
-    "mask_command",
-    # Expensive
-    "Subprocess",
-    "SSHClient",
-    "SSHAuth",
-    "SSHConfig",
-    "HostsSSHConfigs",
-    # Exceptions
-    "exceptions",
     "ExecHelperError",
-    "ExecCalledProcessError",
-    "CalledProcessError",
-    "ParallelCallExceptionsError",
-    "ParallelCallProcessError",
     "ExecHelperNoKillError",
     "ExecHelperTimeoutError",
+    "ExecResult",
+    "ExitCodes",
+    "HostsSSHConfigs",
+    "ParallelCallExceptionsError",
+    "ParallelCallProcessError",
+    "SSHAuth",
+    "SSHClient",
+    "SSHConfig",
+    "Subprocess",
+    "async_api",
+    "exceptions",
+    "mask_command",
 )
 
 __locals: dict[str, typing.Any] = locals()  # use mutable access for pure lazy loading
@@ -90,8 +87,8 @@ _deprecated: dict[str, str] = {}
 def __getattr__(name: str) -> typing.Any:
     """Get attributes lazy.
 
-    :return: attribute by name
-    :raises AttributeError: attribute is not defined for lazy load
+    :return: Attribute by name.
+    :raises AttributeError: Attribute is not defined for the lazy load.
     """
     if name in _deprecated:
         warnings.warn(

{exec-helpers-8.0.0.post0 → exec_helpers-8.1.0}/exec_helpers/__init__.pyi

@@ -12,6 +12,8 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+# pylint: disable=missing-module-docstring
+
 import typing
 
 from . import async_api
@@ -39,33 +41,28 @@ except ImportError:
 
 # noinspection PyUnresolvedReferences
 __all__ = (
-    # pylint: disable=undefined-all-variable
-    # lazy load
-    # API
-    "async_api",
-    "ExitCodes",
-    "ExecResult",
+    "CalledProcessError",
+    "ExecCalledProcessError",
     "ExecHelper",
-    "mask_command",
-    # Expensive
-    "Subprocess",
-    "SSHClient",
-    "SSHAuth",
-    "SSHConfig",
-    "HostsSSHConfigs",
-    # Exceptions
     "ExecHelperError",
-    "ExecCalledProcessError",
-    "CalledProcessError",
-    "ParallelCallExceptionsError",
-    "ParallelCallProcessError",
     "ExecHelperNoKillError",
     "ExecHelperTimeoutError",
+    "ExecResult",
+    "ExitCodes",
+    "HostsSSHConfigs",
+    "ParallelCallExceptionsError",
+    "ParallelCallProcessError",
+    "SSHAuth",
+    "SSHClient",
+    "SSHConfig",
+    "Subprocess",
+    "async_api",
+    "mask_command",
 )
 
 _deprecated: dict[str, str] = ...
 
-def __getattr__(name: str) -> typing.Any: ...
+def __getattr__(name: str) -> typing.Any: ...  # pylint: disable=unused-argument
 
 __author__: str = ...
 __author_email__: str = ...

{exec-helpers-8.0.0.post0 → exec_helpers-8.1.0}/exec_helpers/_helpers.py

@@ -12,10 +12,10 @@ if typing.TYPE_CHECKING:
 
 
 def string_bytes_bytearray_as_bytes(src: str | bytes | bytearray) -> bytes:
-    """Get bytes string from string/bytes/bytearray union.
+    """Get byte string from string/bytes/bytearray union.
 
-    :param src: source string or bytes-like object
-    :return: Byte string
+    :param src: Source string or bytes-like object.
+    :return: Byte string.
     :rtype: bytes
     :raises TypeError: unexpected source type.
     """
@@ -31,11 +31,11 @@ def string_bytes_bytearray_as_bytes(src: str | bytes | bytearray) -> bytes:
 def _mask_command(text: str, rules: str | re.Pattern[str]) -> str:
     """Mask part of text using rules.
 
-    :param text: source text
+    :param text: Source text.
     :type text: str
-    :param rules: regex rules to mask.
+    :param rules: Regex rules to mask.
     :type rules: str | re.Pattern
-    :return: source with all MATCHED groups replaced by '<*masked*>'
+    :return: Source with all MATCHED groups replaced by '<*masked*>'.
     :rtype: str
     """
     masked: list[str] = []
@@ -55,11 +55,11 @@ def _mask_command(text: str, rules: str | re.Pattern[str]) -> str:
 def mask_command(text: str, *rules: str | re.Pattern[str] | None) -> str:
     """Apply all rules to command.
 
-    :param text: source text
+    :param text: Source text.
     :type text: str
-    :param rules: regex rules to mask.
+    :param rules: Regex rules to mask.
     :type rules: str | re.Pattern[str] | None
-    :return: source with all MATCHED groups replaced by '<*masked*>'
+    :return: Source with all MATCHED groups replaced by '<*masked*>'.
     :rtype: str
     """
     return functools.reduce(_mask_command, (rule for rule in rules if rule is not None), text)
@@ -68,9 +68,9 @@ def mask_command(text: str, *rules: str | re.Pattern[str] | None) -> str:
 def cmd_to_string(command: str | Iterable[str]) -> str:
     """Convert command to string for usage with shell.
 
-    :param command: original command.
+    :param command: Original command.
     :type command: str | Iterable[str]
-    :return: command as single string
+    :return: Command as single string.
     :rtype: str
     """
     if isinstance(command, str):
@@ -78,18 +78,20 @@ def cmd_to_string(command: str | Iterable[str]) -> str:
     return shlex.join(command)
 
 
-def chroot_command(command: str, chroot_path: str | None = None) -> str:
+def chroot_command(command: str, chroot_path: str | None = None, chroot_exe: str = "chroot") -> str:
     """Prepare command for chroot execution.
 
-    :param command: original command.
+    :param command: Original command.
     :type command: str
-    :param chroot_path: chroot path
+    :param chroot_path: chroot path.
     :type chroot_path: str | None
-    :return: command to be executed with chroot rules if applicable
+    :param chroot_exe: chroot executable.
+    :type chroot_exe: str
+    :return: Command to be executed with chroot rules if applicable.
     :rtype: str
     """
     if chroot_path and chroot_path != "/":
         chroot_dst: str = shlex.quote(chroot_path.strip())
         quoted_command = shlex.quote(command)
-        return f'chroot {chroot_dst} sh -c {shlex.quote(f"eval {quoted_command}")}'
+        return f'{chroot_exe} {chroot_dst} sh -c {shlex.quote(f"eval {quoted_command}")}'
     return command