Merge pull request #50 from PascalEgn/add-ruff-and-pre-commit

add ruff and pre-commit

Author: ioannistsanaktsidis

.github/workflows/bump-and-publish.yml

@@ -40,7 +40,7 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: ${{ github.ref }}
           tags: true
-      
+
       - name: get sha
         id: sha
         run: |

.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: Lint
+
+on:
+  workflow_call:
+    inputs:
+      ref:
+        description: The reference to build
+        type: string
+        required: true
+
+jobs:
+  linter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+
+      - name: Pre-commit check
+        uses: pre-commit/action@v3.0.1

.github/workflows/pull-request-master.yml

@@ -5,8 +5,14 @@ on:
     branches: [master]
 
 jobs:
+  lint:
+    uses: ./.github/workflows/lint.yml
+    with:
+      ref: ${{ github.event.pull_request.head.sha }}
   python3_tests:
+    needs: lint
     uses: ./.github/workflows/test-python.yml
 
   python2_tests:
+    needs: lint
     uses: ./.github/workflows/test-python-py2.yml

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: name-tests-test
+        args: [ --pytest-test-first ]
+        exclude: '^(?!factories/)'
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format

.tx/config

@@ -29,7 +29,7 @@
 #    $ python setup.py extract_messages
 #    $ python setup.py init_catalog -l <lang>
 #    $ python setup.py compile_catalog
-# 2) Ensure project has been created on Transifex under the 
+# 2) Ensure project has been created on Transifex under the
 #    inveniosoftware-contrib organisation.
 # 3) Install the transifex-client
 #    $ pip install transifex-client

docs/_ext/ultramock.py

@@ -23,6 +23,7 @@
 # as an Intergovernmental Organization or submit itself to any jurisdiction.
 
 """Hijacks `mock` to fake as many non-available modules as possible."""
+
 import sys
 import types
 
@@ -33,13 +34,17 @@
 
 # skip `_is_magic` check.
 orig_is_magic = mock._is_magic
+
+
 def always_false(*args, **kwargs):
     return False
 
 
 # avoid spec configuration for mocked classes with super classes.
 # honestly this does not happen very often and is kind of a tricky case.
 orig_mock_add_spec = mock.NonCallableMock._mock_add_spec
+
+
 def mock_add_spec_fake(self, spec, spec_set):
     orig_mock_add_spec(self, None, None)
 
@@ -66,7 +71,7 @@ class MockedModule(types.ModuleType):
     def __init__(self, name):
         super(types.ModuleType, self).__init__(name)
         self.__name__ = super.__name__
-        self.__file__ = self.__name__.replace('.', '/') + '.py'
+        self.__file__ = self.__name__.replace(".", "/") + ".py"
         sys.modules[self.__name__] = self
 
     def __getattr__(self, key):
@@ -77,12 +82,16 @@ def __getattr__(self, key):
 
 # overwrite imports
 orig_import = __import__
+
+
 def import_mock(name, *args, **kwargs):
     try:
         return orig_import(name, *args, **kwargs)
     except ImportError:
         return MockedModule(name)
-import_patch = mock.patch('__builtin__.__import__', side_effect=import_mock)
+
+
+import_patch = mock.patch("__builtin__.__import__", side_effect=import_mock)
 
 
 # public methods