Merge pull request #180 from grillazz/179-reflect-latest-and-greatest…

…-fastapi-improvements

179 reflect latest and greatest fastapi improvements

app/main.py

@@ -51,7 +51,7 @@ async def lifespan(_app: FastAPI):
         await _app.postgres_pool.close()
 
 
-app = FastAPI(title="Stuff And Nonsense API", version="0.15", lifespan=lifespan)
+app = FastAPI(title="Stuff And Nonsense API", version="0.16", lifespan=lifespan)
 
 app.include_router(stuff_router)
 app.include_router(nonsense_router)

app/models/stuff.py

@@ -1,29 +1,13 @@
 import uuid
 
-from sqlalchemy.dialects import postgresql
 from sqlalchemy import String, select, ForeignKey
 from sqlalchemy.dialects.postgresql import UUID
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.orm import mapped_column, Mapped, relationship, joinedload
 
 from app.models.base import Base
 from app.models.nonsense import Nonsense
-
-from functools import wraps
-
-
-def compile_sql_or_scalar(func):
-    @wraps(func)
-    async def wrapper(cls, db_session, name, compile_sql=False, *args, **kwargs):
-        stmt = await func(cls, db_session, name, *args, **kwargs)
-        if compile_sql:
-            return stmt.compile(
-                dialect=postgresql.dialect(), compile_kwargs={"literal_binds": True}
-            )
-        result = await db_session.execute(stmt)
-        return result.scalars().first()
-
-    return wrapper
+from app.utils.decorators import compile_sql_or_scalar
 
 
 class Stuff(Base):

app/utils/decorators.py

@@ -0,0 +1,41 @@
+from sqlalchemy.dialects import postgresql
+
+from functools import wraps
+
+
+def compile_sql_or_scalar(func):
+    """
+    A decorator that compiles an SQL statement or executes it and returns the first scalar result.
+
+    Args:
+        func (Callable): The function to be decorated. It should return an SQLAlchemy statement.
+
+    Returns:
+        Callable: A wrapper function that either compiles the SQL statement or executes it and returns the first scalar result.
+    """
+
+    @wraps(func)
+    async def wrapper(cls, db_session, name, compile_sql=False, *args, **kwargs):
+        """
+        Wrapper function that either compiles the SQL statement or executes it.
+
+        Args:
+            cls (Type): The class on which the method is called.
+            db_session (AsyncSession): The SQLAlchemy async session.
+            name (str): The name to be used in the SQL statement.
+            compile_sql (bool, optional): If True, compiles the SQL statement. Defaults to False.
+            *args: Additional positional arguments.
+            **kwargs: Additional keyword arguments.
+
+        Returns:
+            Compiled SQL statement or the first scalar result of the executed statement.
+        """
+        stmt = await func(cls, db_session, name, *args, **kwargs)
+        if compile_sql:
+            return stmt.compile(
+                dialect=postgresql.dialect(), compile_kwargs={"literal_binds": True}
+            )
+        result = await db_session.execute(stmt)
+        return result.scalars().first()
+
+    return wrapper