ВСК-35 Добавление pre-commit

.github/workflows/main.yml

@@ -23,10 +23,10 @@ jobs:
         uses: py-actions/flake8@v2
         with:
           path: "app"
-          args: "--config pyproject.toml"
+          args: "--config setup.cfg"
       - uses: isort/isort-action@master
         with:
-          configuration: .pyproject.toml
+          configuration: .setup.cfg
       - name: Install dependencies
         run: |
           pip install --upgrade pip
@@ -40,4 +40,3 @@ jobs:
           EMAIL_HOST_PASSWORD: ${{ secrets.EMAIL_HOST_PASSWORD }}
         run: |
           pytest
-

.gitignore

@@ -141,4 +141,4 @@ dmypy.json
 .idea
 
 # fastapi stuff
-fastapi.db
+fastapi.db

.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.6.0
+      hooks:
+        - id: check-yaml
+        - id: end-of-file-fixer
+          exclude: app/requirements.txt
+        - id: trailing-whitespace
+        - id: check-merge-conflict
+        - id: double-quote-string-fixer
+
+    - repo: https://github.com/pycqa/isort
+      rev: 5.13.2
+      hooks:
+      - id: isort
+      args: [ --profile=flake8, --line-length=79 ]
+
+    - repo: https://github.com/pycqa/flake8
+      rev: 7.0.0
+      hooks:
+        - id: flake8
+          additional_dependencies:
+            - pep8-naming
+            - flake8-broken-line
+            - flake8-isort
+            - flake8-bugbear
+
+    - repo: local
+      hooks:
+        - id: pytest
+          name: Check pytest
+          entry: pytest tests/
+          language: system
+          pass_filenames: false
+          always_run: true
+          types: [python]

README.md

@@ -55,7 +55,20 @@ uvicorn app.main:app --host 127.0.0.1 --port 8000
 
 Документация будет доступна по http://127.0.0.1/docs/
 
-## Разработчики 
+## Полезные материалы
+
+<details>
+  <summary><h3>Команды pre-commit</h3></summary>
+
+- Установить pre-commit в проекте: `pre-commit install`
+- Запустить проверку всех хуков: `pre-commit run -a`
+- Запустить конкретный хук: `pre-commit run <имя-хука>`
+- Деактивировать автоматическое выполнение хуков перед коммитом: `pre-commit uninstall`
+- Обновить pre-commit хуки: `pre-commit autoupdate`
+
+</details>
+
+## Разработчики
 
 -----
 
@@ -79,5 +92,3 @@ uvicorn app.main:app --host 127.0.0.1 --port 8000
 
  - [Глеб Кондратьев](https://github.com/gleb60)
 ----
-
-

alembic/README.md

@@ -31,4 +31,4 @@ alembic downgrade base
 
 ```
 alembic history
-```
+```

alembic/env.py

@@ -2,11 +2,11 @@
 import os
 from logging.config import fileConfig
 
-from alembic import context
 from dotenv import load_dotenv
 from sqlalchemy import pool
 from sqlalchemy.ext.asyncio import async_engine_from_config
 
+from alembic import context
 from app.core.base import Base
 
 config = context.config
@@ -34,12 +34,12 @@ def run_migrations_offline() -> None:
     script output.
 
     """
-    url = config.get_main_option("sqlalchemy.url")
+    url = config.get_main_option('sqlalchemy.url')
     context.configure(
         url=url,
         target_metadata=target_metadata,
         literal_binds=True,
-        dialect_opts={"paramstyle": "named"},
+        dialect_opts={'paramstyle': 'named'},
     )
 
     with context.begin_transaction():
@@ -65,7 +65,7 @@ async def run_async_migrations() -> None:
 
     connectable = async_engine_from_config(
         config.get_section(config.config_ini_section, {}),
-        prefix="sqlalchemy.",
+        prefix='sqlalchemy.',
         poolclass=pool.NullPool,
     )
 

alembic/versions/4098f76764d4_initial_migration.py

@@ -1,7 +1,7 @@
 """Initial migration
 
 Revision ID: 4098f76764d4
-Revises: 
+Revises:
 Create Date: 2023-12-07 23:54:47.680798
 
 """

app/admin/authentication.py

@@ -10,20 +10,20 @@
 
 class AdminAuth(AuthenticationBackend):
     async def login(
-            self,
-            request: Request,
-            session: AsyncSession = AsyncSessionLocal(),
-            strategy: JWTStrategy = get_jwt_strategy()
+        self,
+        request: Request,
+        session: AsyncSession = AsyncSessionLocal(),
+        strategy: JWTStrategy = get_jwt_strategy()
     ) -> bool:
         form = await request.form()
-        email, password = form["username"], form["password"]
+        email, password = form['username'], form['password']
         user = await user_crud.get_user_by_credentials(
             email, password, session
         )
         if not user:
             return False
         token = await strategy.write_token(user)
-        request.session.update({"token": token})
+        request.session.update({'token': token})
 
         return True
 
@@ -33,11 +33,11 @@ async def logout(self, request: Request) -> bool:
         return True
 
     async def authenticate(
-            self,
-            request: Request,
-            session: AsyncSession = AsyncSessionLocal()
+        self,
+        request: Request,
+        session: AsyncSession = AsyncSessionLocal()
     ) -> bool:
-        token = request.session.get("token")
+        token = request.session.get('token')
         if not token:
             return False
         return True

app/admin/tariff.py

@@ -9,7 +9,7 @@ class TariffAdmin(ModelView, model=Tariff):
     can_edit = True
     can_delete = False
     can_view_details = True
-    name = "Tariff"
-    name_plural = "Tariffs"
-    icon = "fa-solid fa-dollar-sign"
-    category = "tariff"
+    name = 'Tariff'
+    name_plural = 'Tariffs'
+    icon = 'fa-solid fa-dollar-sign'
+    category = 'tariff'

app/admin/user.py

@@ -9,10 +9,10 @@ class UserAdmin(ModelView, model=User):
     can_edit = True
     can_delete = False
     can_view_details = True
-    name = "User"
-    name_plural = "Users"
-    icon = "fa-solid fa-user"
-    category = "accounts"
+    name = 'User'
+    name_plural = 'Users'
+    icon = 'fa-solid fa-user'
+    category = 'accounts'
     column_searchable_list = [User.username]
     column_sortable_list = [User.id]
     column_formatters = {User.username: lambda m, a: m.username[:10]}

app/api/endpoints/achievement.py

@@ -7,21 +7,21 @@
     DELETE_ACHIEVEMENT_DESCRIPTION, GET_ACHIEVEMENT,
     GET_ACHIEVEMENT_CURRENTUSER_ID_DESCRIPTION, GET_ACHIEVEMENTS,
     GET_ACHIEVEMENTS_CURRENTUSER_DESCRIPTION, GET_ALL_ACHIEVEMENTS_DESCRIPTION,
-    GET_ME_ACHIEVEMENT, PATCH_ACHIEVEMENT_ID_DESCRIPTION
+    GET_ME_ACHIEVEMENT, PATCH_ACHIEVEMENT_ID_DESCRIPTION,
 )
 from app.api_docs_responses.utils_docs import (
-    REQUEST_NAME_AND_DESCRIPTION_VALUE
+    REQUEST_NAME_AND_DESCRIPTION_VALUE,
 )
 from app.core.db import get_async_session
 from app.core.user import current_superuser, current_user
 from app.crud import achievement_crud
 from app.models import Achievement, User
 from app.schemas.achievement import (
-    AchievementCreate, AchievementRead, AchievementUpdate
+    AchievementCreate, AchievementRead, AchievementUpdate,
 )
 from app.services.endpoints_services import delete_obj
 from app.services.utils import (
-    Pagination, add_response_headers, get_pagination_params, paginated
+    Pagination, add_response_headers, get_pagination_params, paginated,
 )
 
 router = APIRouter()
@@ -101,7 +101,7 @@ async def get_self_achievement_by_id(
 
 
 @router.post(
-    "/",
+    '/',
     response_model=AchievementRead,
     dependencies=[Depends(current_superuser)],
     status_code=status.HTTP_201_CREATED,
@@ -145,7 +145,7 @@ async def update_achievement(
 
 
 @router.delete(
-    "/{achievement_id}",
+    '/{achievement_id}',
     dependencies=[Depends(current_superuser)],
     status_code=status.HTTP_204_NO_CONTENT,
     responses=DELETE_ACHIEVEMENT,

app/api/endpoints/course.py

@@ -4,10 +4,10 @@
 from app.api.validators import check_name_duplicate, check_obj_exists
 from app.api_docs_responses.course import (
     CREATE_COURSE, DELETE_COURSE, GET_COURSE, GET_COURSES, GET_USER_COURSE,
-    GET_USER_COURSES, PATCH_COURSE
+    GET_USER_COURSES, PATCH_COURSE,
 )
 from app.api_docs_responses.utils_docs import (
-    REQUEST_NAME_AND_DESCRIPTION_VALUE
+    REQUEST_NAME_AND_DESCRIPTION_VALUE,
 )
 from app.core.db import get_async_session
 from app.core.user import current_superuser, current_user
@@ -16,14 +16,14 @@
 from app.schemas.course import CourseCreate, CourseRead, CourseUpdate
 from app.services.endpoints_services import delete_obj
 from app.services.utils import (
-    Pagination, add_response_headers, get_pagination_params, paginated
+    Pagination, add_response_headers, get_pagination_params, paginated,
 )
 
 router = APIRouter()
 
 
 @router.get(
-    "/",
+    '/',
     response_model=list[CourseRead],
     **GET_COURSES,
 )
@@ -39,7 +39,7 @@ async def get_all_courses(
 
 
 @router.get(
-    "/me",
+    '/me',
     response_model=list[CourseRead],
     dependencies=[Depends(current_user)],
     **GET_USER_COURSES,
@@ -59,7 +59,7 @@ async def get_all_user_courses(
 
 
 @router.get(
-    "/me/{course_id}",
+    '/me/{course_id}',
     response_model=CourseRead,
     dependencies=[Depends(current_user)],
     **GET_USER_COURSE,
@@ -100,7 +100,7 @@ async def get_course(
 
 
 @router.post(
-    "/",
+    '/',
     response_model=CourseRead,
     dependencies=[Depends(current_superuser)],
     status_code=status.HTTP_201_CREATED,
@@ -117,7 +117,7 @@ async def create_course(
 
 
 @router.patch(
-    "/{course_id}",
+    '/{course_id}',
     response_model=CourseRead,
     dependencies=[Depends(current_superuser)],
     **PATCH_COURSE,
@@ -142,7 +142,7 @@ async def update_course(
 
 
 @router.delete(
-    "/{course_id}",
+    '/{course_id}',
     dependencies=[Depends(current_superuser)],
     status_code=status.HTTP_204_NO_CONTENT,
     **DELETE_COURSE,

app/api/endpoints/examination.py

@@ -4,25 +4,25 @@
 from app.api.validators import check_name_duplicate, check_obj_exists
 from app.api_docs_responses.examination import (
     CREATE_EXAMINATION, DELETE_EXAMINATION, GET_EXAMINATION, GET_EXAMINATIONS,
-    GET_USER_EXAMINATIONS, UPDATE_EXAMINATION
+    GET_USER_EXAMINATIONS, UPDATE_EXAMINATION,
 )
 from app.api_docs_responses.utils_docs import (
-    REQUEST_NAME_AND_DESCRIPTION_VALUE
+    REQUEST_NAME_AND_DESCRIPTION_VALUE,
 )
 from app.core.db import get_async_session
 from app.core.user import current_superuser, current_user
 from app.crud import examination_crud
 from app.models import User
 from app.schemas.examination import (
-    ExaminationCreate, ExaminationRead, ExaminationUpdate
+    ExaminationCreate, ExaminationRead, ExaminationUpdate,
 )
 from app.services.endpoints_services import delete_obj
 
 router = APIRouter()
 
 
 @router.get(
-    "/",
+    '/',
     response_model=list[ExaminationRead],
     **GET_EXAMINATIONS,
 )
@@ -62,7 +62,7 @@ async def get_examination(
 
 
 @router.post(
-    "/",
+    '/',
     response_model=ExaminationRead,
     dependencies=[Depends(current_superuser)],
     status_code=status.HTTP_201_CREATED,
@@ -100,7 +100,7 @@ async def update_examination(
 
 
 @router.delete(
-    "/{examination_id}",
+    '/{examination_id}',
     dependencies=[Depends(current_superuser)],
     status_code=status.HTTP_204_NO_CONTENT,
     **DELETE_EXAMINATION