✨ Add (module): Additional features for API

Author: jpcadena

.env.sample.env

@@ -0,0 +1,20 @@
+SERVER_HOST="http://localhost"
+BACKEND_CORS_ORIGINS=["http://localhost:5000","http://localhost:3000","http://localhost:8080"]
+SERVER_PORT=80
+SERVER_RELOAD=True
+SERVER_LOG_LEVEL="info"
+SERVER_DESCRIPTION="Development environment"
+SERVER_URL="http://localhost"
+
+# Postgres
+POSTGRES_SCHEME="postgresql+psycopg"
+POSTGRES_SERVER="localhost"
+POSTGRES_USER="postgres"
+POSTGRES_PASSWORD="Password1.-"
+POSTGRES_DB="postgres"
+POSTGRES_PORT=5432
+
+# OpenAPI Metadata
+CONTACT_NAME="Juan Pablo Cadena Aguilar"
+CONTACT_URL="https://www.github.com/jpcadena"
+CONTACT_EMAIL="[email protected]"

.pre-commit-config.yaml

@@ -29,7 +29,7 @@ repos:
           - --keep-runtime-typing
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.3
+    rev: v0.4.6
     hooks:
       # Run the linter.
       - id: ruff
@@ -51,7 +51,7 @@ repos:
         args: [ "--config", "pyproject.toml" ]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.3
+    rev: v0.4.6
     hooks:
       # Run the formatter.
       - id: ruff-format

app/api/api_v1/router/user.py

@@ -11,12 +11,12 @@
 from fastapi.params import Path, Query
 from pydantic import NonNegativeInt, PositiveInt
 
-from app.config.exceptions import (
+from app.config.init_settings import init_setting
+from app.core.exceptions import (
     DatabaseException,
     NotFoundException,
     ServiceException,
 )
-from app.config.init_settings import init_setting
 from app.crud.user import UserRepository, get_user_repository
 from app.schemas.user import User, UserCreate, UserUpdate, UsersResponse
 

app/config/settings.py

@@ -35,7 +35,9 @@ class Settings(BaseSettings):
     SERVER_PORT: PositiveInt
     SERVER_RELOAD: bool
     SERVER_LOG_LEVEL: str
+    SERVER_DESCRIPTION: str
     BACKEND_CORS_ORIGINS: list[AnyHttpUrl] = []
+    SERVER_URL: AnyHttpUrl
 
     @field_validator("BACKEND_CORS_ORIGINS", mode="before")
     def assemble_cors_origins(cls, v: str | list[str]) -> list[str] | str:
@@ -47,7 +49,6 @@ def assemble_cors_origins(cls, v: str | list[str]) -> list[str] | str:
         :return: List of Backend CORS origins to be accepted
         :rtype: Union[list[str], str]
         """
-        # pylint: disable=unused-argument,no-self-argument,invalid-name
         if isinstance(v, str) and not v.startswith("["):
             return [i.strip() for i in v.split(",")]
         if isinstance(v, list):

app/core/__init__.py

@@ -0,0 +1,3 @@
+"""
+Package app-core initialization.
+"""

app/config/exceptions.py renamed to app/core/exceptions.py

@@ -0,0 +1,38 @@
+"""
+A module for lifecycle in the app-core package.
+"""
+
+import logging
+from contextlib import asynccontextmanager
+from typing import Any, AsyncGenerator
+
+from fastapi import FastAPI
+
+from app.config.init_settings import get_init_settings
+from app.config.settings import get_settings
+from app.crud.user import get_user_repository
+
+logger: logging.Logger = logging.getLogger(__name__)
+
+
+@asynccontextmanager
+async def lifespan(application: FastAPI) -> AsyncGenerator[Any, None]:
+    """
+    The lifespan of the application
+    :param application: The FastAPI application
+    :type application: FastAPI
+    :return: An asynchronous generator for the application
+    :rtype: AsyncGenerator[Any, None]
+    """
+    logger.info("Starting API...")
+    try:
+        application.state.settings = get_settings()
+        application.state.init_settings = get_init_settings()
+        application.state.user_repository = get_user_repository()
+        logger.info("Configuration settings loaded.")
+        yield
+    except Exception as exc:
+        logger.error(f"Error during application startup: {exc}")
+        raise
+    finally:
+        logger.info("Application shutdown completed.")

app/core/lifecycle.py

@@ -11,8 +11,8 @@
 from fastapi.routing import APIRoute
 from pydantic_extra_types.phone_numbers import PhoneNumber
 
-from app.config.exceptions import ServiceException
 from app.config.settings import setting
+from app.core.exceptions import ServiceException
 
 
 def remove_tag_from_operation_id(tag: str, operation_id: str) -> str:
@@ -103,8 +103,8 @@ def custom_openapi(app: FastAPI) -> dict[str, Any]:
         routes=app.routes,
         servers=[
             {
-                "url": app.state.auth_settings.SERVER_URL,
-                "description": app.state.auth_settings.SERVER_DESCRIPTION,
+                "url": app.state.settings.SERVER_URL,
+                "description": app.state.settings.SERVER_DESCRIPTION,
             }
         ],
         contact=app.state.settings.CONTACT,

app/config/utils.py renamed to app/core/utils.py

@@ -14,7 +14,7 @@
 from sqlalchemy.orm import Session
 from sqlalchemy.sql import Select
 
-from app.config.exceptions import DatabaseException
+from app.core.exceptions import DatabaseException
 from app.db.session import get_session
 from app.models.user import User
 from app.schemas.user import User as UserSchema

app/crud/user.py

@@ -14,12 +14,14 @@
 from app.api.api_v1.api import api_router
 from app.config.init_settings import init_setting
 from app.config.settings import setting
-from app.config.utils import custom_generate_unique_id, custom_openapi
+from app.core.lifecycle import lifespan
+from app.core.utils import custom_generate_unique_id, custom_openapi
 
 app: FastAPI = FastAPI(
     debug=True,
     openapi_url=f"{setting.API_V1_STR}{init_setting.OPENAPI_FILE_PATH}",
     openapi_tags=init_setting.TAGS_METADATA,
+    lifespan=lifespan,
     generate_unique_id_function=custom_generate_unique_id,
 )
 app.openapi = partial(custom_openapi, app)  # type: ignore