Mass backport from 3.5

* type hints
* __all__ movement

Signed-off-by: Aleksei Stepanov <penguinolog@gmail.com>

Author: penguinolog

.travis.yml

@@ -10,21 +10,21 @@ install:
 _python:
 - &python34
   name: "Python 3.4"
-  python: 3.4
+  python: "3.4"
 - &python35
   name: "Python 3.5"
-  python: 3.5
+  python: "3.5"
 - &python36
   name: "Python 3.6"
-  python: 3.6
+  python: "3.6"
 - &python37
   name: "Python 3.7"
-  python: 3.7
+  python: "3.7"
   dist: xenial
   sudo: true
 - &pypy3
   name: "PyPy3"
-  python: pypy3.5
+  python: "pypy3.5"
 
 _helpers:
 - &install_cython pip install --upgrade Cython
@@ -68,7 +68,7 @@ jobs:
     install:
     - *upgrade_python_toolset
     - *install_deps
-    - pip install --upgrade "pylint >= 2.1"
+    - pip install --upgrade "pylint >= 2.2"
     script:
     - pylint exec_helpers
   - <<: *static_analysis
@@ -84,7 +84,7 @@ jobs:
     install:
     - *upgrade_python_toolset
     - *install_deps
-    - pip install --upgrade "mypy >= 0.650"
+    - pip install --upgrade "mypy >= 0.660"
     script:
     - mypy --strict exec_helpers
 
@@ -135,7 +135,7 @@ jobs:
     # This prevents job from appearing in test plan unless commit is tagged:
     if: tag IS present
     # Run on pypy to build not cythonized wheel
-    <<: *python34
+    <<: *pypy3
     name: Build universal and cythonized bdist_wheel. Deploy bdist and sdist.
     services:
     - docker
@@ -144,7 +144,7 @@ jobs:
     script:
     - ./tools/run_docker.sh "exec_helpers"
     before_deploy:
-    - pip install -r requirements.txt
+    - pip install -r build_requirements.txt
     - *build_package
     deploy:
     - provider: pypi

appveyor.yml

@@ -14,7 +14,23 @@
 
 """Execution helpers for simplified usage of subprocess and ssh."""
 
-import typing
+__all__ = (
+    "ExecHelperError",
+    "ExecCalledProcessError",
+    "CalledProcessError",
+    "ParallelCallExceptions",
+    "ParallelCallProcessError",
+    "ExecHelperNoKillError",
+    "ExecHelperTimeoutError",
+    "ExecHelper",
+    "SSHClient",
+    "SshExecuteAsyncResult",
+    "SSHAuth",
+    "Subprocess",
+    "SubprocessExecuteAsyncResult",
+    "ExitCodes",
+    "ExecResult",
+)
 
 import pkg_resources
 
@@ -37,26 +53,8 @@
 from ._ssh_client_base import SshExecuteAsyncResult
 from .subprocess_runner import Subprocess, SubprocessExecuteAsyncResult  # nosec  # Expected
 
-__all__ = (
-    "ExecHelperError",
-    "ExecCalledProcessError",
-    "CalledProcessError",
-    "ParallelCallExceptions",
-    "ParallelCallProcessError",
-    "ExecHelperNoKillError",
-    "ExecHelperTimeoutError",
-    "ExecHelper",
-    "SSHClient",
-    "SshExecuteAsyncResult",
-    "SSHAuth",
-    "Subprocess",
-    "SubprocessExecuteAsyncResult",
-    "ExitCodes",
-    "ExecResult",
-)  # type: typing.Tuple[str, ...]
-
 try:  # pragma: no cover
-    __version__ = pkg_resources.get_distribution(__name__).version
+    __version__ = pkg_resources.get_distribution(__name__).version  # type: str
 except pkg_resources.DistributionNotFound:  # pragma: no cover
     # package is not installed, try to get from SCM
     try:

exec_helpers/__init__.py

@@ -121,7 +121,7 @@ class _MemorizedSSH(abc.ABCMeta):
     __cache = {}  # type: typing.Dict[typing.Tuple[str, int], SSHClientBase]
 
     @classmethod
-    def __prepare__(  # pylint: disable=unused-argument
+    def __prepare__(  # type: ignore  # pylint: disable=unused-argument
         mcs: typing.Type["_MemorizedSSH"], name: str, bases: typing.Iterable[type], **kwargs: typing.Any
     ) -> "collections.OrderedDict[str, typing.Any]":
         """Metaclass magic for object storage.

exec_helpers/_ssh_client_base.py

@@ -47,7 +47,7 @@ def safe_stop(proc: psutil.Process, kill: bool = False) -> None:
             pass
 
     parent = psutil.Process(pid)
-    children = parent.children(recursive=True)
+    children = parent.children(recursive=True)  # type: typing.List[psutil.Process]
     for child in children:  # type: psutil.Process
         safe_stop(child)  # SIGTERM to allow cleanup
     _, alive = psutil.wait_procs(children, timeout=1)

exec_helpers/_subprocess_helpers.py

@@ -109,15 +109,14 @@ def _mask_command(self, cmd: str, log_mask_re: typing.Optional[str] = None) -> s
         def mask(text: str, rules: str) -> str:
             """Mask part of text using rules."""
             indexes = [0]  # Start of the line
+            masked = ""
 
             # places to exclude
             for match in re.finditer(rules, text):
                 for idx, _ in enumerate(match.groups()):
                     indexes.extend(match.span(idx + 1))
             indexes.append(len(text))  # End
 
-            masked = ""
-
             # Replace inserts
             for idx in range(0, len(indexes) - 2, 2):
                 start = indexes[idx]
@@ -128,14 +127,14 @@ def mask(text: str, rules: str) -> str:
             masked += text[indexes[-2] : indexes[-1]]  # final part
             return masked
 
-        cmd = cmd.rstrip()
+        result = cmd.rstrip()  # type: str
 
-        if self.log_mask_re:
-            cmd = mask(cmd, self.log_mask_re)
-        if log_mask_re:
-            cmd = mask(cmd, log_mask_re)
+        if self.log_mask_re is not None:
+            result = mask(result, self.log_mask_re)
+        if log_mask_re is not None:
+            result = mask(result, log_mask_re)
 
-        return cmd
+        return result
 
     @abc.abstractmethod
     def execute_async(
@@ -248,7 +247,7 @@ def execute(
 
         result = self._exec_command(
             command=command, async_result=async_result, timeout=timeout, verbose=verbose, **kwargs
-        )
+        )  # type: exec_result.ExecResult
         message = "Command {result.cmd!r} exit code: {result.exit_code!s}".format(result=result)
         self.logger.log(level=logging.INFO if verbose else logging.DEBUG, msg=message)  # type: ignore
         return result
@@ -318,18 +317,18 @@ def check_call(
         .. versionchanged:: 2.10.0 Expected is not optional, defaults os dependent
         """
         expected_codes = proc_enums.exit_codes_to_enums(expected)
-        ret = self.execute(command, verbose, timeout, **kwargs)
-        if ret.exit_code not in expected_codes:
+        result = self.execute(command, verbose, timeout, **kwargs)  # type: exec_result.ExecResult
+        if result.exit_code not in expected_codes:
             message = (
                 "{append}Command {result.cmd!r} returned exit code "
                 "{result.exit_code!s} while expected {expected!s}".format(
-                    append=error_info + "\n" if error_info else "", result=ret, expected=expected_codes
+                    append=error_info + "\n" if error_info else "", result=result, expected=expected_codes
                 )
             )
             self.logger.error(msg=message)
             if raise_on_err:
-                raise exception_class(result=ret, expected=expected_codes)
-        return ret
+                raise exception_class(result=result, expected=expected_codes)
+        return result
 
     def check_stderr(
         self,
@@ -370,7 +369,7 @@ def check_stderr(
         .. versionchanged:: 2.9.3 Exception class can be substituted
         .. versionchanged:: 2.10.0 Expected is not optional, defaults os dependent
         """
-        ret = self.check_call(
+        result = self.check_call(
             command,
             verbose,
             timeout=timeout,
@@ -380,15 +379,16 @@ def check_stderr(
             exception_class=exception_class,
             **kwargs
         )
-        if ret.stderr:
+        append = error_info + "\n" if error_info else ""  # type: str
+        if result.stderr:
             message = (
                 "{append}Command {result.cmd!r} output contains STDERR while not expected\n"
-                "\texit code: {result.exit_code!s}".format(append=error_info + "\n" if error_info else "", result=ret)
+                "\texit code: {result.exit_code!s}".format(append=append, result=result)
             )
             self.logger.error(msg=message)
             if raise_on_err:
-                raise exception_class(result=ret, expected=expected)
-        return ret
+                raise exception_class(result=result, expected=expected)
+        return result
 
     @staticmethod
     def _string_bytes_bytearray_as_bytes(src: typing.Union[str, bytes, bytearray]) -> bytes:

exec_helpers/api.py

@@ -14,14 +14,6 @@
 
 """Package specific exceptions."""
 
-import typing
-
-from exec_helpers import proc_enums
-from exec_helpers import _log_templates
-
-if typing.TYPE_CHECKING:  # pragma: no cover
-    from exec_helpers import exec_result  # noqa: F401  # pylint: disable=cyclic-import
-
 __all__ = (
     "ExecHelperError",
     "ExecHelperNoKillError",
@@ -32,6 +24,14 @@
     "ParallelCallExceptions",
 )
 
+import typing
+
+from exec_helpers import proc_enums
+from exec_helpers import _log_templates
+
+if typing.TYPE_CHECKING:  # pragma: no cover
+    from exec_helpers import exec_result  # noqa: F401  # pylint: disable=cyclic-import
+
 
 class ExecHelperError(Exception):
     """Base class for all exceptions raised inside."""