API change: keepalive flag not affect context manager keepalive

* keepalive_mode affect context manager behavior
* in case of multiple context enter,
  only last `__exit__` will close connection

Maintenance part:
* migrate from flake8 to ruff
* prepare for trusted publishing
* better project metadata

Author: penguinolog

.github/workflows/pythonpackage.yml

@@ -1,70 +1,75 @@
 name: Python package
 
-on: [push]
+on:
+  push:
+    branches-ignore:
+      - 'dependabot/**'
+  pull_request: {}
 
 jobs:
   PEP8:
+    name: Check with Ruff
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v4.6.1
+        uses: actions/setup-python@v4
         with:
           python-version: '3.x'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install --upgrade -r flake8_requirements.txt
-      - name: Lint with flake8
+          pip install --upgrade ruff
+      - name: Lint with ruff
         run: |
-          flake8 exec_helpers
+          ruff . --format github
 
   PyLint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v4.6.1
+        uses: actions/setup-python@v4
         with:
-          python-version: '3.7'
+          python-version: '3.8'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install --upgrade -r CI_REQUIREMENTS.txt
-          pip install --upgrade "pylint >= 2.6.0"
-      - name: Generate version file
+          pip install --upgrade "pylint >= 2.6.0" perflint
+      - name: Install develop
         run: |
-          python setup.py --version clean
+          pip install -e .
       - name: Lint with PyLint
         run: |
           pylint exec_helpers
 
   MyPy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v4.6.1
+        uses: actions/setup-python@v4
         with:
           python-version: '3.x'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install --upgrade -r CI_REQUIREMENTS.txt
           pip install --upgrade -r mypy_requirements.txt
-      - name: Generate version file
+      - name: Install develop
         run: |
-          python setup.py --version clean
+          pip install -e .
       - name: Lint with MyPy
         run: |
           mypy --strict --install-types --non-interactive exec_helpers
 
   Black:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v4.6.1
+        uses: actions/setup-python@v4
         with:
           python-version: '3.x'
       - name: Install dependencies
@@ -74,44 +79,84 @@ jobs:
       - name: Check code style with black
         run: |
           black --check exec_helpers
+  Metadata:
+    name: Validate metadata
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install --upgrade twine build
+      - name: Build package
+        run: |
+          python -m build -s
+      - name: Validate metadata
+        run: |
+          twine check dist/*
 
   Test:
-    needs: [PEP8, PyLint, MyPy, Black]
+    needs: [PEP8, PyLint, MyPy, Black, Metadata]  # isort is broken
     runs-on: ${{ matrix.os }}
     strategy:
       max-parallel: 6
       matrix:
-        os: ["ubuntu-latest", "windows-latest"]
+        os: [ubuntu-latest, windows-latest]
         python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
+    name: "Script based python ${{ matrix.python-version }} on ${{ matrix.os }}"
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4.6.1
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip wheel
           pip install --upgrade -r CI_REQUIREMENTS.txt
           pip install --upgrade -r pytest_requirements.txt
-      - name: Build package and install develop
+      - name: Install develop
         run: |
           pip install -e .
       - name: Test with pytest
         run: |
           py.test --cov-report= --cov=exec_helpers test
           coverage report -m
+          coverage xml
 #          coverage report -m --fail-under 85
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@v2
+        with:
+          flag-name: run-${{ matrix.python-version }}-${{ matrix.os }}
+          parallel: true
+          file: coverage.xml
 
-  Deploy:
-    needs: [Test]
+  UploadCoverage:
+    name: Upload coverage to Coveralls
+    needs: [ Test ]
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@v2
+        with:
+          parallel-finished: true
+
+  Build:
+    needs: [ Test ]
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/[email protected]
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # need for setuptools_scm
       - name: Set up Python
-        uses: actions/setup-python@v4.6.1
+        uses: actions/setup-python@v4
         with:
           python-version: '3.x'
       - name: Install dependencies
@@ -121,9 +166,25 @@ jobs:
       - name: Build package
         run: |
           python -m build
-      - name: Deploy
-        env:
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: |
-          twine upload --skip-existing dist/*
+      - uses: actions/upload-artifact@v3
+        with:
+          path: dist/*
+
+  Deploy:
+      needs: [Build]
+      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+      runs-on: ubuntu-latest
+      environment:
+        name: pypi
+        url: https://pypi.org/p/exec-helpers
+      permissions:
+        id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+      steps:
+        - uses: actions/download-artifact@v3
+          with:
+            # unpacks default artifact into dist/
+            # if `name: artifact` is omitted, the action will create extra parent dir
+            name: artifact
+            path: dist
+        - name: Publish package distributions to PyPI
+          uses: pypa/gh-action-pypi-publish@release/v1

.pylintrc

@@ -28,8 +28,8 @@ limit-inference-results=100
 
 # List of plugins (as comma separated values of python modules names) to load,
 # usually to register additional checkers.
-load-plugins=pylint.extensions.docstyle,
-             pylint.extensions.docparams,
+load-plugins=pylint.extensions.docparams,
+             pylint.extensions.docstyle,
              pylint.extensions.overlapping_exceptions,
              pylint.extensions.emptystring,
              pylint.extensions.comparetozero,
@@ -39,6 +39,7 @@ load-plugins=pylint.extensions.docstyle,
              pylint.extensions.redefined_variable_type,
              pylint.extensions.typing,
              pylint.extensions.empty_comment
+             # perflint
 
 # Pickle collected data for later comparisons.
 persistent=yes
@@ -88,7 +89,8 @@ disable=locally-disabled,
         too-many-lines,
         broad-except,
         logging-fstring-interpolation,
-        logging-format-interpolation
+        logging-format-interpolation,
+        invalid-name
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

doc/source/SSHClient.rst

@@ -48,6 +48,7 @@ API: SSHClient and SSHAuth.
         .. versionchanged:: 6.0.0 private_keys is deprecated
         .. versionchanged:: 7.0.0 private_keys is removed
         .. versionchanged:: 7.0.0 keepalive_mode is removed
+        .. versionchanged:: 7.4.0 return of keepalive_mode to prevent mix with keepalive period. Default is `False`
 
     .. py:attribute:: log_mask_re
 
@@ -91,10 +92,15 @@ API: SSHClient and SSHAuth.
         ``bool``
         Use sudo for all calls, except wrapped in connection.sudo context manager.
 
+    .. py:attribute:: keepalive_mode
+
+        ``bool``
+        If `False` - close connection on exit from context manager.
+
     .. py:attribute:: keepalive_period
 
         ``int | bool``
-        Keepalive period for connection object. If `0` - close connection on exit from context manager.
+        Keepalive period for connection object.
 
     .. py:method:: close()
 

doc/source/conf.py

@@ -1,6 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
 # exec-helpers documentation build configuration file, created by
 # sphinx-quickstart on Sun Oct 30 13:40:52 2016.
 #
@@ -61,8 +58,8 @@
 
 # General information about the project.
 project = "Exec-helpers"
-copyright = "2018, Alexey Stepanov"
-author = "Alexey Stepanov"
+copyright = "2018-2023, Aleksei Stepanov"  # noqa: A001
+author = "Aleksei Stepanov"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

exec_helpers/__init__.py

@@ -1,4 +1,4 @@
-#    Copyright 2018 - 2022 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2023 Aleksei Stepanov aka penguinolog.
 
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
 #    not use this file except in compliance with the License. You may obtain
@@ -21,9 +21,9 @@
 import typing
 import warnings
 
-try:
+try:  # noqa: SIM105
     # Local Implementation
-    from ._version import version as __version__
+    from ._version import version as __version__  # noqa: F401
 except ImportError:
     pass
 
@@ -100,7 +100,11 @@ def __getattr__(name: str) -> typing.Any:
     :raises AttributeError: attribute is not defined for lazy load
     """
     if name in _deprecated:
-        warnings.warn(f"{name} is deprecated in favor of {_deprecated[name]}", DeprecationWarning)
+        warnings.warn(
+            f"{name} is deprecated in favor of {_deprecated[name]}",
+            DeprecationWarning,
+            stacklevel=2,
+        )
     if name in __lazy_load_modules:
         mod = importlib.import_module(f"{__package__}.{name}")
         __locals[name] = mod
@@ -113,10 +117,10 @@ def __getattr__(name: str) -> typing.Any:
     raise AttributeError(f"{name} not found in {__package__}")
 
 
-__author__ = "Alexey Stepanov"
+__author__ = "Aleksei Stepanov"
 __author_email__ = "[email protected]"
 __maintainers__ = {
-    "Alexey Stepanov": "[email protected]",
+    "Aleksei Stepanov": "[email protected]",
     "Antonio Esposito": "[email protected]",
     "Dennis Dmitriev": "[email protected]",
 }

exec_helpers/__init__.pyi

@@ -1,4 +1,4 @@
-#    Copyright 2018 - 2021 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2023 Aleksei Stepanov aka penguinolog.
 
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
 #    not use this file except in compliance with the License. You may obtain
@@ -39,9 +39,9 @@ from .ssh import SSHClient
 from .ssh_auth import SSHAuth
 from .subprocess import Subprocess  # nosec  # Expected
 
-try:
+try:  # noqa: SIM105
     # Local Implementation
-    from ._version import version as __version__
+    from ._version import version as __version__  # noqa: F401
 except ImportError:
     pass
 

exec_helpers/_log_templates.py

@@ -1,4 +1,4 @@
-#    Copyright 2018 - 2022 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2023 Aleksei Stepanov aka penguinolog.
 
 #    Copyright 2017 Mirantis, Inc.