Merge pull request #2114 from effigies/sty/ruff

chore(schemacode): Switch from black/isort/flake8 to ruff

Author: effigies

.github/workflows/validation.yml

@@ -37,62 +37,33 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3
-      - name: Install dependencies
-        run: pip install yamllint
+      - uses: actions/setup-uv@v6
       - name: Lint yml files in src/schema
-        run: yamllint -f standard src/schema/ -c .yamllint.yml
+        run: uvx yamllint -f standard src/schema/ -c .yamllint.yml
 
   # Python best practices
   python-style:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3
-      - run: python -m pip install --upgrade flake8 black isort[colors]
-      - run: black --diff --color --check tools/schemacode
-      - run: isort --diff --color --check tools/schemacode
-      - run: flake8
-        working-directory: tools/schemacode
+      - uses: actions/setup-uv@v6
+      - run: uvx ruff format --diff
+      - run: uvx ruff check
 
   # Avoid Latin phrases to improve readability
   latin-phrases:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install -r tools/requirements.txt
-      - name: Run Python script to check for Latin phrases - Master
-        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
-        run: |
-          python no-bad-latin.py
-        working-directory: tools
-      - name: Run Python script to check for Latin phrases - Pull Request
-        if: github.event.pull_request
-        run: |
-          python no-bad-latin.py
-        working-directory: tools
+      - uses: actions/setup-uv@v6
+      - name: Check for Latin phrases
+        run: uv run tools/no-bad-latin.py
 
   # Validate CITATION.cff
   validate_cff:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: 3
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip setuptools
-        pip3 install cffconvert
-    - name: Validate CITATION.cff
-      run: make validate_citation_cff
+      - uses: actions/checkout@v4
+      - uses: actions/setup-uv@v6
+      - name: Validate CITATION.cff
+        run: uvx cffconvert --validate

.pre-commit-config.yaml

@@ -5,7 +5,7 @@ ci:
 exclude: 'tools/schemacode/src/bidsschematools/tests/data/broken_dataset_description.json'
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -15,7 +15,7 @@ repos:
       - id: check-added-large-files
       - id: check-case-conflict
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.29.2
+    rev: 0.33.0
     hooks:
       - id: check-dependabot
       - id: check-github-workflows
@@ -24,50 +24,33 @@ repos:
         files: src/metaschema.json
       - id: check-readthedocs
         files: readthedocs.yml
-  - repo: https://github.com/psf/black
-    rev: 24.8.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.9
     hooks:
-      - id: black
-        files: ^tools/(?!schemacode)
-        args: ["--verbose"]
-      - id: black
-        name: "black bidsschematools"
-        files: tools/schemacode
-        args: ["--config", "tools/schemacode/pyproject.toml", "--verbose"]
-  - repo: https://github.com/pyCQA/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
-        files: ^tools/(?!schemacode)
-        args: ["--profile", "black"]
-      - id: isort
-        name: "isort bidsschematools"
-        files: tools/schemacode
-        args: ["--settings-file", "tools/schemacode/pyproject.toml"]
-  - repo: https://github.com/pyCQA/flake8
-    rev: 7.1.1
-    hooks:
-      - id: flake8
-        args: [--config=tools/schemacode/setup.cfg]
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+      - id: ruff
+        args: [--select, ISC001, --fix]
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
         entry: env PRETTIER_LEGACY_CLI=1 prettier # temporary fix for https://github.com/prettier/prettier/issues/15742
         files: src/schema/.*/.*\.yaml
   - repo: https://github.com/adrienverge/yamllint
-    rev: v1.35.1
+    rev: v1.37.1
     hooks:
       - id: yamllint
         args: [-f=standard, -c=.yamllint.yml]
         files: src/schema/.*/.*\.yaml
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         args: ["--config=.codespellrc", "--dictionary=-", "--dictionary=.codespell_dict"]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.2
+    rev: v1.15.0
     hooks:
       - id: mypy
         # Sync with project.optional-dependencies.typing

pdf_build_src/check_pandoc_log.py

@@ -13,7 +13,6 @@
 # go through the logs (list of dicts)
 duplicate_link_refs = []
 for log_dict in logs:
-
     # Check for DuplicateLinkReference
     logtype = log_dict.get("type", None)
     logverbosity = log_dict.get("verbosity", None)

pdf_build_src/pandoc_script.py

@@ -66,7 +66,7 @@ def _flatten_values(lst):
     # appendices/ as a resource-path so that the relative files can
     # be found.
     build_root = HERE.parent
-    cmd += [f'--resource-path=.:{build_root / "appendices"}']
+    cmd += [f"--resource-path=.:{build_root / 'appendices'}"]
 
     # Add input files to command
     # The filenames in `markdown_list` will ensure correct order when sorted

pdf_build_src/process_markdowns.py

@@ -158,7 +158,6 @@ def remove_internal_links_reference(root_path):
                 # first find, which links need to be remove by scanning the
                 # references, and remove the reference
                 for ind, line in enumerate(data):
-
                     match = pattern_ref.search(line)
 
                     if match:
@@ -175,7 +174,6 @@ def remove_internal_links_reference(root_path):
                     # link
                     pattern = re.compile(r"\[([^\]]+)\]\[" + f"{link}" + r"\]")
                     for ind, line in enumerate(data):
-
                         match = pattern.search(line)
 
                         if match:
@@ -256,7 +254,6 @@ def assert_no_multiline_links(root_path):
                 code_context = False
                 macro_context = False
                 for ind, line in enumerate(data):
-
                     # do not check "code blocks" or "macros"
                     if line.strip().startswith("```"):
                         code_context = not code_context
@@ -277,8 +274,7 @@ def assert_no_multiline_links(root_path):
 
     if len(problems) > 0:
         msg = (
-            "Found multiline markdown links! Please reformat as single"
-            " line links.\n\n"
+            "Found multiline markdown links! Please reformat as single line links.\n\n"
         )
         msg += json.dumps(problems, indent=4)
         raise AssertionError(msg)
@@ -378,7 +374,6 @@ def correct_table(table, offset=[0.0, 0.0], debug=False):
     # correct alignment of fences and populate the new table (A List of str)
     new_table = []
     for i, row in enumerate(table):
-
         if i == 1:
             str_format = " {:-{align}{width}} "
         else:
@@ -678,7 +673,6 @@ def process_macros(duplicated_src_dir_path):
 
 
 if __name__ == "__main__":
-
     duplicated_src_dir_path = "src_copy/src"
 
     # make a copy of the src directory in the current directory

pdf_build_src/remove_admonitions.py

@@ -16,14 +16,12 @@
 def remove_admonitions(
     input_folder: str | Path, output_folder: str | Path, indent: str = None
 ):
-
     if indent is None:
         indent = INDENT
 
     md_files = Path(input_folder).glob("**/*.md")
 
     for file in md_files:
-
         with open(file, "r", encoding="utf8") as f:
             content = f.readlines()
 
@@ -32,11 +30,9 @@ def remove_admonitions(
         print(f"processing: {file}\n to: {output_file}")
 
         with open(output_file, "w", encoding="utf8") as f:
-
             is_admonition = False
             counter = 0
             for line in content:
-
                 if any(line.startswith(x) for x in ADMONITION_DELIMITERS):
                     is_admonition = True
                     counter = 0

pdf_build_src/test_remove_admonitions.py

@@ -12,7 +12,6 @@ def test_remove_admonitions(tmp_path):
     generated_files = list(tmp_path.glob("**/*.md"))
 
     for file in generated_files:
-
         expected = expected_folder / file.relative_to(tmp_path)
 
         with open(expected, "r", encoding="utf8") as f:

src/schema/README.md

@@ -439,7 +439,7 @@ arrays or objects:
 | `properties`           | The object described has a given set of fields; the values of these fields may be constrained |
 | `additionalProperties` | The object described has constraints on its values, but not the names                         |
 
-### On re-used objects with different definitions
+### On reused objects with different definitions
 
 In a few cases, two objects with the same name appear multiple times in the specification.
 When this happens, it is preferred to find a common definition, and clarify it in the rules (see below).

src/schema/objects/metadata.yaml

@@ -523,7 +523,7 @@ ContinuousHeadLocalization:
   name: ContinuousHeadLocalization
   display_name: Continuous Head Localization
   description: |
-    `true` or `false` value indicating whether continuous head localisation
+    `true` or `false` value indicating whether continuous head localization
     was performed.
   type: boolean
 ContrastBolusIngredient:
@@ -1469,7 +1469,7 @@ HeadCoilFrequency:
   name: HeadCoilFrequency
   display_name: Head Coil Frequency
   description: |
-    List of frequencies (in Hz) used by the head localisation coils
+    List of frequencies (in Hz) used by the head localization coils
     ('HLC' in CTF systems, 'HPI' in Neuromag/Elekta/MEGIN, 'COH' in BTi/4D)
     that track the subject's head position in the MEG helmet
     (for example, `[293, 307, 314, 321]`).
@@ -2130,7 +2130,7 @@ MaxMovement:
   display_name: Max Movement
   description: |
     Maximum head movement (in mm) detected during the recording,
-    as measured by the head localisation coils (for example, `4.8`).
+    as measured by the head localization coils (for example, `4.8`).
   type: number
   unit: mm
 MeasurementToolMetadata: