style: Bumps ruff to 0.1.11 and replaces black (#287)

* chore: Bumps ruff to 0.1.11 * docs: Updates README * ci: Updates CI * style: Updates ruff config * docs: Updates makefile * style: Fixes format * style: Updates ruff config * style: Fixes lint & format * style: Fixes style * style: Fixes types * style: Silences ruff on ARG & ANN * style: Fixes EOF * style: Updates precommit * docs: Updates copyright year * docs: Updates copyright year * docs: Fixes copyright notice
frgfm · Jan 7, 2024 · af1c020 · af1c020
1 parent b6a4670
commit af1c020
Show file tree

Hide file tree

Showing 74 changed files with 595 additions and 692 deletions.
diff --git a/.github/collect_env.py b/.github/collect_env.py
@@ -226,21 +226,15 @@ def get_os(run_lambda):
 def get_env_info():
     run_lambda = run
 
-    if HOLOCRON_AVAILABLE:
-        holocron_str = holocron.__version__
-    else:
-        holocron_str = "N/A"
+    holocron_str = holocron.__version__ if HOLOCRON_AVAILABLE else "N/A"
 
     if TORCH_AVAILABLE:
         torch_str = torch.__version__
         cuda_available_str = torch.cuda.is_available()
     else:
         torch_str = cuda_available_str = "N/A"
 
-    if TORCHVISION_AVAILABLE:
-        torchvision_str = torchvision.__version__
-    else:
-        torchvision_str = "N/A"
+    torchvision_str = torchvision.__version__ if TORCHVISION_AVAILABLE else "N/A"
 
     return SystemEnv(
         holocron_version=holocron_str,
@@ -273,14 +267,14 @@ def get_env_info():
 
 def pretty_str(envinfo):
     def replace_nones(dct, replacement="Could not collect"):
-        for key in dct.keys():
+        for key in dct:
             if dct[key] is not None:
                 continue
             dct[key] = replacement
         return dct
 
     def replace_bools(dct, true="Yes", false="No"):
-        for key in dct.keys():
+        for key in dct:
             if dct[key] is True:
                 dct[key] = true
             elif dct[key] is False:

diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml
@@ -32,7 +32,7 @@ jobs:
           pip install -e . --upgrade
       - name: Import package
         run: python -c "import holocron; print(holocron.__version__)"
-  
+
   pypi:
     runs-on: ubuntu-latest
     steps:

diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml
@@ -15,14 +15,13 @@ jobs:
         python: [3.9]
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v1
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
       - name: Run ruff
         run: |
-          pip install ruff==0.1.0
+          pip install ruff==0.1.11
           ruff --version
           ruff check --diff .
 
@@ -34,8 +33,7 @@ jobs:
         python: [3.9]
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v1
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
@@ -53,40 +51,39 @@ jobs:
           mypy --version
           mypy
 
-  black:
+  ruff-format:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
         python: [3.9]
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
-      - name: Run black
+      - name: Run ruff
         run: |
-          pip install "black==23.3.0"
-          black --version
-          black --check --diff .
+          pip install ruff==0.1.11
+          ruff --version
+          ruff format --check --diff .
 
-  bandit:
+  precommit-hooks:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
         python: [3.9]
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
-      - name: Run bandit
+      - name: Run ruff
         run: |
-          pip install bandit[toml]
-          bandit --version
-          bandit -r . -c pyproject.toml
+          pip install pre-commit
+          pre-commit install
+          pre-commit --version
+          pre-commit run --all-files
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -51,7 +51,7 @@ jobs:
         with:
           flags: unittests
           fail_ci_if_error: true
-  
+
   api:
     runs-on: ${{ matrix.os }}
     strategy:

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -2,28 +2,28 @@ default_language_version:
     python: python3.9
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
+      - id: check-added-large-files
       - id: check-ast
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-xml
       - id: check-yaml
         exclude: .conda
-      - id: check-toml
-      - id: check-json
-      - id: check-added-large-files
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
       - id: debug-statements
         language_version: python3
-      - id: check-merge-conflict
+      - id: end-of-file-fixer
       - id: no-commit-to-branch
         args: ['--branch', 'main']
-  - repo: https://github.com/psf/black
-    rev: 23.3.0
-    hooks:
-      - id: black
+      - id: trailing-whitespace
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.1.0'
+    rev: 'v0.1.11'
     hooks:
       - id: ruff
         args:
           - --fix
+      - id: ruff-format
diff --git a/Makefile b/Makefile
@@ -1,13 +1,12 @@
 # this target runs checks on all files
 quality:
+	ruff format --check .
 	ruff check .
 	mypy
-	black --check .
-	bandit -r . -c pyproject.toml
 
 # this target runs checks on all files and potentially modifies some of them
 style:
-	black .
+	ruff format .
 	ruff --fix .
 
 # Run tests for the library

diff --git a/api/app/config.py b/api/app/config.py
@@ -1,4 +1,4 @@
-# Copyright (C) 2022-2023, François-Guillaume Fernandez.
+# Copyright (C) 2022-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

diff --git a/api/app/main.py b/api/app/main.py
@@ -1,4 +1,4 @@
-# Copyright (C) 2022-2023, François-Guillaume Fernandez.
+# Copyright (C) 2022-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

diff --git a/api/app/routes/classification.py b/api/app/routes/classification.py
@@ -1,4 +1,4 @@
-# Copyright (C) 2022-2023, François-Guillaume Fernandez.
+# Copyright (C) 2022-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.
@@ -12,8 +12,8 @@
 router = APIRouter()
 
 
-@router.post("/", response_model=ClsCandidate, status_code=status.HTTP_200_OK, summary="Perform image classification")
-async def classify(file: UploadFile = File(...)):
+@router.post("/", status_code=status.HTTP_200_OK, summary="Perform image classification")
+async def classify(file: UploadFile = File(...)) -> ClsCandidate:
     """Runs holocron vision model to analyze the input image"""
     probs = classify_image(decode_image(file.file.read()))
 

diff --git a/api/app/schemas.py b/api/app/schemas.py
@@ -1,4 +1,4 @@
-# Copyright (C) 2022-2023, François-Guillaume Fernandez.
+# Copyright (C) 2022-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

diff --git a/api/app/vision.py b/api/app/vision.py
@@ -1,4 +1,4 @@
-# Copyright (C) 2022-2023, François-Guillaume Fernandez.
+# Copyright (C) 2022-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

diff --git a/api/docker-compose.yml b/api/docker-compose.yml
@@ -16,7 +16,7 @@ services:
       - "traefik.http.routers.api.service=backend@docker"
       - "traefik.http.routers.api.tls={}"
       - "traefik.http.services.backend.loadbalancer.server.port=8050"
-  
+
   traefik:
     image: traefik:v2.9.6
     volumes:

diff --git a/demo/app.py b/demo/app.py
@@ -1,4 +1,4 @@
-# Copyright (C) 2022-2023, François-Guillaume Fernandez.
+# Copyright (C) 2022-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,4 +1,4 @@
-# Copyright (C) 2019-2023, François-Guillaume Fernandez.
+# Copyright (C) 2019-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.
@@ -22,7 +22,7 @@
 
 from tabulate import tabulate
 
-sys.path.insert(0, Path().resolve().parent.parent)
+sys.path.insert(0, Path().cwd().parent.parent)
 
 
 import holocron
@@ -217,10 +217,12 @@ def inject_checkpoint_metadata(app, what, name, obj, options, lines):
 
             # Loading Meta
             meta = field.value.meta
-            table.append(("url", f"`link <{meta.url}>`__"))
-            table.append(("sha256", meta.sha256[:16]))
-            table.append(("size", f"{meta.size / 1024**2:.1f}MB"))
-            table.append(("num_params", f"{meta.num_params / 1e6:.1f}M"))
+            table.extend((
+                ("url", f"`link <{meta.url}>`__"),
+                ("sha256", meta.sha256[:16]),
+                ("size", f"{meta.size / 1024 ** 2:.1f}MB"),
+                ("num_params", f"{meta.num_params / 1000000.0:.1f}M"),
+            ))
             # Wrap the text
             max_visible = 3
             v = meta.categories
@@ -311,9 +313,7 @@ def add_ga_javascript(app, pagename, templatename, context, doctree):
   gtag('js', new Date());
   gtag('config', '{0}');
 </script>
-    """.format(
-        app.config.googleanalytics_id
-    )
+    """.format(app.config.googleanalytics_id)
     context["metatags"] = metatags
 
 

diff --git a/holocron/models/checkpoints.py b/holocron/models/checkpoints.py
@@ -1,4 +1,4 @@
-# Copyright (C) 2023, François-Guillaume Fernandez.
+# Copyright (C) 2023-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

diff --git a/holocron/models/classification/convnext.py b/holocron/models/classification/convnext.py
@@ -1,4 +1,4 @@
-# Copyright (C) 2022-2023, François-Guillaume Fernandez.
+# Copyright (C) 2022-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.
@@ -46,7 +46,7 @@ class LayerScale(nn.Module):
 
     def __init__(self, chans: int, scale: float = 1e-6) -> None:
         super().__init__()
-        self.register_parameter("weight", nn.Parameter(scale * torch.ones(chans)))
+        self.register_parameter("weight", nn.Parameter(scale * torch.ones(chans)))  # type: ignore[arg-type]
 
     def forward(self, x: torch.Tensor) -> torch.Tensor:
         return x * self.weight.reshape(1, -1, *((1,) * (x.ndim - 2)))
@@ -168,19 +168,17 @@ def __init__(
             block_idx += _num_blocks
 
         super().__init__(
-            OrderedDict(
-                [
-                    ("features", nn.Sequential(*_layers)),
-                    ("pool", GlobalAvgPool2d(flatten=True)),
-                    (
-                        "head",
-                        nn.Sequential(
-                            nn.LayerNorm(planes[-1], eps=1e-6),
-                            nn.Linear(planes[-1], num_classes),
-                        ),
+            OrderedDict([
+                ("features", nn.Sequential(*_layers)),
+                ("pool", GlobalAvgPool2d(flatten=True)),
+                (
+                    "head",
+                    nn.Sequential(
+                        nn.LayerNorm(planes[-1], eps=1e-6),
+                        nn.Linear(planes[-1], num_classes),
                     ),
-                ]
-            )
+                ),
+            ])
         )
 
         # Init all layers