feat: formatting with ruff and more type cleanup (#431)

radiorabe · Mar 31, 2024 · 7caccd8 · 7caccd8
1 parent 80c8b5f
commit 7caccd8
Show file tree

Hide file tree

Showing 12 changed files with 401 additions and 383 deletions.
diff --git a/.flake8 b/.flake8
diff --git a/.isort.cfg b/.isort.cfg
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,35 +1,14 @@
 repos:
-  - repo: local
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
     hooks:
-      - id: black
-        name: black
-        language: system
-        entry: black
-        types: [python]
-      - id: isort
-        name: isort
-        language: system
-        entry: isort
-        types: [python]
-      - id: flake8
-        name: flake8
-        language: system
-        entry: flake8
-        types: [python]
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.8.0
-    hooks:
-    - id: mypy
-      additional_dependencies:
-        - types-openpyxl
-        - types-pytz
-        - types-python-dateutil
-        - types-tqdm
+      - id: ruff
+      - id: ruff-format
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
-        exclude: ^src/api/client.js$
+        exclude: ^(src/api/client.js|tests/__snapshots__/.*ambr)$
       - id: end-of-file-fixer
         exclude: ^src/api/client.js$
       - id: check-symlinks

diff --git a/README.md b/README.md
@@ -161,6 +161,13 @@ As documented in [Usage](#Usage), you can also pass in options on the command li
 ./suisa_sendemeldung.py --bearer-token=abcdefghijklmnopqrstuvwxyzabcdef --stream_id=a-bcdefgh --stdout
 ```
 
+## Development
+
+Snapshot testing is used to test the help output, you can update the snapshots like so:
+```
+poetry run pytest -- --snapshot-update
+```
+
 ## Release Management
 
 The CI/CD setup uses semantic commit messages following the [conventional commits standard](https://www.conventionalcommits.org/en/v1.0.0/).

diff --git a/docs/gen_ref_pages.py b/docs/gen_ref_pages.py
@@ -28,6 +28,7 @@
 with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file:
     nav_file.writelines(nav.build_literate_nav())
 
-readme = Path("README.md").open("r")
-with mkdocs_gen_files.open("index.md", "w") as index_file:
+with Path("README.md").open("r") as readme, mkdocs_gen_files.open(
+    "index.md", "w"
+) as index_file:
     index_file.writelines(readme.read())