loguru added && offline docs support

Author: ilkersigirci

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
         args: ["--fix=lf"]
         description: Forces to replace line ending by the UNIX 'lf' character.
       - id: check-added-large-files
-        args: ["--maxkb=1000"]
+        args: ["--maxkb=2000"]
 
   - repo: https://github.com/astral-sh/uv-pre-commit
     rev: 0.6.2

app/api/v1/api.py

@@ -1,9 +1,10 @@
 from fastapi import APIRouter, Depends
 
-from app.api.v1.endpoints import auth, items, users
+from app.api.v1.endpoints import auth, docs, items, users
 from app.dependencies.auth import get_current_user
 
 api_router = APIRouter()
+api_router.include_router(docs.router)
 api_router.include_router(auth.router, prefix="/auth", tags=["auth"])
 api_router.include_router(
     users.router,

app/api/v1/endpoints/docs.py

@@ -0,0 +1,59 @@
+from fastapi import APIRouter, FastAPI, Request
+from fastapi.openapi.docs import (
+    get_redoc_html,
+    get_swagger_ui_html,
+    get_swagger_ui_oauth2_redirect_html,
+)
+from fastapi.responses import HTMLResponse
+
+router = APIRouter()
+
+
+@router.get("/docs", include_in_schema=False)
+async def swagger_ui_html(request: Request) -> HTMLResponse:
+    """Swagger UI.
+
+    Args:
+        request: Current Request.
+
+    Returns:
+        Rendered Swagger UI.
+    """
+    app: FastAPI = request.app
+
+    return get_swagger_ui_html(
+        openapi_url=app.openapi_url,
+        title=f"{app.title} - Swagger UI",
+        oauth2_redirect_url=str(request.url_for("swagger_ui_redirect")),
+        swagger_js_url="/static/docs/swagger-ui-bundle.js",
+        swagger_css_url="/static/docs/swagger-ui.css",
+    )
+
+
+@router.get("/swagger-redirect", include_in_schema=False)
+async def swagger_ui_redirect() -> HTMLResponse:
+    """Redirect to swagger.
+
+    Returns:
+        Redirect.
+    """
+    return get_swagger_ui_oauth2_redirect_html()
+
+
+@router.get("/redoc", include_in_schema=False)
+async def redoc_html(request: Request) -> HTMLResponse:
+    """Redoc UI.
+
+    Args:
+        request: Current Request.
+
+    Returns:
+        Rendered Redoc UI.
+    """
+    app: FastAPI = request.app
+
+    return get_redoc_html(
+        openapi_url=app.openapi_url,
+        title=f"{app.title} - ReDoc",
+        redoc_js_url="/static/docs/redoc.standalone.js",
+    )

app/api/v1/endpoints/items.py

@@ -2,6 +2,7 @@
 
 from fastapi import APIRouter, Depends, Query
 
+# from pydantic import Field
 from app.dependencies.repositories import get_item_service
 from app.models.item import Item, ItemCreate, ItemUpdate
 from app.services.item_service import ItemService
@@ -13,6 +14,7 @@
 async def get_items(  # noqa: PLR0913
     item_service: Annotated[ItemService, Depends(get_item_service)],
     skip: int = Query(0, ge=0, description="Number of items to skip"),
+    # skip: int = Field(0, ge=0, description="Number of items to skip"), # FIXME: Not working
     limit: int = Query(100, ge=1, le=100, description="Number of items to return"),
     name: Optional[str] = Query(None, description="Filter items by name"),
     description: Optional[str] = Query(None, description="Filter items by description"),
@@ -27,6 +29,7 @@ async def get_items(  # noqa: PLR0913
         sort_by=sort_by,
         order=order,
     )
+    # return {"message": "Get all items"}
 
 
 @router.get("/{item_id}")

app/core/config.py

@@ -1,3 +1,4 @@
+from enum import StrEnum
 from typing import Annotated
 
 from pydantic import (
@@ -17,24 +18,33 @@
 ]
 
 
-class Settings(BaseSettings):
-    API_V1_STR: str = "/api/v1"
-    PROJECT_NAME: str = "FastAPI Template"
+class LogLevel(StrEnum):
+    """Possible log levels."""
 
-    ENVIRONMENT: str = "dev"
+    NOTSET = "NOTSET"
+    DEBUG = "DEBUG"
+    INFO = "INFO"
+    WARNING = "WARNING"
+    ERROR = "ERROR"
+    FATAL = "FATAL"
 
-    # CORS configuration
-    CORS_ORIGINS: list[CustomHttpUrlStr] = []
 
-    # JWT configuration
-    SECRET_KEY: str = "CHANGE_ME_IN_PRODUCTION"
-    ALGORITHM: str = "HS256"
+class Settings(BaseSettings):
     ACCESS_TOKEN_EXPIRE_MINUTES: int = 30
-
-    # OpenTelemetry settings
+    ALGORITHM: str = "HS256"
+    API_V1_STR: str = "/api/v1"
+    CORS_ORIGINS: list[CustomHttpUrlStr] = []
+    ENVIRONMENT: str = "dev"
+    HOST: str = "127.0.0.1"
+    LOG_LEVEL: LogLevel = LogLevel.INFO
+    OTLP_ENDPOINT: CustomHttpUrlStr = ""
+    PORT: int = 8000
+    PROJECT_NAME: str = "FastAPI Template"
+    RELOAD: bool = False
+    SECRET_KEY: str = "CHANGE_ME_IN_PRODUCTION"
     TELEMETRY_ENABLED: bool = False
     TELEMETRY_LOGGING_ENABLED: bool = False
-    OTLP_ENDPOINT: CustomHttpUrlStr = ""
+    WORKERS: int = 1
 
     class Config:
         case_sensitive = True

app/log.py

@@ -0,0 +1,99 @@
+import logging
+import sys
+from typing import Any, Union
+
+from loguru import logger
+from opentelemetry.trace import INVALID_SPAN, INVALID_SPAN_CONTEXT, get_current_span
+
+from app.core.config import settings
+
+
+class InterceptHandler(logging.Handler):
+    """
+    Default handler from examples in loguru documentation.
+
+    This handler intercepts all log requests and
+    passes them to loguru.
+
+    For more info see:
+    https://loguru.readthedocs.io/en/stable/overview.html#entirely-compatible-with-standard-logging
+    """
+
+    def emit(self, record: logging.LogRecord) -> None:  # pragma: no cover
+        """
+        Propagates logs to loguru.
+
+        :param record: record to log.
+        """
+        try:
+            level: Union[str, int] = logger.level(record.levelname).name
+        except ValueError:
+            level = record.levelno
+
+        # Find caller from where originated the logged message
+        frame, depth = logging.currentframe(), 2
+        while frame.f_code.co_filename == logging.__file__:
+            frame = frame.f_back  # type: ignore
+            depth += 1
+
+        logger.opt(depth=depth, exception=record.exc_info).log(
+            level,
+            record.getMessage(),
+        )
+
+
+def record_formatter(record: dict[str, Any]) -> str:  # pragma: no cover
+    """
+    Formats the record.
+
+    This function formats message
+    by adding extra trace information to the record.
+
+    :param record: record information.
+    :return: format string.
+    """
+    log_format = (
+        "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> "
+        "| <level>{level: <8}</level> "
+        "| <magenta>trace_id={extra[trace_id]}</magenta> "
+        "| <blue>span_id={extra[span_id]}</blue> "
+        "| <cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> "
+        "- <level>{message}</level>\n"
+    )
+
+    span = get_current_span()
+    record["extra"]["span_id"] = 0
+    record["extra"]["trace_id"] = 0
+    if span != INVALID_SPAN:
+        span_context = span.get_span_context()
+        if span_context != INVALID_SPAN_CONTEXT:
+            record["extra"]["span_id"] = format(span_context.span_id, "016x")
+            record["extra"]["trace_id"] = format(span_context.trace_id, "032x")
+
+    if record["exception"]:
+        log_format = f"{log_format}{{exception}}"
+
+    return log_format
+
+
+def configure_logging() -> None:  # pragma: no cover
+    """Configures logging."""
+    intercept_handler = InterceptHandler()
+
+    logging.basicConfig(handlers=[intercept_handler], level=logging.NOTSET)
+
+    for logger_name in logging.root.manager.loggerDict:
+        if logger_name.startswith("uvicorn."):
+            logging.getLogger(logger_name).handlers = []
+
+    # change handler for default uvicorn logger
+    logging.getLogger("uvicorn").handlers = [intercept_handler]
+    logging.getLogger("uvicorn.access").handlers = [intercept_handler]
+
+    # set logs output, level and format
+    logger.remove()
+    logger.add(
+        sys.stdout,
+        level=settings.LOG_LEVEL.value,
+        format=record_formatter,  # type: ignore
+    )

app/main.py

@@ -1,14 +1,27 @@
+from pathlib import Path
+
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
+from fastapi.staticfiles import StaticFiles
 
 from app.api.v1.api import api_router
 from app.core.config import settings
 from app.lifespan import lifespan_setup
+from app.log import configure_logging
+
+APP_ROOT = Path(__file__).parent
+
+configure_logging()
 
 app = FastAPI(
     title=settings.PROJECT_NAME,
+    version="0.0.1",
+    docs_url=None,
+    redoc_url=None,
     openapi_url=f"{settings.API_V1_STR}/openapi.json",
     lifespan=lifespan_setup,
+    default_response_class=JSONResponse,
 )
 
 # Set up CORS
@@ -23,6 +36,9 @@
 # Include routers
 app.include_router(api_router, prefix=settings.API_V1_STR)
 
+# Adds static directory. This directory is used to access swagger files.
+app.mount("/static", StaticFiles(directory=APP_ROOT / "static"), name="static")
+
 
 @app.get("/")
 async def root():