updated client generated id example

Author: CosmoV

docs/client_generated_id.rst

@@ -22,7 +22,8 @@ Response:
 
 In order to do this you need to define an ``id`` with the Field keyword **client_can_set_id** in the
 ``schema`` or ``schema_in_post``.
-Schematically it looks like this:
+
+Example:
 
 .. literalinclude:: ./python_snippets/client_generated_id/schematic_example.py
   :language: python

docs/python_snippets/client_generated_id/schematic_example.py

@@ -1,22 +1,154 @@
-from fastapi import FastAPI
-from pydantic import BaseModel, Field
+import sys
+from pathlib import Path
+
+import uvicorn
+from fastapi import APIRouter, Depends, FastAPI
+from pydantic import Field, BaseModel as PydanticBaseModel
+from sqlalchemy import Column, Integer, Text
+from sqlalchemy.engine import make_url
+from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
 
 from fastapi_jsonapi import RoutersJSONAPI
+from fastapi_jsonapi.misc.sqla.generics.base import DetailViewBaseGeneric, ListViewBaseGeneric
+from fastapi_jsonapi.views.utils import HTTPMethod, HTTPMethodConfig
+from fastapi_jsonapi.views.view_base import ViewBase
+
+CURRENT_FILE = Path(__file__).resolve()
+CURRENT_DIR = CURRENT_FILE.parent
+PROJECT_DIR = CURRENT_DIR.parent.parent
+DB_URL = f"sqlite+aiosqlite:///{CURRENT_DIR.absolute()}/db.sqlite3"
+sys.path.append(str(PROJECT_DIR))
+
+Base = declarative_base()
+
 
+class User(Base):
+    __tablename__ = "users"
+    id = Column(Integer, primary_key=True, autoincrement=False)
+    name: str = Column(Text, nullable=True)
 
-class PersonAttributesSchema(BaseModel):
+
+class BaseModel(PydanticBaseModel):
+    class Config:
+        orm_mode = True
+
+
+class UserAttributesBaseSchema(BaseModel):
     name: str
 
 
-class PersonSchemaIn(BaseModel):
+class UserSchema(UserAttributesBaseSchema):
+    """User base schema."""
+
+
+class UserPatchSchema(UserAttributesBaseSchema):
+    """User PATCH schema."""
+
+
+class UserInSchema(UserAttributesBaseSchema):
+    """User input schema."""
+
     id: int = Field(client_can_set_id=True)
 
 
-app = FastAPI()
+async def get_session():
+    sess = sessionmaker(
+        bind=create_async_engine(url=make_url(DB_URL)),
+        class_=AsyncSession,
+        expire_on_commit=False,
+    )
+    async with sess() as db_session:  # type: AsyncSession
+        yield db_session
+        await db_session.rollback()
+
+
+async def sqlalchemy_init() -> None:
+    engine = create_async_engine(url=make_url(DB_URL))
+    async with engine.begin() as conn:
+        await conn.run_sync(Base.metadata.create_all)
+
+
+class SessionDependency(BaseModel):
+    session: AsyncSession = Depends(get_session)
+
+    class Config:
+        arbitrary_types_allowed = True
+
+
+def session_dependency_handler(view: ViewBase, dto: BaseModel) -> dict:
+    return {"session": dto.session}
+
+
+class UserDetailView(DetailViewBaseGeneric):
+    method_dependencies = {
+        HTTPMethod.ALL: HTTPMethodConfig(
+            dependencies=SessionDependency,
+            prepare_data_layer_kwargs=session_dependency_handler,
+        )
+    }
+
+
+class UserListView(ListViewBaseGeneric):
+    method_dependencies = {
+        HTTPMethod.ALL: HTTPMethodConfig(
+            dependencies=SessionDependency,
+            prepare_data_layer_kwargs=session_dependency_handler,
+        )
+    }
+
+
+def add_routes(app: FastAPI):
+    tags = [
+        {
+            "name": "User",
+            "description": "",
+        },
+    ]
+
+    routers: APIRouter = APIRouter()
+    RoutersJSONAPI(
+        router=routers,
+        path="/user",
+        tags=["User"],
+        class_detail=UserDetailView,
+        class_list=UserListView,
+        schema=UserSchema,
+        resource_type="user",
+        schema_in_patch=UserPatchSchema,
+        schema_in_post=UserInSchema,
+        model=User,
+    )
+
+    app.include_router(routers, prefix="")
+    return tags
+
+
+def create_app() -> FastAPI:
+    """
+    Create app factory.
+
+    :return: app
+    """
+    app = FastAPI(
+        title="FastAPI and SQLAlchemy",
+        debug=True,
+        openapi_url="/openapi.json",
+        docs_url="/docs",
+    )
+    add_routes(app)
+    app.on_event("startup")(sqlalchemy_init)
+    return app
+
+
+app = create_app()
 
-RoutersJSONAPI(
-    app,
-    # ...
-    schema_in_post=PersonSchemaIn,
-    # ...
-)
+if __name__ == "__main__":
+    uvicorn.run(
+        "test:app",
+        host="0.0.0.0",
+        port=8084,
+        reload=True,
+        app_dir=str(CURRENT_DIR),
+    )