added ruff

Author: mostafa6765

.coveragerc

@@ -0,0 +1,9 @@
+[run]
+omit =
+    */tests/*
+    */__init__.py
+    */migrations/*
+    */config/* 
+    */middleware/*
+    */celery.py
+    */tasks/*

.gitignore

@@ -31,6 +31,8 @@ ENV/
 .pytest_cache/
 .coverage
 htmlcov/
+coverage.xml
+
 
 # IDE specific files
 .idea/
@@ -65,3 +67,6 @@ docker-compose.override.yml
 docs/_build/
 
 app/tests/
+
+fastapi-pundra/
+fastapi-pundra1/

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.9.6
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format 

Pipfile

@@ -26,6 +26,7 @@ pytest-cov = "*"
 factory-boy = "*"
 httpx = "*"
 ruff = "*"
+pre-commit = "*"
 
 [requires]
 python_version = "3.12"

Pipfile.lock

@@ -105,4 +105,23 @@ alembic upgrade head
 
 ## postman collection documentation
 
-* [postman collection documentation](https://documenter.getpostman.com/view/9920489/2sAYQZGBNJ)
+* [postman collection documentation](https://documenter.getpostman.com/view/9920489/2sAYQZGBNJ)
+
+## Linting and formatting
+
+### with script
+
+```bash
+./scripts/lint.sh
+./scripts/format.sh
+```
+
+
+### with pre-commit
+
+```bash
+pre-commit install
+```
+
+> [!NOTE]  
+> pre-commit will run automatically when you commit your changes.

README.md

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from fastapi import APIRouter, BackgroundTasks, Request, status
+from fastapi import APIRouter, Request, status
 from fastapi.encoders import jsonable_encoder
 from fastapi.responses import JSONResponse
 from fastapi_pundra.rest.helpers import the_query
@@ -19,13 +19,13 @@
 # Registration route
 @router.post("/users/registration")
 @dto(UserCreateSchema)
-async def registration(request: Request, background_tasks: BackgroundTasks) -> JSONResponse:
+async def registration(request: Request) -> JSONResponse:
     """Register a new user."""
     # Retrieve data from the request
     request_data = await the_query(request)
     data = UserCreateSchema(**request_data)
 
-    output = await user_service.s_registration(request, data, background_tasks)
+    output = await user_service.s_registration(request, data)
     return JSONResponse(content=output, status_code=status.HTTP_201_CREATED)
 
 

app/api/v1/user.py

@@ -1,6 +1,5 @@
-from fastapi import BackgroundTasks, Request
+from fastapi import Request
 from fastapi_pundra.common.jwt_utils import create_access_token, create_refresh_token
-from fastapi_pundra.common.mailer.mail import send_mail_background
 from fastapi_pundra.common.password import compare_hashed_password, generate_password_hash
 from fastapi_pundra.rest.exceptions import (
     BaseAPIException,
@@ -9,6 +8,7 @@
 )
 from fastapi_pundra.rest.helpers import the_query, the_sorting
 from fastapi_pundra.rest.paginate import paginate
+from sqlalchemy.orm import Session
 
 from app.database import get_db
 from app.models.users import User
@@ -19,16 +19,11 @@
 class UserService:
     """User service."""
 
-    def __init__(self) -> None:
+    def __init__(self, db: Session | None = None) -> None:
         """Initialize the user service."""
-        self.db = get_db()
-
-    async def s_registration(
-        self,
-        request: Request,
-        data: UserCreateSchema,
-        background_tasks: BackgroundTasks,
-    ) -> dict:
+        self.db = db or get_db()
+
+    async def s_registration(self, request: Request, data: UserCreateSchema) -> dict:
         """Register a new user."""
         db_user = self.db.query(User).filter(User.email == data.email).first()
 
@@ -48,19 +43,19 @@ async def s_registration(
         user_data = UserSerializer(**new_user.as_dict())
 
         # Send welcome email in background
-        template_name = "welcome_email.html"
-        context = {
-            "name": new_user.name or new_user.email,
-            "activation_link": f"{request.base_url}api/v1/users/activate",
-        }
-
-        await send_mail_background(
-            background_tasks=background_tasks,
-            subject=f"Welcome, {new_user.name or new_user.email}!",
-            to=[new_user.email],
-            template_name=template_name,
-            context=context,
-        )
+        # template_name = "welcome_email.html"
+        # context = {
+        #     "name": new_user.name or new_user.email,
+        #     "activation_link": f"{request.base_url}api/v1/users/activate",
+        # }
+
+        # await send_mail_background(
+        #     background_tasks=background_tasks,
+        #     subject=f"Welcome, {new_user.name or new_user.email}!",
+        #     to=[new_user.email],
+        #     template_name=template_name,
+        #     context=context,
+        # )
 
         return {"message": "Registration successful", "user": user_data.model_dump()}
 

app/services/user_service.py

@@ -52,6 +52,7 @@ ignore = [
     "FIX002",  # Line contains TODO, consider resolving the issue
     "COM812",  # Missing trailing comma in Python 3.6+
     "N805",    # Instance method first argument name should be 'self'
+    "ERA001",
 ]
 
 # Allow unused variables when underscore-prefixed

ruff.toml

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+set -x
+
+
+# Run pytest with coverage
+pytest \
+    --cov=app \
+    --cov-report=term-missing \
+    --cov-report=html \
+    --cov-report=xml \
+    --cov-fail-under=80 \
+    --cov-config=.coveragerc \
+    -v \
+    app/tests/ \
+    "${@}"