Fix ExecResult compare: allow subclassing. Re-raise auth errors ASAP. (#99)

* Make tests faster.
* Bump to 3.1.1

Author: penguinolog

exec_helpers/__init__.py

@@ -51,7 +51,7 @@
     "async_api",
 )
 
-__version__ = "3.1.0"
+__version__ = "3.1.1"
 __author__ = "Alexey Stepanov"
 __author_email__ = "penguinolog@gmail.com"
 __maintainers__ = {

exec_helpers/_ssh_client_base.py

@@ -49,6 +49,18 @@
 logging.getLogger("iso8601").setLevel(logging.WARNING)
 
 
+class RetryOnExceptions(tenacity.retry_if_exception):  # type: ignore
+    """Advanced retry on exceptions."""
+
+    def __init__(
+        self,
+        retry_on: typing.Union[typing.Type[BaseException], typing.Tuple[typing.Type[BaseException], ...]],
+        reraise: typing.Union[typing.Type[BaseException], typing.Tuple[typing.Type[BaseException], ...]],
+    ) -> None:
+        """Retry on exceptions, except several types."""
+        super(RetryOnExceptions, self).__init__(lambda e: isinstance(e, retry_on) and not isinstance(e, reraise))
+
+
 # noinspection PyTypeHints
 class SshExecuteAsyncResult(api.ExecuteAsyncResult):
     """Override original NamedTuple with proper typing."""
@@ -376,7 +388,7 @@ def _ssh(self) -> paramiko.SSHClient:
         return self.__ssh
 
     @tenacity.retry(  # type: ignore
-        retry=tenacity.retry_if_exception_type(paramiko.SSHException),
+        retry=RetryOnExceptions(retry_on=paramiko.SSHException, reraise=paramiko.AuthenticationException),
         stop=tenacity.stop_after_attempt(3),
         wait=tenacity.wait_fixed(3),
         reraise=True,

exec_helpers/async_api/exec_result.py

@@ -103,7 +103,3 @@ async def read_stderr(  # type: ignore
         with self.stderr_lock:
             self._stderr_str = self._stderr_brief = None
             self._stderr += tuple(await self._poll_stream(src, log, verbose))
-
-    def __hash__(self) -> int:
-        """Hash for usage as dict key and in sets."""
-        return hash((super(ExecResult, self).__class__, self.cmd, self.stdin, self.stdout, self.stderr, self.exit_code))

exec_helpers/exec_result.py

@@ -465,7 +465,17 @@ def __str__(self) -> str:
 
     def __eq__(self, other: typing.Any) -> bool:
         """Comparision."""
-        return hash(self) == hash(other)
+        return (
+            self.__class__ is other.__class__
+            or issubclass(self.__class__, other.__class__)
+            or issubclass(other.__class__, self.__class__)
+        ) and (
+            self.cmd == other.cmd
+            and self.stdin == other.stdin
+            and self.stdout == other.stdout
+            and self.stderr == other.stderr
+            and self.exit_code == other.exit_code
+        )
 
     def __ne__(self, other: typing.Any) -> bool:
         """Comparision."""

pytest.ini

@@ -1,3 +1,4 @@
 [pytest]
 addopts = -vvv -s -p no:django -p no:ipdb
 testpaths = test
+mock_use_standalone_module = true

test/async_api/test_subprocess.py

@@ -127,7 +127,7 @@ def run_parameters(request):
 
 @pytest.fixture
 def exec_result(run_parameters):
-    return exec_helpers.async_api.ExecResult(
+    return exec_helpers.ExecResult(
         cmd=command,
         stdin=run_parameters["stdin"],
         stdout=tuple([line for line in run_parameters["stdout"]]) if run_parameters["stdout"] else None,

test/async_api/test_subprocess_special.py

@@ -142,7 +142,7 @@ def exec_result(run_parameters):
     else:
         stdout_res = tuple([elem for elem in run_parameters["stdout"] if isinstance(elem, bytes)])
 
-    return exec_helpers.async_api.ExecResult(
+    return exec_helpers.ExecResult(
         cmd=run_parameters.get("masked_cmd", command),
         stdin=run_parameters.get("stdin", None),
         stdout=stdout_res,