fix

Author: Filip Richtarik

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 90
+extend-ignore=E203

.github/workflows/test.yml

@@ -40,65 +40,15 @@ 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 }}
           verbose: true
-
-  # Always run this last as it can push new changes and actions will not rerun.
-  # not working on pull requests from forks
-  pre-commit:
-    if: false
-    permissions:
-      contents: write
-      pull-requests: write
-    needs: [tests]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.head_ref }}
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.8"
-
-      - name: Install PreCommit
-        run: pip install pre-commit
-
-      - uses: actions/cache@v4
-        with:
-          path: ~/.cache/pre-commit
-          key: ${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pre-commit-
-
-      - name: PreCommit
-        id: pre-commit
-        run: |
-          if pre-commit run --show-diff-on-failure --color=always --all-files; then
-            echo "failed=0" >> $GITHUB_OUTPUT
-          else
-            echo "failed=1" >> $GITHUB_OUTPUT
-          fi
-          if [ -n "$(git status -s)" ]; then
-            echo "dirty=1" >> $GITHUB_OUTPUT
-          else
-            echo "dirty=0" >> $GITHUB_OUTPUT
-          fi
-
-      # Run a second time to verify that everything has indeed been fixed.
-      - name: PreCommit verify
-        if: steps.pre-commit.outputs.failed == 1
-        run: |
-          pre-commit run --show-diff-on-failure --color=always --all-files
-
-      - name: Commit and Push to Pull Request
-        if: steps.pre-commit.outputs.dirty == 1
-        run: |
-          git add .
-          git status
-          git commit -m "✨ ⭐ Automated commit has been added to your pull request to fix formatting! ⭐ ✨"
-          git push origin ${{ github.head_ref }}

.pre-commit-config.yaml

@@ -18,7 +18,11 @@ repos:
     rev: 7.0.0
     hooks:
       - id: flake8
-        args: ["--max-line-length=90", "--extend-ignore=E203,W503"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.7
+    hooks:
+      - id: ruff
+      - id: ruff-format
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.15.2
     hooks:

benchmark/run.py

@@ -60,9 +60,7 @@ def require_test_cases():
 
 
 def time_shell(cmd, runs=1, repetitions=1, setup=None):
-    time_cmd = "time for i in {{1..{rep}}}; do {cmd}; done".format(
-        cmd=cmd, rep=repetitions
-    )
+    time_cmd = f"time for i in {{1..{repetitions}}}; do {cmd}; done"
     if setup is not None:
         time_cmd = f"{setup}; {time_cmd}"
 
@@ -97,8 +95,8 @@ def get_reference_shell_cmd(dirpath, algorithm):
     else:
         raise ValueError("only md5 and sha supported")
 
-    return "find {dir} -type f -print0 | sort -z | xargs -0 {alg} | {alg}".format(
-        dir=dirpath, alg=algorithm
+    return (
+        f"find {dirpath} -type f -print0 | sort -z | xargs -0 {algorithm} | {algorithm}"
     )
 
 

src/dirhash/__init__.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python
-"""dirhash - a python library (and CLI) for hashing of file system directories.
-"""
+"""dirhash - a python library (and CLI) for hashing of file system directories."""
 
 import hashlib
 import os
@@ -458,9 +457,8 @@ def __init__(self, entry_properties=("name", "data"), allow_cyclic_links=False):
         entry_properties = set(entry_properties)
         if not entry_properties.issubset(self.EntryProperties.options):
             raise ValueError(
-                "entry properties {} not supported".format(
-                    entry_properties - self.EntryProperties.options
-                )
+                f"entry properties {entry_properties - self.EntryProperties.options} "
+                "not supported"
             )
         if not (
             self.EntryProperties.NAME in entry_properties
@@ -476,8 +474,7 @@ def __init__(self, entry_properties=("name", "data"), allow_cyclic_links=False):
 
         if not isinstance(allow_cyclic_links, bool):
             raise ValueError(
-                "allow_cyclic_link must be a boolean, "
-                "got {}".format(allow_cyclic_links)
+                f"allow_cyclic_link must be a boolean, got {allow_cyclic_links}"
             )
         self.allow_cyclic_links = allow_cyclic_links
 

src/dirhash/_version.py

@@ -381,9 +381,8 @@ def git_pieces_from_vcs(
             if verbose:
                 fmt = "tag '%s' doesn't start with prefix '%s'"
                 print(fmt % (full_tag, tag_prefix))
-            pieces["error"] = "tag '{}' doesn't start with prefix '{}'".format(
-                full_tag,
-                tag_prefix,
+            pieces["error"] = (
+                f"tag '{full_tag}' doesn't start with prefix '{tag_prefix}'"
             )
             return pieces
         pieces["closest-tag"] = full_tag[len(tag_prefix) :]

src/dirhash/cli.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python
-"""Get hash for the content and/or structure of a directory.
-"""
+"""Get hash for the content and/or structure of a directory."""
 
 import argparse
 import sys
@@ -39,14 +38,13 @@ def get_kwargs(args):
         choices=dirhash.algorithms_available,
         default="md5",
         help=(
-            'Hashing algorithm to use, by default "md5". Always available: {}. '
-            "Additionally available on current platform: {}. Note that the same "
-            "algorithm may appear multiple times in this set under different names "
-            "(thanks to OpenSSL) "
-            "[https://docs.python.org/2/library/hashlib.html]".format(
-                sorted(dirhash.algorithms_guaranteed),
-                sorted(dirhash.algorithms_available - dirhash.algorithms_guaranteed),
-            )
+            "Hashing algorithm to use, by default 'md5'. "
+            f"Always available: {sorted(dirhash.algorithms_guaranteed)}. "
+            f"Additionally available on current platform: "
+            f"{sorted(dirhash.algorithms_available - dirhash.algorithms_guaranteed)}. "
+            "Note that the same algorithm may appear multiple times in this set "
+            "under different names (thanks to OpenSSL) "
+            "[https://docs.python.org/2/library/hashlib.html]."
         ),
         metavar="",
     )
@@ -129,11 +127,12 @@ def get_kwargs(args):
         dest="entry_properties",
         default=["data", "name"],
         help=(
-            "List of file/directory properties to include in the hash. Available "
-            "properties are: {} 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"
-        ).format(list(dirhash.Protocol.EntryProperties.options)),
+            "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"
+        ),
         metavar="",
     )
     protocol_options.add_argument(

tests/test_dirhash.py

@@ -22,7 +22,6 @@
 
 
 class TestGetHasherFactory:
-
     def test_get_guaranteed(self):
         algorithm_and_hasher_factory = [
             ("md5", hashlib.md5),
@@ -59,14 +58,12 @@ def test_not_available(self):
             _get_hasher_factory("not available")
 
     def test_bypass_hasher_factory(self):
-
         # test standard hasher
         hasher_factory = _get_hasher_factory(hashlib.sha256)
         assert hasher_factory is hashlib.sha256
 
         # test raise on custom hasher with bad interface
         class IncompleteMockHasher:
-
             def __init__(self, *args, **kwargs):
                 pass
 
@@ -78,7 +75,6 @@ def update(self, *args, **kwargs):
 
         # test custom hasher with ok interface
         class MockHasher(IncompleteMockHasher):
-
             def hexdigest(self):
                 return ""
 
@@ -87,7 +83,6 @@ def hexdigest(self):
 
 
 class TestGetMatchPatterns:
-
     def test_default_match_all(self):
         ms = get_match_patterns()
         assert ms == ["*"]
@@ -139,7 +134,6 @@ def test_ignore_extensions(self):
 
 
 class TempDirTest:
-
     def setup_method(self):
         self.dir = tempfile.mkdtemp()
 
@@ -441,7 +435,6 @@ def dirhash_mp_comp(*args, **kwargs):
 
 
 class TestDirhash(TempDirTest):
-
     def test_guaranteed_algorithms(self):
         self.mkdirs("root/d1/d11")
         self.mkdirs("root/d2")
@@ -545,7 +538,6 @@ def test_symlinked_dir(self):
         assert root1_linked_dirs_true == root2
 
     def test_cache_used_for_symlinks(self):
-
         self.mkdirs("root/dir")
         self.mkfile("root/file", "< one chunk content")
         for i in range(10):
@@ -667,7 +659,6 @@ def test_raise_on_not_at_least_one_of_name_and_data(self):
             )
 
     def test_multiproc_speedup(self):
-
         self.mkdirs("root/dir")
         num_files = 10
         for i in range(num_files):
@@ -809,7 +800,6 @@ def hexdigest(self):
 
 
 class IdentityHasher:
-
     def __init__(self, initial_data=b""):
         self.datas = [initial_data.decode("utf-8")]
 
@@ -821,7 +811,6 @@ def hexdigest(self):
 
 
 class TestProtocol:
-
     def test_raise_for_invalid_entry_properties(self):
         with pytest.raises(ValueError):
             Protocol(entry_properties=["not-valid"])

tox.ini

@@ -2,12 +2,13 @@
 envlist = py{38,39,310,311,312}
 
 [testenv]
+allowlist_externals = bash
 deps =
     pre-commit
     pytest
     pytest-cov
 commands =
-    pre-commit run --all-files
+    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}
 
 [gh-actions]