Merge pull request #27 from andhus/formatting-follow-up

Formatting follow up

Author: andhus

.flake8

@@ -1,4 +1,4 @@
-name: Run tests
+name: CI
 
 on:
   push:
@@ -12,6 +12,15 @@ on:
     types: [published, edited]
 
 jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.8"
+      - uses: pre-commit/action@v3.0.1
+
   tests:
     runs-on: ubuntu-latest
     strategy:
@@ -40,14 +49,6 @@ jobs:
           key: ${{ runner.os }}-${{ matrix.python-version }}-tox-${{ hashFiles('setup.py') }}-${{ hashFiles('setup.cfg') }} }}
       - name: Test with tox
         run: tox
-      - name: Commit and Push to Pull Request
-        if: matrix.python-version == 3.8
-        run: |
-          if [ -n "$(git status -s)" ]; then
-            git add .
-            git commit -m "✨ ⭐ Automated commit has been added to your pull request to fix formatting! ⭐ ✨"
-            git push origin ${{ github.head_ref }}
-          fi
       - uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/test.yml renamed to .github/workflows/ci.yml

@@ -1,30 +1,13 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 24.3.0
-    hooks:
-      - id: black
-        args: ["--target-version", "py38"]
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
-        args: ["--profile", "black"]
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v3.1.0
     hooks:
       - id: prettier
-        args: [--prose-wrap=preserve, --print-width=90]
-  - repo: https://github.com/pycqa/flake8
-    rev: 7.0.0
-    hooks:
-      - id: flake8
+        args: [--prose-wrap=preserve, --print-width=88]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.3.7
     hooks:
       - id: ruff
+        args:
+          - --fix
       - id: ruff-format
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.2
-    hooks:
-      - id: pyupgrade
-        args: ["--py38-plus"]

.pre-commit-config.yaml

@@ -65,7 +65,7 @@ def time_shell(cmd, runs=1, repetitions=1, setup=None):
         time_cmd = f"{setup}; {time_cmd}"
 
     realtimes = []
-    for i in range(runs):
+    for _run in range(runs):
         process = subprocess.run(
             time_cmd, capture_output=True, text=True, shell=True, check=True
         )
@@ -77,10 +77,10 @@ def time_shell(cmd, runs=1, repetitions=1, setup=None):
             min_str, sec_str = t_str.split("m")
             sec = 60 * int(min_str) + float(sec_str[:-1])
             sec_per_rep = sec / repetitions
-        except:  # noqa: E722
+        except Exception as exc:
             raise RuntimeError(
                 f"Failed to parse `time` stderr output: {process.stderr}"
-            )
+            ) from exc
         realtimes.append(sec_per_rep)
 
     return realtimes
@@ -167,7 +167,7 @@ def benchmark(dirpath, algorithm, **kwargs):
                 "t_median",
             ]
         ]
-        for (tc, alg), subdf in df.groupby(["test_case", "algorithm"]):
+        for (_tc, _alg), subdf in df.groupby(["test_case", "algorithm"]):
             t_ref = subdf[subdf["implementation"] == "shell reference"][
                 "t_median"
             ].values[0]

benchmark/run.py

@@ -1,3 +1,20 @@
 [build-system]
 requires = ["setuptools", "versioneer==0.29"]
 build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+target-version = "py38"
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+]
+
+[tool.ruff.lint.isort]
+known-local-folder = ["dirhash"]

pyproject.toml

@@ -8,6 +8,8 @@
 # Generated by versioneer-0.29
 # https://github.com/python-versioneer/python-versioneer
 
+# ruff: noqa
+
 """Git implementation of _version.py."""
 
 import errno

src/dirhash/_version.py

@@ -127,11 +127,11 @@ def get_kwargs(args):
         dest="entry_properties",
         default=["data", "name"],
         help=(
-            "List of file/directory properties to include in the hash. "
-            f"Available properties are: {list(dirhash.Protocol.EntryProperties.options)} "
-            "and at least one of name and data must be included. "
-            "Default is [data name] which means that both the name/paths "
-            "and content (actual data) of files and directories will be included"
+            "List of file/directory properties to include in the hash. Available "
+            f"properties are: {list(dirhash.Protocol.EntryProperties.options)} and at "
+            "least one of name and data must be included. Default is [data name] which "
+            "means that both the name/paths and content (actual data) of files and "
+            "directories will be included"
         ),
         metavar="",
     )

src/dirhash/cli.py

@@ -429,7 +429,7 @@ def test_empty_dir_inclusion_not_affected_by_match(self):
 
 def dirhash_mp_comp(*args, **kwargs):
     res = dirhash(*args, **kwargs)
-    res_mp = dirhash(jobs=2, *args, **kwargs)
+    res_mp = dirhash(*args, **{**kwargs, "jobs": 2})
     assert res == res_mp
     return res
 

tests/test_dirhash.py

@@ -1,15 +1,17 @@
 [tox]
-envlist = py{38,39,310,311,312}
+envlist = pre-commit,py{38,39,310,311,312}
 
 [testenv]
-allowlist_externals = bash
 deps =
-    pre-commit
     pytest
     pytest-cov
 commands =
-    bash -ec 'if [[ ${envpython} == *"py38"* ]]; then pre-commit run --all-files; fi' {posargs}
-    pytest --cov=dirhash --cov-report=xml --cov-report=term-missing --cov-config=.coveragerc tests/ {posargs}
+    pytest --cov=dirhash --cov-report=xml --cov-report=term-missing --cov-config=.coveragerc {posargs:tests}
+
+[testenv:pre-commit]
+skip_install = true
+deps = pre-commit
+commands = pre-commit run --all-files --show-diff-on-failure
 
 [gh-actions]
 python =