simplify testing pipeline

Author: mr-mixas

.github/workflows/tests.yml

@@ -7,49 +7,47 @@ jobs:
       matrix:
         os: ['ubuntu-20.04']
         python-version:
-        - 3.7
-        - 3.8
-        - 3.9
-        - pypy-3.7
-        - pypy-3.8
-        - pypy-3.9
-        - pypy-3.10
+        - '3.7'
+        - '3.8'
+        - '3.9'
+        - 'pypy-3.7'
+        - 'pypy-3.8'
+        - 'pypy-3.9'
+        - 'pypy-3.10'
         tox-env: ['essential']
         include:
         - os: macos-latest
           python-version: '3.12'
           tox-env: essential
         - os: windows-latest
-          python-version: '3.12'
+          python-version: '3.11'
           tox-env: essential
         - os: ubuntu-latest
           python-version: '3.10'
-          tox-env: linters
-        - os: ubuntu-latest
-          python-version: '3.11'
-          tox-env: coverage
+          tox-env: extended
     steps:
     - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+        cache: 'pip'
 
     - name: Install dependencies
       run: |
         pip install --quiet --upgrade pip setuptools tox>=4.5.1
 
-    - name: Run test without coverage
-      if: ${{ matrix.tox-env != 'coverage' }}
+    - name: Run essential tests
+      if: ${{ matrix.tox-env != 'extended' }}
       run: |
         tox run -e ${{ matrix.tox-env }}
 
-    - name: Run tests with coverage
-      if: ${{ matrix.tox-env == 'coverage' }}
+    - name: Run linters and coverage
+      if: ${{ matrix.tox-env == 'extended' }}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
         pip install --quiet --upgrade coveralls
-        tox run -e coverage
+        tox run -e ${{ matrix.tox-env }}
         coveralls --service=github

nested_diff/__init__.py

@@ -41,8 +41,7 @@
 
 
 class Differ:
-    """
-    Compute recursive diff for two passed objects.
+    """Compute recursive diff for two passed objects.
 
     Dicts, lists, tuples, sets and frozensets traversed recursively, other
     types compared by values. Any type diff may be customized by user-defined

nested_diff/cli.py

@@ -228,7 +228,7 @@ def run(self):
         Raises:
             NotImplementedError: Must be implemented in derivatives.
 
-        """
+        """  # noqa: D406
         raise NotImplementedError
 
 

nested_diff/diff_tool.py

@@ -208,10 +208,7 @@ def get_dumper(self, fmt, **kwargs):
 
         """
         if fmt == 'auto':
-            if self.args.out.isatty():
-                fmt = 'term'
-            else:
-                fmt = 'text'
+            fmt = 'term' if self.args.out.isatty() else 'text'
 
         if fmt in FormatterDumper.supported_fmts:
             return FormatterDumper(fmt=fmt, values=self.args.values, **kwargs)

nested_diff/handlers.py

@@ -212,6 +212,7 @@ def diff(self, differ, a, b):
         >>> Differ(handlers=[DictHandler()], O=False, U=False).diff(a, b)
         (False, {'D': {'three': {'R': 3}, 'two': {'N': 42}}})
         >>>
+
         """
         diff = {}
         equal = True
@@ -243,10 +244,7 @@ def diff(self, differ, a, b):
                 diff[key] = subdiff
 
         if diff:
-            if equal:
-                diff = {'U': a}
-            else:
-                diff = {'D': diff}
+            diff = {'U': a} if equal else {'D': diff}
         elif equal and differ.op_u:
             diff = {'U': a}
 
@@ -341,6 +339,7 @@ def diff(self, differ, a, b):
         >>> Differ(handlers=[ListHandler()], O=False, U=False).diff(a, b)
         (False, {'D': [{'R': 0}, {'N': 4, 'I': 3}, {'A': 5}]})
         >>>
+
         """
         self.lcs.set_seq1(tuple(differ.dump(i) for i in a))
         self.lcs.set_seq2(tuple(differ.dump(i) for i in b))
@@ -509,6 +508,7 @@ def diff(self, differ, a, b):
         >>> Differ(handlers=[TupleHandler()], O=False, U=False).diff(a, b)
         (False, {'D': ({'A': 0}, {'N': 3, 'I': 2}, {'R': 5})})
         >>>
+
         """
         equal, diff = super().diff(differ, a, b)
 
@@ -559,6 +559,7 @@ def diff(self, differ, a, b):
         >>> Differ(handlers=[SetHandler()], U=False).diff(a, b)
         (False, {'D': [{'R': 1}, {'A': 3}], 'E': 3})
         >>>
+
         """
         diff = []
         equal = True
@@ -677,6 +678,7 @@ def diff(self, differ, a, b):
         (False,
          {'D': [{'I': [0, 1, 0, 2]}, {'U': 'one'}, {'A': 'two'}], 'E': 5})
         >>>
+
         """
         lines_a = a.split('\n', -1)
         lines_b = b.split('\n', -1)

pyproject.toml

@@ -60,15 +60,15 @@ lint = [
     'flake8-pytest-style',
     'flake8_quotes',
     'flake8-return',
-    'flake8-simplify',
     'flake8-unused-arguments',
     'pep8-naming',
     'pytest-flake8',
 ]
 test = [
     'pytest',
+    'pytest-cov',
     'pytest-ruff',
-    'ruff==0.1.15',  # pin for reproducible results
+    'ruff==0.3.0',  # pin for reproducible results
 ]
 
 [project.scripts]
@@ -81,6 +81,10 @@ Repository = 'https://github.com/mr-mixas/Nested-Diff.py.git'
 
 [tool.pytest.ini_options]
 addopts = """
+          --cov=nested_diff \
+          --cov-fail-under=99 \
+          --cov-report term-missing \
+          --no-cov-on-fail \
           --ruff \
           --ruff-format \
           --verbosity=2 \
@@ -94,8 +98,23 @@ extend-exclude = [
     'tests/data/standard.py',
 ]
 line-length = 79
-select = []
+
+[tool.ruff.extend-per-file-ignores]
+'tests/*' = [
+    'D',  # docstrings
+]
 
 [tool.ruff.format]
 docstring-code-format = true
 quote-style = 'single'
+
+[tool.ruff.lint]
+select = [
+    'D',
+    'E501',
+    'SIM',
+]
+ignore = [
+    'D407',  # Missing dashed underline after section
+    'SIM105',  # contextlib.suppress is slower than try-except-pass
+]

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = linters
+envlist = extended
 usedevelop = true
 
 [testenv:essential]
@@ -13,20 +13,7 @@ extras =
 setenv =
     PYTHONHASHSEED = 1
 
-[testenv:coverage]
-commands =
-    coverage run --source nested_diff -m pytest
-
-deps =
-    coverage
-
-extras =
-    {[testenv:essential]extras}
-
-setenv =
-    PYTHONHASHSEED = 1
-
-[testenv:linters]
+[testenv:extended]
 commands =
     pytest --doctest-modules --flake8
     python -m doctest HOWTO.md README.md
@@ -44,10 +31,9 @@ docstring_style=google
 strictness=short
 
 # pyproject.toml not support yet
+# TODO: remove when migration complete (already handled by ruff)
 [flake8]
 max-line-length = 79
 per-file-ignores =
-    # disable SIM105 (contextlib.suppress is slower than using try-except-pass)
-    nested_diff/*: SIM105
     # disable max line length and all docstrings checks in tests dir
-    tests/*: E501 D SIM105
+    tests/*: E501 D