Merge pull request #1 from mts-ai/added_sqlalchemy

Added SQLAlchemy

Author: Znbiz

.gitignore

@@ -6,3 +6,4 @@
 /db.sqlite3-shm
 /db.sqlite3-wal
 /.idea
+/examples/api_for_sqlalchemy/db.sqlite3

examples/api_for_sqlalchemy/README.md

@@ -0,0 +1,10 @@
+## App API-FOR-TORTOISE-ORM
+
+### Start app
+```shell
+# in dir fastapi-rest-jsonapi
+
+export PYTHOPATH="${PYTHONPATH}:./" 
+python examples/api_for_tortoise_orm/main.py
+```
+http://0.0.0.0:8080/docs

examples/api_for_sqlalchemy/__init__.py

@@ -0,0 +1,7 @@
+"""service API package."""
+
+from .user import UserFactory
+
+__all__ = [
+    "UserFactory",
+]

examples/api_for_sqlalchemy/api/__init__.py

@@ -0,0 +1,103 @@
+from http import HTTPStatus
+from typing import (
+    List,
+    Union,
+)
+
+from fastapi import Depends
+from sqlalchemy import select, desc
+from sqlalchemy.ext.asyncio import AsyncSession
+from tortoise.exceptions import DoesNotExist
+from tortoise.queryset import QuerySet
+
+from examples.api_for_sqlalchemy.extensions.sqlalchemy import Connector
+from examples.api_for_sqlalchemy.helpers.factories.meta_base import FactoryUseMode
+from examples.api_for_sqlalchemy.helpers.factories.user import UserFactory, ErrorCreateUserObject
+from examples.api_for_sqlalchemy.helpers.updaters.exceptions import ObjectNotFound
+from examples.api_for_sqlalchemy.helpers.updaters.update_user import UpdateUser, ErrorUpdateUserObject
+from examples.api_for_sqlalchemy.models.pydantic import UserSchema, UserPatchSchema
+from examples.api_for_sqlalchemy.models.pydantic.user import UserInSchema
+from examples.api_for_sqlalchemy.models.sqlalchemy import User
+from fastapi_rest_jsonapi import SqlalchemyEngine
+
+from fastapi_rest_jsonapi.exceptions import (
+    BadRequest,
+    HTTPException,
+)
+from fastapi_rest_jsonapi.querystring import QueryStringManager
+from fastapi_rest_jsonapi.schema import JSONAPIResultListSchema
+
+
+class UserDetail:
+    @classmethod
+    async def get_user(cls, user_id, query_params: QueryStringManager, session: AsyncSession) -> User:
+        """
+        Get user by id from ORM.
+
+        :param user_id: int
+        :param query_params: QueryStringManager
+        :return: User model.
+        :raises HTTPException: if user not found.
+        """
+        user: User
+        try:
+            user = (await session.execute(select(User).where(User.id == user_id))).scalar_one()
+        except DoesNotExist:
+            raise HTTPException(
+                status_code=HTTPStatus.FORBIDDEN,
+                detail="User with id {id} not found".format(id=user_id),
+            )
+
+        return user
+
+    @classmethod
+    async def get(cls, obj_id, query_params: QueryStringManager, session: AsyncSession = Depends(Connector.get_session)) -> UserSchema:
+        user: User = await cls.get_user(user_id=obj_id, query_params=query_params, session=session)
+        return UserSchema.from_orm(user)
+
+    @classmethod
+    async def patch(cls, obj_id, data: UserPatchSchema, query_params: QueryStringManager, session: AsyncSession = Depends(Connector.get_session)) -> UserSchema:
+        user_obj: User
+        try:
+            user_obj = await UpdateUser.update(
+                obj_id,
+                data.dict(exclude_unset=True),
+                query_params.headers,
+                session=session,
+            )
+        except ErrorUpdateUserObject as ex:
+            raise BadRequest(ex.description, ex.field)
+        except ObjectNotFound as ex:
+            raise HTTPException(status_code=HTTPStatus.NOT_FOUND, detail=ex.description)
+
+        user = UserSchema.from_orm(user_obj)
+        return user
+
+
+class UserList:
+    @classmethod
+    async def get(cls, query_params: QueryStringManager, session: AsyncSession = Depends(Connector.get_session)) -> Union[QuerySet, JSONAPIResultListSchema]:
+        user_query = select(User).order_by(desc(User.id))
+        dl = SqlalchemyEngine(query=user_query, schema=UserSchema, model=User, session=session)
+        count, users_db = await dl.get_collection(qs=query_params)
+        total_pages = count // query_params.pagination.size + (count % query_params.pagination.size and 1)
+        users: List[UserSchema] = [UserSchema.from_orm(i_user) for i_user in users_db]
+        return JSONAPIResultListSchema(
+            meta={"count": count, "totalPages": total_pages},
+            data=[{"id": i_obj.id, "attributes": i_obj.dict(), "type": "user"} for i_obj in users],
+        )
+
+    @classmethod
+    async def post(cls, data: UserInSchema, query_params: QueryStringManager, session: AsyncSession = Depends(Connector.get_session)) -> UserSchema:
+        try:
+            user_obj = await UserFactory.create(
+                data=data.dict(),
+                mode=FactoryUseMode.production,
+                header=query_params.headers,
+                session=session,
+            )
+        except ErrorCreateUserObject as ex:
+            raise BadRequest(ex.description, ex.field)
+
+        user = UserSchema.from_orm(user_obj)
+        return user

examples/api_for_sqlalchemy/api/user.py

@@ -0,0 +1,5 @@
+"""Factory call module."""
+
+from examples.api_for_sqlalchemy.main import create_app
+
+app = create_app()

examples/api_for_sqlalchemy/asgi.py

@@ -0,0 +1,31 @@
+from typing import Optional
+
+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
+
+
+Base = declarative_base()
+
+
+def async_session() -> sessionmaker:
+    uri = "sqlite+aiosqlite:///db.sqlite3"
+    engine = create_async_engine(url=make_url(uri))
+    _async_session = sessionmaker(bind=engine, class_=AsyncSession, expire_on_commit=False)
+    return _async_session
+
+
+class Connector:
+
+    @classmethod
+    async def get_session(cls):
+        """
+        Получение сессии к БД.
+
+        :return:
+        """
+        async_session_ = async_session()
+        async with async_session_() as db_session:
+            async with db_session.begin():
+                yield db_session

examples/api_for_sqlalchemy/extensions/__init__.py

@@ -0,0 +1 @@
+"""Helpers for service package. Contains factories and updaters packages."""

examples/api_for_sqlalchemy/extensions/sqlalchemy.py

@@ -0,0 +1,5 @@
+"""
+factories package.
+
+Contains factories for creating user models.
+"""