pedantic pylint & optimized travis.yml (#80)

Author: penguinolog

.pylintrc

@@ -7,12 +7,32 @@ install:
 - &install_deps pip install -r CI_REQUIREMENTS.txt
 - pip install --upgrade pytest-cov coveralls
 
+_python:
+- &python34
+  name: "Python 3.4"
+  python: 3.4
+- &python35
+  name: "Python 3.5"
+  python: 3.5
+- &python36
+  name: "Python 3.6"
+  python: 3.6
+- &python37
+  name: "Python 3.7"
+  python: 3.7
+  dist: xenial
+  sudo: true
+- &pypy3
+  name: "PyPy3"
+  python: pypy3.5
+
 _helpers:
 - &install_cython pip install --upgrade Cython
 - &build_package python setup.py bdist_wheel
 - &install_built pip install exec_helpers --no-index -f dist
 - &test_no_cov  py.test -vv test
 - &test_cythonized
+  stage: Test cythonized
   install:
   - *upgrade_python_toolset
   - *install_test_deps
@@ -24,112 +44,92 @@ _helpers:
   - *test_no_cov
   after_success: skip
 
+- &static_analysis
+  stage: Static analysis
+  <<: *python36
+  after_success: skip
+
+- &code_style_check
+  stage: Code style check
+  <<: *python36
+  after_success: skip
+
 script:
 - pip install -e .
 - py.test -vv --cov-config .coveragerc --cov-report= --cov=exec_helpers test
-- coverage report -m --fail-under 90
+- coverage report -m --fail-under 87
 after_success:
 - coveralls
 
 jobs:
   fast_finish: true
   include:
   - stage: test
-    name: "Python 3.4"
-    python: 3.4
+    <<: *python34
   - stage: test
-    name: "Python 3.5"
-    python: 3.5
+    <<: *python35
   - stage: test
-    name: "Python 3.6"
-    python: 3.6
+    <<: *python36
   - stage: test
-    name: "Python 3.7"
-    python: 3.7
-    dist: xenial
-    sudo: true
+    <<: *python37
   - stage: test
-    name: "PyPy3"
-    python: pypy3.5
+    <<: *pypy3
 
-  - stage: Static analisys
+  - <<: *static_analysis
     name: "PyLint"
-    python: 3.6
-    services: []
     install:
     - *upgrade_python_toolset
     - *install_deps
-    - pip install --upgrade "pylint >= 2.0"
+    - pip install --upgrade "pylint >= 2.1"
     script:
     - pylint exec_helpers
-    after_success: skip
-  - stage: Static analisys
+  - <<: *static_analysis
     name: "Bandit"
-    python: 3.6
-    services: []
     install:
     - *upgrade_python_toolset
     - pip install --upgrade bandit
     script:
     - bandit -r exec_helpers
-    after_success: skip
-  - stage: Static analisys
+  - <<: *static_analysis
+    <<: *python37
     name: "MyPy"
-    python: 3.7
-    dist: xenial
-    sudo: true
-    services: []
     install:
     - *upgrade_python_toolset
     - *install_deps
     - pip install --upgrade "mypy >= 0.620"
     script:
     - mypy --strict exec_helpers
-    after_success: skip
 
-  - stage: Test cythonized
-    name: "Python 3.4"
-    python: 3.4
-    <<: *test_cythonized
-  - stage: Test cythonized
-    name: "Python 3.5"
-    python: 3.5
-    <<: *test_cythonized
-  - stage: Test cythonized
-    name: "Python 3.6"
-    python: 3.6
-    <<: *test_cythonized
-  - stage: Test cythonized
-    name: "Python 3.7"
-    python: 3.7
-    dist: xenial
-    sudo: true
-    <<: *test_cythonized
+  - <<: *test_cythonized
+    <<: *python34
+  - <<: *test_cythonized
+    <<: *python35
+  - <<: *test_cythonized
+    <<: *python36
+  - <<: *test_cythonized
+    <<: *python37
 
-  - stage: Code style check
+  - <<: *code_style_check
     name: "PEP8"
-    python: 3.6
     install:
     - *upgrade_python_toolset
     - pip install --upgrade flake8
     script:
     - flake8
-    after_success: skip
-  - stage: Code style check
+  - <<: *code_style_check
     name: "PEP257"
-    python: 3.6
     install:
     - *upgrade_python_toolset
     - pip install --upgrade pydocstyle
     script:
     - pydocstyle exec_helpers
-    after_success: skip
 
   - stage: deploy
     # This prevents job from appearing in test plan unless commit is tagged:
     if: tag IS present
     # Run on pypy to build not cythonized wheel
-    python: pypy3.5
+    <<: *pypy3
+    name: Build universal and cythonized bdist_wheel. Deploy bdist and sdist.
     services:
     - docker
     install:

.travis.yml

@@ -129,6 +129,7 @@ def __call__(  # type: ignore
         :type auth: typing.Optional[ssh_auth.SSHAuth]
         :param verbose: show additional error/warning messages
         :type verbose: bool
+        :return: SSH client instance
         :rtype: SSHClientBase
         """
         if (host, port) in cls.__cache:
@@ -218,7 +219,9 @@ def __init__(
         ) -> None:
             """Context manager for call commands with sudo.
 
+            :param ssh: connection instance
             :type ssh: SSHClientBase
+            :param enforce: sudo mode for context manager
             :type enforce: typing.Optional[bool]
             """
             self.__ssh = ssh
@@ -249,7 +252,9 @@ def __init__(
         ) -> None:
             """Context manager for keepalive management.
 
+            :param ssh: connection instance
             :type ssh: SSHClientBase
+            :param enforce: keepalive mode for context manager
             :type enforce: bool
             :param enforce: Keep connection alive after context manager exit
             """
@@ -526,6 +531,7 @@ def keepalive_mode(self) -> bool:
     def keepalive_mode(self, mode: bool) -> None:
         """Persistent keepalive mode change for connection object.
 
+        :param mode: keepalive mode enable/disable
         :type mode: bool
         """
         self.__keepalive_mode = bool(mode)
@@ -548,6 +554,7 @@ def sudo(
 
         :param enforce: Enforce sudo enabled or disabled. By default: None
         :type enforce: typing.Optional[bool]
+        :return: context manager with selected sudo state inside
         :rtype: typing.ContextManager
         """
         return self.__get_sudo(ssh=self, enforce=enforce)
@@ -560,6 +567,7 @@ def keepalive(
 
         :param enforce: Enforce keepalive enabled or disabled.
         :type enforce: bool
+        :return: context manager with selected keepalive state inside
         :rtype: typing.ContextManager
 
         .. Note:: Enter and exit ssh context manager is produced as well.
@@ -592,6 +600,9 @@ def execute_async(
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: typing.Optional[str]
+        :param kwargs: additional parameters for call.
+        :type kwargs: typing.Any
+        :return: Tuple with control interface and file-like objects for STDIN/STDERR/STDOUT
         :rtype: typing.Tuple[
             paramiko.Channel,
             paramiko.ChannelFile,
@@ -661,15 +672,24 @@ def _exec_command(
     ) -> exec_result.ExecResult:
         """Get exit status from channel with timeout.
 
+        :param command: executed command (for logs)
         :type command: str
+        :param interface: interface to control execution
         :type interface: paramiko.channel.Channel
+        :param stdout: source for STDOUT read
         :type stdout: typing.Optional[paramiko.ChannelFile]
+        :param stderr: source for STDERR read
         :type stderr: typing.Optional[paramiko.ChannelFile]
+        :param timeout: timeout before stop execution with TimeoutError
         :type timeout: typing.Union[int, float, None]
+        :param verbose: produce log.info records for STDOUT/STDERR
         :type verbose: bool
         :param log_mask_re: regex lookup rule to mask command for logger.
                             all MATCHED groups will be replaced by '<*masked*>'
         :type log_mask_re: typing.Optional[str]
+        :param kwargs: additional parameters for call.
+        :type kwargs: typing.Any
+        :return: Execution result
         :rtype: ExecResult
         :raises ExecHelperTimeoutError: Timeout exceeded
 
@@ -776,6 +796,9 @@ def execute_through_host(
         :type timeout: typing.Union[int, float, None]
         :param get_pty: open PTY on target machine
         :type get_pty: bool
+        :param kwargs: additional parameters for call.
+        :type kwargs: typing.Any
+        :return: Execution result
         :rtype: ExecResult
         :raises ExecHelperTimeoutError: Timeout exceeded
 
@@ -851,6 +874,8 @@ def execute_together(
         :type expected: typing.Optional[typing.Iterable[]]
         :param raise_on_err: Raise exception on unexpected return code
         :type raise_on_err: bool
+        :param kwargs: additional parameters for execute_async call.
+        :type kwargs: typing.Any
         :return: dictionary {(hostname, port): result}
         :rtype: typing.Dict[typing.Tuple[str, int], exec_result.ExecResult]
         :raises ParallelCallProcessError: Unexpected any code at lest on one target
@@ -938,16 +963,21 @@ def get_result(remote: 'SSHClientBase') -> exec_result.ExecResult:
     def open(self, path: str, mode: str = 'r') -> paramiko.SFTPFile:
         """Open file on remote using SFTP session.
 
+        :param path: filesystem object path
         :type path: str
+        :param mode: open file mode ('t' is not supported)
         :type mode: str
         :return: file.open() stream
+        :rtype: paramiko.SFTPFile
         """
         return self._sftp.open(path, mode)  # pragma: no cover
 
     def exists(self, path: str) -> bool:
         """Check for file existence using SFTP session.
 
+        :param path: filesystem object path
         :type path: str
+        :return: path is valid (object exists)
         :rtype: bool
         """
         try:
@@ -959,7 +989,9 @@ def exists(self, path: str) -> bool:
     def stat(self, path: str) -> paramiko.sftp_attr.SFTPAttributes:
         """Get stat info for path with following symlinks.
 
+        :param path: filesystem object path
         :type path: str
+        :return: stat like information for remote path
         :rtype: paramiko.sftp_attr.SFTPAttributes
         """
         return self._sftp.stat(path)  # pragma: no cover
@@ -983,7 +1015,9 @@ def utime(
     def isfile(self, path: str) -> bool:
         """Check, that path is file using SFTP session.
 
+        :param path: remote path to validate
         :type path: str
+        :return: path is file
         :rtype: bool
         """
         try:
@@ -995,7 +1029,9 @@ def isfile(self, path: str) -> bool:
     def isdir(self, path: str) -> bool:
         """Check, that path is directory using SFTP session.
 
+        :param path: remote path to validate
         :type path: str
+        :return: path is directory
         :rtype: bool
         """
         try: