1.1.0

* context managers works with locks
* Subprocess: kill on destructor/exit from context manager
* Subprocess: remove classmethods

Author: penguinolog

README.rst

@@ -94,19 +94,26 @@ Creation from scratch:
         username='username',  # type: typing.Optional[str]
         password='password',  # type: typing.Optional[str]
         key=None,  # type: typing.Optional[paramiko.RSAKey]
-        keys=None,
+        keys=None,  # type: typing.Optional[typing.Iterable[paramiko.RSAKey]],
+        key_filename=None,  # type: typing.Union[typing.List[str], str, None]
+        passphrase=None,  # type: typing.Optional[str]
     )
 
 Key is a main connection key (always tried first) and keys are alternate keys.
+Key filename is afilename or list of filenames with keys, which should be loaded.
+Passphrase is an alternate password for keys, if it differs from main password.
 If main key now correct for username - alternate keys tried, if correct key found - it became main.
 If no working key - password is used and None is set as main key.
 
 .. note:: Automatic closing connections during cache record removal supported on CPython implementation only.
 
+Context manager is available, connection is closed and lock is released on exit from context.
+
 Subprocess
 ----------
 
 No initialization required.
+Context manager is available, subprocess is killed and lock is released on exit from context.
 
 Base methods
 ------------

doc/source/SSHClient.rst

@@ -79,11 +79,14 @@ API: SSHClient and SSHAuth.
 
         Open context manager
 
+        .. versionchanged:: 1.1.0 - lock on enter
+
     .. py:method:: __exit__(self, exc_type, exc_val, exc_tb)
 
         Close context manager and disconnect
 
-        .. versionchanged:: 1.0 - disconnect enforced on close
+        .. versionchanged:: 1.0.0 - disconnect enforced on close
+        .. versionchanged:: 1.1.0 - release lock on exit
 
     .. py:method:: sudo(enforce=None)
 
@@ -293,7 +296,7 @@ API: SSHClient and SSHAuth.
         :param passphrase: passphrase for keys. Need, if differs from password
         :type passphrase: ``typing.Optional[str]``
 
-        .. versionchanged:: 1.0
+        .. versionchanged:: 1.0.0
             added: key_filename, passphrase arguments
 
     .. py:attribute:: username
@@ -310,7 +313,7 @@ API: SSHClient and SSHAuth.
         ``typing.Union[typing.List[str], str, None]``
         Key filename(s).
 
-        .. versionadded:: 1.0
+        .. versionadded:: 1.0.0
 
     .. py:method:: enter_password(self, tgt)
 

doc/source/Subprocess.rst

@@ -8,7 +8,23 @@ API: Subprocess
 
 .. py:class:: Subprocess()
 
-    .. py:classmethod:: execute(command, verbose=False, timeout=None, **kwargs)
+    .. py:attribute:: lock
+
+        ``threading.RLock``
+
+    .. py:method:: __enter__()
+
+        Open context manager
+
+        .. versionchanged:: 1.1.0 - lock on enter
+
+    .. py:method:: __exit__(self, exc_type, exc_val, exc_tb)
+
+        Close context manager
+
+        .. versionchanged:: 1.1.0 - release lock on exit
+
+    .. py:method:: execute(command, verbose=False, timeout=None, **kwargs)
 
         Execute command and wait for return code.
 
@@ -21,7 +37,9 @@ API: Subprocess
         :rtype: ExecResult
         :raises: ExecHelperTimeoutError
 
-    .. py:classmethod:: check_call(command, verbose=False, timeout=None, error_info=None, expected=None, raise_on_err=True, **kwargs)
+        .. versionchanged:: 1.1.0 - make method
+
+    .. py:method:: check_call(command, verbose=False, timeout=None, error_info=None, expected=None, raise_on_err=True, **kwargs)
 
         Execute command and check for return code.
 
@@ -40,7 +58,9 @@ API: Subprocess
         :rtype: ExecResult
         :raises: CalledProcessError
 
-    .. py:classmethod:: check_stderr(command, verbose=False, timeout=None, error_info=None, raise_on_err=True, **kwargs)
+        .. versionchanged:: 1.1.0 - make method
+
+    .. py:method:: check_stderr(command, verbose=False, timeout=None, error_info=None, raise_on_err=True, **kwargs)
 
         Execute command expecting return code 0 and empty STDERR.
 
@@ -58,3 +78,5 @@ API: Subprocess
         :raises: CalledProcessError
 
         .. note:: expected return codes can be overridden via kwargs.
+
+        .. versionchanged:: 1.1.0 - make method

exec_helpers/__init__.py

@@ -45,7 +45,7 @@
     'ExecResult',
 )
 
-__version__ = '1.0.0'
+__version__ = '1.1.0'
 __author__ = "Alexey Stepanov"
 __author_email__ = 'penguinolog@gmail.com'
 __url__ = 'https://github.com/penguinolog/exec-helpers'

exec_helpers/_ssh_client_base.py

@@ -103,7 +103,7 @@ def __init__(
         :param passphrase: passphrase for keys. Need, if differs from password
         :type passphrase: typing.Optional[str]
 
-        .. versionchanged:: 1.0
+        .. versionchanged:: 1.0.0
             added: key_filename, passphrase arguments
         """
         self.__username = username
@@ -152,7 +152,7 @@ def key_filename(
     ):  # type: () -> typing.Union[typing.List[str], str, None]
         """Key filename(s).
 
-        .. versionadded:: 1.0
+        .. versionadded:: 1.0.0
         """
         return copy.deepcopy(self.__key_filename)
 
@@ -706,15 +706,21 @@ def __del__(self):
         self.__sftp = None
 
     def __enter__(self):
-        """Get context manager."""
+        """Get context manager.
+
+        .. versionchanged:: 1.1.0 - lock on enter
+        """
+        self.lock.acquire()
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         """Exit context manager.
 
-        .. versionchanged:: 1.0 - disconnect enforced on close
+        .. versionchanged:: 1.0.0 - disconnect enforced on close
+        .. versionchanged:: 1.1.0 - release lock on exit
         """
         self.close()
+        self.lock.release()
 
     def reconnect(self):
         """Reconnect SSH session."""

exec_helpers/subprocess_runner.py

@@ -79,28 +79,45 @@ def _py2_str(src):
 class Subprocess(BaseSingleton):
     """Subprocess helper with timeouts and lock-free FIFO."""
 
-    __lock = threading.RLock()
-
-    __slots__ = ()
+    __slots__ = (
+        '__lock',
+        '__process',
+    )
 
     def __init__(self):
         """Subprocess helper with timeouts and lock-free FIFO.
 
         For excluding race-conditions we allow to run 1 command simultaneously
         """
-        pass
+        self.__lock = threading.RLock()
+        self.__process = None
+
+    @property
+    def lock(self):  # type: () -> threading.RLock
+        """Lock.
+
+        :rtype: threading.RLock
+        """
+        return self.__lock
 
     def __enter__(self):
         """Context manager usage."""
+        self.lock.acquire()
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         """Context manager usage."""
-        pass
+        if self.__process:
+            self.__process.kill()
+        self.lock.release()
+
+    def __del__(self):
+        """Destructor. Kill running subprocess, if it running."""
+        if self.__process:
+            self.__process.kill()
 
-    @classmethod
     def __exec_command(
-        cls,
+        self,
         command,  # type: str
         cwd=None,  # type: typing.Optional[str]
         env=None,  # type: typing.Optional[typing.Dict[str, typing.Any]]
@@ -146,43 +163,41 @@ def poll_streams(
 
         @threaded.threaded(started=True, daemon=True)
         def poll_pipes(
-            proc,  # type: subprocess.Popen
             result,  # type: exec_result.ExecResult
             stop  # type: threading.Event
         ):
             """Polling task for FIFO buffers.
 
-            :type proc: subprocess.Popen
             :type result: exec_result.ExecResult
             :type stop: threading.Event
             """
             while not stop.isSet():
                 time.sleep(0.1)
                 poll_streams(
                     result=result,
-                    stdout=proc.stdout,
-                    stderr=proc.stderr,
+                    stdout=self.__process.stdout,
+                    stderr=self.__process.stderr,
                 )
 
-                proc.poll()
+                self.__process.poll()
 
-                if proc.returncode is not None:
+                if self.__process.returncode is not None:
                     result.read_stdout(
-                        src=proc.stdout,
+                        src=self.__process.stdout,
                         log=logger,
                         verbose=verbose
                     )
                     result.read_stderr(
-                        src=proc.stderr,
+                        src=self.__process.stderr,
                         log=logger,
                         verbose=verbose
                     )
-                    result.exit_code = proc.returncode
+                    result.exit_code = self.__process.returncode
 
                     stop.set()
 
         # 1 Command per run
-        with cls.__lock:
+        with self.lock:
             result = exec_result.ExecResult(cmd=command)
             stop_event = threading.Event()
             message = _log_templates.CMD_EXEC.format(cmd=command.rstrip())
@@ -191,18 +206,18 @@ def poll_pipes(
             else:
                 logger.debug(message)
             # Run
-            process = subprocess.Popen(
+            self.__process = subprocess.Popen(
                 args=[command],
                 stdin=subprocess.PIPE,
                 stdout=subprocess.PIPE,
                 stderr=subprocess.PIPE,
                 shell=True, cwd=cwd, env=env,
-                universal_newlines=False)
+                universal_newlines=False,
+            )
 
             # Poll output
             # pylint: disable=assignment-from-no-return
             poll_thread = poll_pipes(
-                process,
                 result,
                 stop_event
             )  # type: threading.Thread
@@ -213,17 +228,19 @@ def poll_pipes(
             # Process closed?
             if stop_event.isSet():
                 stop_event.clear()
+                self.__process = None
                 return result
             # Kill not ended process and wait for close
             try:
-                process.kill()  # kill -9
+                self.__process.kill()  # kill -9
                 stop_event.wait(5)
                 poll_thread.join(5)
             except OSError:
                 # Nothing to kill
                 logger.warning(
                     u"{!s} has been completed just after timeout: "
                     "please validate timeout.".format(command))
+            self.__process = None
 
             wait_err_msg = _log_templates.CMD_WAIT_ERROR.format(
                 cmd=command.rstrip(),
@@ -239,9 +256,8 @@ def poll_pipes(
                 wait_err_msg + output_brief_msg
             )
 
-    @classmethod
     def execute(
-        cls,
+        self,
         command,  # type: str
         verbose=False,  # type: bool
         timeout=None,  # type: typing.Optional[int]
@@ -257,8 +273,8 @@ def execute(
         :rtype: ExecResult
         :raises: ExecHelperTimeoutError
         """
-        result = cls.__exec_command(command=command, timeout=timeout,
-                                    verbose=verbose, **kwargs)
+        result = self.__exec_command(command=command, timeout=timeout,
+                                     verbose=verbose, **kwargs)
         message = _log_templates.CMD_RESULT.format(
             cmd=command, code=result.exit_code)
         logger.log(
@@ -268,9 +284,8 @@ def execute(
 
         return result
 
-    @classmethod
     def check_call(
-        cls,
+        self,
         command,  # type: str
         verbose=False,  # type: bool
         timeout=None,  # type: typing.Optional[int]
@@ -293,7 +308,7 @@ def check_call(
         :raises: DevopsCalledProcessError
         """
         expected = proc_enums.exit_codes_to_enums(expected)
-        ret = cls.execute(command, verbose, timeout, **kwargs)
+        ret = self.execute(command, verbose, timeout, **kwargs)
         if ret['exit_code'] not in expected:
             message = (
                 _log_templates.CMD_UNEXPECTED_EXIT_CODE.format(
@@ -312,9 +327,8 @@ def check_call(
                     stderr=ret['stderr_brief'])
         return ret
 
-    @classmethod
     def check_stderr(
-        cls,
+        self,
         command,  # type: str
         verbose=False,  # type: bool
         timeout=None,  # type: typing.Optional[int]
@@ -334,7 +348,7 @@ def check_stderr(
         :rtype: ExecResult
         :raises: DevopsCalledProcessError
         """
-        ret = cls.check_call(
+        ret = self.check_call(
             command, verbose, timeout=timeout,
             error_info=error_info, raise_on_err=raise_on_err, **kwargs)
         if ret['stderr']: