The package is now fully typed

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

Author: s0undt3ch

.pre-commit-config.yaml

@@ -36,22 +36,29 @@ repos:
         language: system
   # <---- Local Hooks ------------------------------------------------------------------------------------------------
 
+  # ----- Remove Typing - Py3.5 Support  ---------------------------------------------------------------------------->
+  - repo: https://github.com/s0undt3ch/downgrade-source
+    rev: v2.1.0
+    hooks:
+      - id: downgrade-source
+        name: Downgrade source code into a separate package to support Py3.5
+        files: ^src/.*\.py$
+        exclude: ^src/pytestskipmarkers/((__init__|version|utils/__init__)\.py|downgraded/.*\.py)$
+        args:
+          - --target-version=3.5
+          - --pkg-path=src/pytestskipmarkers
+          - --skip-checker=nounusableimports
+          - --skip-checker=nostarimports
+  # <---- Remove Typing - Py3.5 Support  -----------------------------------------------------------------------------
+
   # ----- Formatting ------------------------------------------------------------------------------------------------>
   - repo: https://github.com/asottile/pyupgrade
     rev: v2.29.0
     hooks:
       - id: pyupgrade
         name: Rewrite Code to be Py3.5+
         args: [--py3-plus]
-        exclude: (^src/pytestskipmarkers/utils/saltext/.*\.py)
-
-  - repo: https://github.com/hakancelik96/unimport
-    rev: "0.9.2"
-    hooks:
-      - id: unimport
-        name: Remove unused imports
-        args: [--remove]
-        exclude: ^(docs/.*\.py|src/pytestskipmarkers/(cli|daemons)/__init__\.py)$
+        exclude: ^src/pytestskipmarkers/downgraded/.*\.py$
 
   - repo: https://github.com/asottile/reorder_python_imports
     rev: v2.6.0
@@ -61,42 +68,22 @@ repos:
           --py3-plus,
           --application-directories=.:src:examples/echo-extension/src
         ]
-        exclude: src/pytestskipmarkers/version.py
+        exclude: ^src/pytestskipmarkers/(version.py|downgraded/.*)$
 
   - repo: https://github.com/psf/black
     rev: 21.9b0
     hooks:
       - id: black
         args: [-l 100]
-        exclude: src/pytestskipmarkers/version.py
+        exclude: ^src/pytestskipmarkers/(version.py|downgraded/.*)$
 
   - repo: https://github.com/asottile/blacken-docs
     rev: v1.11.0
     hooks:
       - id: blacken-docs
         args: [--skip-errors]
-        files: ^(docs/.*\.rst|src/pytestskipmarkers/.*\.py)$
+        files: ^(.*\.rst|docs/.*\.rst|src/pytestskipmarkers/.*\.py)$
         additional_dependencies: [black==21.9b0]
-
-  - repo: https://github.com/pre-commit/mirrors-pylint
-    rev: v3.0.0a4
-    hooks:
-      - id: pylint
-        name: PyLint
-        args: [--output-format=parseable, --rcfile=.pylintrc]
-        exclude: src/pytestskipmarkers/version.py
-        additional_dependencies:
-          - pyenchant
-
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.910
-    hooks:
-      - id: mypy
-        files: ^(src/|tests/).*\.py$
-        args: []
-        additional_dependencies:
-          - types-attrs
-          - types-setuptools
   # <---- Formatting -------------------------------------------------------------------------------------------------
 
   # ----- Security -------------------------------------------------------------------------------------------------->
@@ -120,3 +107,42 @@ repos:
         args: [--silent, -lll, --skip, B701]
         files: ^tests/.*
   # <---- Security ---------------------------------------------------------------------------------------------------
+
+  # ----- Code Analysis --------------------------------------------------------------------------------------------->
+  - repo: https://github.com/pycqa/flake8
+    rev: '4.0.1'
+    hooks:
+      - id: flake8
+        exclude: ^(src/pytestskipmarkers/(downgraded/.*|version\.py)|\.pre-commit-hooks/.*\.py)$
+        additional_dependencies:
+        - flake8-mypy-fork
+        - flake8-docstrings
+        - flake8-typing-imports
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.931
+    hooks:
+      - id: mypy
+        name: Run mypy against source
+        files: ^src/.*\.py$
+        exclude: ^src/pytestskipmarkers/(downgraded/.*|utils/(socket|time)\.py)$
+        args: [--strict]
+        additional_dependencies:
+          - attrs
+          - types-attrs
+          - types-setuptools
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.931
+    hooks:
+      - id: mypy
+        name: Run mypy against tests
+        files: ^tests/.*\.py$
+        exclude: ^src/pytestskipmarkers/(downgraded/.*|utils/(socket|time)\.py)$
+        args: []
+        additional_dependencies:
+          - pytest
+          - attrs
+          - types-attrs
+          - types-setuptools
+  # <---- Code Analysis ----------------------------------------------------------------------------------------------

.pylint-spelling-words

@@ -39,7 +39,9 @@ lsof
 macos
 mtime
 namespace
+namespaced
 netbsd
+noqa
 nox
 openbsd
 os

.pylintrc

@@ -113,7 +113,8 @@ disable=R,
   import-outside-toplevel,
   wrong-import-position,
   wrong-import-order,
-  missing-whitespace-after-comma
+  missing-whitespace-after-comma,
+  consider-using-f-string
 
 # Disabled:
 # R* [refactoring suggestions & reports]

README.rst

@@ -68,6 +68,7 @@ Once installed, you can now skip some tests with some simple pytest markers, for
 
    import pytest
 
+
    @pytest.mark.skip_unless_on_linux
    def test_on_linux():
        assert True

changelog/8.improvement.rst

@@ -0,0 +1 @@
+The plugin is now fully typed

docs/ref/pytestskipmarkers/utils/markers.rst

@@ -1,3 +1,6 @@
+PyTest Markers related utilities
+================================
+
 .. automodule:: pytestskipmarkers.utils.markers
    :members:
    :show-inheritance:

docs/ref/pytestskipmarkers/utils/platform.rst

@@ -1,3 +1,6 @@
+Platform related utilities
+==========================
+
 .. automodule:: pytestskipmarkers.utils.platform
    :members:
    :show-inheritance:

docs/ref/pytestskipmarkers/utils/ports.rst

@@ -1,3 +1,6 @@
+Ports related utility functions
+===============================
+
 .. automodule:: pytestskipmarkers.utils.ports
    :members:
    :show-inheritance:

noxfile.py

@@ -20,11 +20,11 @@
 IS_DARWIN = sys.platform.lower().startswith("darwin")
 
 if IS_WINDOWS:
-    COVERAGE_FAIL_UNDER_PERCENT = 92
+    COVERAGE_FAIL_UNDER_PERCENT = 91
 elif IS_DARWIN:
-    COVERAGE_FAIL_UNDER_PERCENT = 95
+    COVERAGE_FAIL_UNDER_PERCENT = 93
 else:
-    COVERAGE_FAIL_UNDER_PERCENT = 95
+    COVERAGE_FAIL_UNDER_PERCENT = 93
 
 # Be verbose when running under a CI context
 PIP_INSTALL_SILENT = (
@@ -116,7 +116,7 @@ def session_run_always(session, *command, **kwargs):
 @nox.session(python=("3", "3.5", "3.6", "3.7", "3.8", "3.9"))
 def tests(session):
     """
-    Run tests
+    Run tests.
     """
     env = {}
     if SKIP_REQUIREMENTS_INSTALL is False:
@@ -238,7 +238,7 @@ def _lint(session, rcfile, flags, paths):
             sys.stdout.flush()
             if pylint_report_path:
                 # Write report
-                with open(pylint_report_path, "w") as wfh:
+                with open(pylint_report_path, "w", encoding="utf-8") as wfh:
                     wfh.write(contents)
                 session.log("Report file written to %r", pylint_report_path)
         stdout.close()
@@ -258,7 +258,7 @@ def lint_code(session):
     """
     Run PyLint against the code. Set PYLINT_REPORT to a path to capture output.
     """
-    flags = ["--disable=I"]
+    flags = ["--disable=I", "--ignore-paths=src/pytestskipmarkers/downgraded/.*"]
     if session.posargs:
         paths = session.posargs
     else:
@@ -282,7 +282,7 @@ def lint_tests(session):
 @nox.session(python="3")
 def docs(session):
     """
-    Build Docs
+    Build Docs.
     """
     session.install(
         "--progress-bar=off",
@@ -297,7 +297,7 @@ def docs(session):
     session.run("make", "coverage", "SPHINXOPTS=-W", external=True)
     docs_coverage_file = os.path.join("_build", "html", "python.txt")
     if os.path.exists(docs_coverage_file):
-        with open(docs_coverage_file) as rfh:
+        with open(docs_coverage_file, encoding="utf-8") as rfh:
             contents = rfh.readlines()[2:]
             if contents:
                 session.error("\n" + "".join(contents))
@@ -308,7 +308,7 @@ def docs(session):
 @nox.session(name="docs-dev", python="3")
 def docs_dev(session):
     """
-    Build Docs
+    Build Docs.
     """
     session.install(
         "--progress-bar=off",
@@ -325,7 +325,7 @@ def docs_dev(session):
 @nox.session(name="docs-crosslink-info", python="3")
 def docs_crosslink_info(session):
     """
-    Report intersphinx cross links information
+    Report intersphinx cross links information.
     """
     session.install(
         "--progress-bar=off",
@@ -367,7 +367,7 @@ def docs_crosslink_info(session):
 @nox.session(name="gen-api-docs", python="3")
 def gen_api_docs(session):
     """
-    Generate API Docs
+    Generate API Docs.
     """
     session.install(
         "--progress-bar=off",

requirements/lint.txt

@@ -1,7 +1,10 @@
 -r base.txt
 -r tests.txt
-pylint==2.7.4
-saltpylint==2020.9.28
+pylint==2.12.2
 pyenchant
 black; python_version >= '3.7'
 reorder-python-imports; python_version >= '3.7'
+flake8 >= 4.0.1
+flake8-mypy-fork
+flake8-docstrings
+flake8-typing-imports