ci: delegate lint, format and typecheck to pre-commit

Author: Lujeni

.github/workflows/ci.yml

@@ -50,19 +50,9 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.13"
-      - name: Install Python dependencies
-        run: |
-          python -m pip install --upgrade hatch
-      - name: Check with black + isort
-        if: always()
-        run: hatch run style:format && git diff --exit-code
-      - name: Check with ruff
-        if: always()
-        run: hatch run style:lint
-      - name: Check with mypy
-        if: always()
-        run: hatch run types:check
+          python-version: "3.12"
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.1
 
   package:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -19,16 +19,9 @@ repos:
     rev: v1.13.0
     hooks:
       - id: mypy
+        exclude: ^tests/
         additional_dependencies:
           [types-PyYAML, types-setuptools, typing-extensions, pydantic>=2.5.0]
-        args:
-          [
-            --ignore-missing-imports,
-            --warn-unreachable,
-            --no-implicit-optional,
-            --show-error-codes,
-            --plugins=pydantic.mypy,
-          ]
 
   - repo: https://github.com/commitizen-tools/commitizen
     rev: v3.5.3

README.md

@@ -135,23 +135,17 @@ You can now install the project and its dependencies using:
 pip install -e .[test]
 ```
 
-### Code Style and Linting
+### Pre-commit hooks
 
-This project uses [ruff](https://docs.astral.sh/ruff/) for both linting and code formatting. Before submitting a pull request, ensure your code follows the project's style guidelines.
-
-To check for linting and formatting issues:
-```bash
-hatch run style:check
-```
-
-To automatically fix linting issues and format your code:
+Install [pre-commit](https://pre-commit.com/) hooks to run the same checks as CI before each commit:
 ```bash
-hatch run style:format
+pip install pre-commit
+pre-commit install
 ```
 
-To only run linting (with auto-fix):
+Run all hooks manually:
 ```bash
-hatch run style:lint
+pre-commit run --all-files
 ```
 
 ### Testing

pyproject.toml

@@ -81,34 +81,6 @@ matrix.type.scripts = [
     { key = "with-coverage", value = "_coverage", if = ["default"] },
 ]
 
-[tool.hatch.envs.types]
-dependencies = [
-    "mypy",
-    "types-PyYAML",
-    "types-setuptools",
-    "typing-extensions",
-]
-[tool.hatch.envs.types.scripts]
-check = "mypy src/vaultwarden"
-
-[tool.hatch.envs.style]
-detached = true
-dependencies = [
-    "ruff",
-]
-[tool.hatch.envs.style.scripts]
-lint = [
-    "ruff check --fix src/vaultwarden tests",
-]
-check = [
-    "ruff check src/vaultwarden tests",
-    "ruff format --check src/vaultwarden tests",
-]
-format = [
-    "ruff format src/vaultwarden tests",
-    "lint",
-]
-
 [tool.ruff]
 src = ["src/vaultwarden", "tests"]
 exclude = ["src/vaultwarden/utils/crypto.py"]

src/vaultwarden/models/bitwarden.py

@@ -6,7 +6,6 @@
     Any,
     Generic,
     Literal,
-    Self,
     TypeVar,
     Union,
     cast,
@@ -27,6 +26,7 @@
     ValidationInfo,
     ValidatorFunctionWrapHandler,
 )
+from typing_extensions import Self
 
 from vaultwarden.clients.bitwarden import BitwardenAPIClient
 from vaultwarden.models.enum import CipherType, KdfType, OrganizationUserType
@@ -449,7 +449,7 @@ class OrganizationUserDetails(BitwardenBaseModel):
     Collections: list[UserCollection]
     Groups: list | None = None
     TwoFactorEnabled: bool
-    Permissions: dict | None = Field(default_factory=dict)
+    Permissions: dict[str, Any] = Field(default_factory=dict)
 
     @field_validator("OrganizationId")
     @classmethod

tests/models/validation/test_pascal_camel_cases.py

@@ -1,12 +1,12 @@
 import unittest
 
 from pydantic import TypeAdapter
-from src.vaultwarden.models.sync import SyncData, VaultwardenUser
 from vaultwarden.models.bitwarden import (
     Organization,
     OrganizationCollection,
     ResplistBitwarden,
 )
+from vaultwarden.models.sync import SyncData, VaultwardenUser
 
 
 class TestModelCases(unittest.TestCase):