Use ruff in place of black and bandit (#101)

Signed-off-by: Federico Busetti <[email protected]>

Author: febus982

.bandit.yml

@@ -1,7 +1,5 @@
 version: "2"
 plugins:
-  bandit:
-    enabled: true
   sonar-python:
     enabled: true
 exclude_patterns:
@@ -21,4 +19,4 @@ exclude_patterns:
   - "Tests/"
   - "**/vendor/"
   - "**/*_test.go"
-  - "**/*.d.ts"
+  - "**/*.d.ts"

.codeclimate.yml

@@ -27,6 +27,6 @@ jobs:
         python -m pip install poetry
         poetry config virtualenvs.create false
         make dev-dependencies
-    - name: Check code style with black
+    - name: Check code style
       run: |
         make format

.github/workflows/python-code-style.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Bandit checks
+name: Python typing
 
 on:
   push:
@@ -12,21 +12,20 @@ on:
   workflow_dispatch:
 
 jobs:
-  bandit:
+  typing:
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
-
-    - name: Security check - Bandit
-      uses: ioggstream/[email protected]
-      with:
-        project_path: .
-        config_file: .bandit.yml
-
-    # This is optional
-    - name: Security check report artifacts
-      uses: actions/upload-artifact@v4
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
       with:
-        name: Security report
-        path: output/security_report.txt
+        python-version: "3.11"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install poetry
+        poetry config virtualenvs.create false
+        make dev-dependencies
+    - name: Check typing
+      run: make typing

.github/workflows/python-bandit.yml renamed to .github/workflows/python-typing.yml

@@ -45,20 +45,11 @@ migrate:
 	poetry run alembic upgrade heads
 
 format:
-	poetry run black --check .
-
-format-fix:
-	poetry run black .
+	poetry run ruff format --check .
 
 lint:
 	poetry run ruff .
 
-lint-fix:
-	poetry run ruff . --fix
-
-bandit:
-	poetry run bandit -c .bandit.yml -r .
-
 # There are issues on how python imports are generated when using nested
 # packages. The following setup appears to work, however it might need
 # to be reviewed. https://github.com/protocolbuffers/protobuf/issues/1491
@@ -76,8 +67,11 @@ generate-proto:
 	grpc_app/proto/*.proto
 	git add ./grpc_app/generated
 
-fix:  format-fix lint-fix
-check: format lint typing bandit test
+fix:
+	poetry run ruff . --fix
+	poetry run ruff format .
+
+check: lint format typing test
 
 docs:
 	poetry run mkdocs serve

Makefile

@@ -1,7 +1,7 @@
 """create books table
 
 Revision ID: 52b1246eda46
-Revises: 
+Revises:
 Create Date: 2022-11-09 20:33:13.035514
 
 """

alembic/versions/2022-11-09-203313-52b1246eda46_create_tables.py

@@ -34,7 +34,7 @@ class Container(DeclarativeContainer):
 
     """
     Class mappings
-    
+
     These are classes we want the container to manage the life cycle for
     (e.g. Singletons), we map them using their class name directly.
     """
@@ -45,10 +45,10 @@ class Container(DeclarativeContainer):
 
     """
     Interface => Class mappings
-    
+
     We use the interface class name as key so that we can trigger the injection
     using `class.__name__` and avoid using any hardcoded string or constant.
-    
+
     e.g.
     Mapping
         MyInterface = providers.Factory("http_app.storage.repositories.ConcreteClass")

common/di_container.py

@@ -8,14 +8,17 @@
 
 
 class BookRepositoryInterface(Protocol):
-    async def save(self, book: BookModel) -> BookModel: ...
+    async def save(self, book: BookModel) -> BookModel:
+        ...
 
     async def find(
         self,
         search_params: Union[None, Mapping[str, Any]] = None,
         order_by: Union[None, Iterable[Union[str, Tuple[str, SortDirection]]]] = None,
-    ) -> List[BookModel]: ...
+    ) -> List[BookModel]:
+        ...
 
 
 class BookEventGatewayInterface(Protocol):
-    async def emit(self, event: BaseEvent) -> None: ...
+    async def emit(self, event: BaseEvent) -> None:
+        ...