async support v1

Author: rafsaf

{{cookiecutter.project_name}}/.env …cookiecutter.project_name}}/.env.example{{cookiecutter.project_name}}/.env renamed to {{cookiecutter.project_name}}/.env.example {{cookiecutter.project_name}}/.env renamed to {{cookiecutter.project_name}}/.env.example

@@ -12,6 +12,7 @@ __pycache__/
 
 # C extensions
 *.so
+.env
 
 # Distribution / packaging
 .Python

{{cookiecutter.project_name}}/.gitignore

@@ -2,6 +2,8 @@
 
 from sqlalchemy import engine_from_config
 from sqlalchemy import pool
+from sqlalchemy.ext.asyncio import AsyncEngine
+from asyncio import get_event_loop
 
 from app.core.config import settings
 from alembic import context
@@ -56,7 +58,14 @@ def run_migrations_offline():
         context.run_migrations()
 
 
-def run_migrations_online():
+def do_run_migrations(connection):
+    context.configure(connection=connection, target_metadata=target_metadata)
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+async def run_migrations_online():
     """Run migrations in 'online' mode.
 
     In this scenario we need to create an Engine
@@ -66,19 +75,19 @@ def run_migrations_online():
     configuration = config.get_section(config.config_ini_section)
     assert configuration
     configuration["sqlalchemy.url"] = get_database_uri()
-    connectable = engine_from_config(
-        configuration,
-        prefix="sqlalchemy.",
-        poolclass=pool.NullPool,
+    connectable = AsyncEngine(
+        engine_from_config(
+            configuration,
+            prefix="sqlalchemy.",
+            poolclass=pool.NullPool,
+            future=True,
+        )  # type: ignore
     )
-    with connectable.connect() as connection:
-        context.configure(connection=connection, target_metadata=target_metadata)
-
-        with context.begin_transaction():
-            context.run_migrations()
+    async with connectable.connect() as connection:
+        await connection.run_sync(do_run_migrations)
 
 
 if context.is_offline_mode():
     run_migrations_offline()
 else:
-    run_migrations_online()
+    get_event_loop().run_until_complete(run_migrations_online())

{{cookiecutter.project_name}}/alembic/env.py

@@ -0,0 +1,38 @@
+"""init
+
+Revision ID: 3c44f0828d4f
+Revises: 
+Create Date: 2021-10-23 12:14:50.440666
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '3c44f0828d4f'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('user',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('full_name', sa.String(length=254), nullable=True),
+    sa.Column('email', sa.String(length=254), nullable=False),
+    sa.Column('hashed_password', sa.String(length=128), nullable=False),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
+    op.create_index(op.f('ix_user_id'), 'user', ['id'], unique=False)
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f('ix_user_id'), table_name='user')
+    op.drop_index(op.f('ix_user_email'), table_name='user')
+    op.drop_table('user')
+    # ### end Alembic commands ###

{{cookiecutter.project_name}}/alembic/versions/20211023121450_3c44f0828d4f_init.py

@@ -1,34 +1,28 @@
-from typing import Generator, Optional
+from typing import AsyncGenerator, Optional
 
 from fastapi import Depends, HTTPException, status
 from fastapi.security import OAuth2PasswordBearer
 from jose import jwt
 from pydantic import ValidationError
 from sqlalchemy import select
-from sqlalchemy.orm import Session
+from sqlalchemy.ext.asyncio import AsyncSession
 
 from app import schemas
 from app.core import security
 from app.core.config import settings
 from app.models import User
-from app.session import SessionLocal
+from app.session import async_session
 
-reusable_oauth2 = OAuth2PasswordBearer(
-    tokenUrl=f"{settings.API_STR}/login/access-token"
-)
+reusable_oauth2 = OAuth2PasswordBearer(tokenUrl=f"{settings.API_STR}/auth/access-token")
 
 
-def get_session() -> Generator:
-    try:
-        session: Session = SessionLocal()
+async def get_session() -> AsyncGenerator[AsyncSession, None]:
+    async with async_session() as session:
         yield session
-    except:
-        raise Exception
-    session.close()
 
 
-def get_current_user(
-    session: Session = Depends(get_session), token: str = Depends(reusable_oauth2)
+async def get_current_user(
+    session: AsyncSession = Depends(get_session), token: str = Depends(reusable_oauth2)
 ) -> User:
 
     try:
@@ -41,16 +35,16 @@ def get_current_user(
             status_code=status.HTTP_403_FORBIDDEN,
             detail="Could not validate credentials",
         )
-    user: Optional[User] = (
-        session.execute(select(User).where(User.id == token_data.sub)).scalars().first()
-    )
+
+    result = await session.execute(select(User).where(User.id == token_data.sub))
+    user: Optional[User] = result.scalars().first()
 
     if not user:
         raise HTTPException(status_code=404, detail="User not found")
     return user
 
 
-def get_current_active_user(
+async def get_current_active_user(
     current_user: User = Depends(get_current_user),
 ) -> User:
     return current_user

{{cookiecutter.project_name}}/app/api/deps.py

@@ -5,7 +5,7 @@
 from jose import jwt
 from pydantic import ValidationError
 from sqlalchemy import select
-from sqlalchemy.orm import Session
+from sqlalchemy.ext.asyncio import AsyncSession
 
 from app import schemas
 from app.api import deps
@@ -17,20 +17,15 @@
 
 
 @router.post("/access-token", response_model=schemas.Token)
-def login_access_token(
-    session: Session = Depends(deps.get_session),
+async def login_access_token(
+    session: AsyncSession = Depends(deps.get_session),
     form_data: OAuth2PasswordRequestForm = Depends(),
 ):
     """
     OAuth2 compatible token, get an access token for future requests using username and password
     """
-
-    user: Optional[User] = (
-        session.execute(select(User).where(User.email == form_data.username))
-        .scalars()
-        .first()
-    )
-
+    result = await session.execute(select(User).where(User.email == form_data.username))
+    user: Optional[User] = result.scalars().first()
     if user is None:
         raise HTTPException(status_code=400, detail="Incorrect email or password")
 
@@ -49,15 +44,17 @@ def login_access_token(
 
 
 @router.post("/test-token", response_model=schemas.User)
-def test_token(current_user: User = Depends(deps.get_current_user)):
+async def test_token(current_user: User = Depends(deps.get_current_user)):
     """
     Test access token
     """
     return current_user
 
 
 @router.post("/refresh-token", response_model=schemas.Token)
-def refresh_token(refresh_token: str, session: Session = Depends(deps.get_session)):
+async def refresh_token(
+    refresh_token: str, session: AsyncSession = Depends(deps.get_session)
+):
     """
     OAuth2 compatible token, get an access token for future requests using refresh token
     """
@@ -76,13 +73,12 @@ def refresh_token(refresh_token: str, session: Session = Depends(deps.get_sessio
             status_code=status.HTTP_403_FORBIDDEN,
             detail="Could not validate credentials",
         )
-
-    user: Optional[User] = (
-        session.execute(select(User).where(User.id == token_data.sub)).scalars().first()
-    )
+    result = await session.execute(select(User).where(User.id == token_data.sub))
+    user: Optional[User] = result.scalars().first()
 
     if user is None:
         raise HTTPException(status_code=404, detail="User not found")
+
     access_token, expire_at = security.create_access_token(user.id)
     refresh_token, refresh_expire_at = security.create_refresh_token(user.id)
     return {

{{cookiecutter.project_name}}/app/api/endpoints/auth.py

@@ -1,7 +1,7 @@
 from typing import Any
 
 from fastapi import APIRouter, Depends
-from sqlalchemy.orm import Session
+from sqlalchemy.ext.asyncio import AsyncSession
 
 from app import models, schemas
 from app.api import deps
@@ -11,9 +11,9 @@
 
 
 @router.put("/me", response_model=schemas.User)
-def update_user_me(
+async def update_user_me(
     user_update: schemas.UserUpdate,
-    session: Session = Depends(deps.get_session),
+    session: AsyncSession = Depends(deps.get_session),
     current_user: models.User = Depends(deps.get_current_active_user),
 ) -> Any:
     """
@@ -27,15 +27,15 @@ def update_user_me(
         current_user.email = user_update.email
 
     session.add(current_user)
-    session.commit()
-    session.refresh(current_user)
+    await session.commit()
+    await session.refresh(current_user)
 
     return current_user
 
 
 @router.get("/me", response_model=schemas.User)
-def read_user_me(
-    session: Session = Depends(deps.get_session),
+async def read_user_me(
+    session: AsyncSession = Depends(deps.get_session),
     current_user: models.User = Depends(deps.get_current_active_user),
 ) -> Any:
     """

{{cookiecutter.project_name}}/app/api/endpoints/users.py

@@ -55,7 +55,7 @@ def _assemble_db_connection(cls, v: str, values: Dict[str, Optional[str]]) -> st
             postgres_server = values.get("POSTGRES_SERVER")
 
         return AnyUrl.build(
-            scheme="postgresql+psycopg2",
+            scheme="postgresql+asyncpg",
             user=values.get("POSTGRES_USER"),
             password=values.get("POSTGRES_PASSWORD"),
             host=postgres_server or "localhost",

{{cookiecutter.project_name}}/app/core/config.py

@@ -1,40 +1,40 @@
 import logging
+from typing import Optional
 
 from sqlalchemy import select
 
 from app.core import security
 from app.core.config import settings
 from app.models import User
-from app.session import SessionLocal
+from app.session import async_session
+from asyncio import get_event_loop
 
 
-def main() -> None:
+async def main() -> None:
     logging.info("Start initial data")
-    session = SessionLocal()
-    user = (
-        session.execute(
+    async with async_session() as session:
+
+        result = await session.execute(
             select(User).where(User.email == settings.FIRST_SUPERUSER_EMAIL)
         )
-        .scalars()
-        .first()
-    )
-
-    if user is None:
-        new_superuser = User(
-            email=settings.FIRST_SUPERUSER_EMAIL,
-            hashed_password=security.get_password_hash(
-                settings.FIRST_SUPERUSER_PASSWORD
-            ),
-            full_name=settings.FIRST_SUPERUSER_EMAIL,
-        )
-        session.add(new_superuser)
-        session.commit()
-        logging.info("Superuser was created")
-    else:
-        logging.warning("Superuser already exists in database")
+        user: Optional[User] = result.scalars().first()
+
+        if user is None:
+            new_superuser = User(
+                email=settings.FIRST_SUPERUSER_EMAIL,
+                hashed_password=security.get_password_hash(
+                    settings.FIRST_SUPERUSER_PASSWORD
+                ),
+                full_name=settings.FIRST_SUPERUSER_EMAIL,
+            )
+            session.add(new_superuser)
+            await session.commit()
+            logging.info("Superuser was created")
+        else:
+            logging.warning("Superuser already exists in database")
 
-    logging.info("Initial data created")
+        logging.info("Initial data created")
 
 
 if __name__ == "__main__":
-    main()
+    get_event_loop().run_until_complete(main())

{{cookiecutter.project_name}}/app/initial_data.py

@@ -1,7 +1,11 @@
-from sqlalchemy import create_engine
-from sqlalchemy.orm import sessionmaker
+from sqlalchemy.ext.asyncio import create_async_engine, AsyncSession
+from sqlalchemy.orm.session import sessionmaker
+
 
 from app.core.config import settings
 
-engine = create_engine(settings.SQLALCHEMY_DATABASE_URI, pool_pre_ping=True)
-SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+async_engine = create_async_engine(settings.SQLALCHEMY_DATABASE_URI, pool_pre_ping=True)
+
+AsyncSessionLocal = AsyncSession(async_engine, expire_on_commit=False)
+
+async_session = sessionmaker(async_engine, expire_on_commit=False, class_=AsyncSession)