Fix typing

Author: frankie567

fastapi_users_db_sqlalchemy/__init__.py

@@ -1,12 +1,12 @@
 """FastAPI Users database adapter for SQLAlchemy."""
 import uuid
-from typing import Any, Dict, Generic, Optional, Type
+from typing import TYPE_CHECKING, Any, Dict, Generic, Optional, Type
 
 from fastapi_users.db.base import BaseUserDatabase
 from fastapi_users.models import ID, OAP, UP
 from sqlalchemy import Boolean, Column, ForeignKey, Integer, String, func, select
 from sqlalchemy.ext.asyncio import AsyncSession
-from sqlalchemy.ext.declarative import declared_attr
+from sqlalchemy.orm import declarative_mixin, declared_attr
 from sqlalchemy.sql import Select
 
 from fastapi_users_db_sqlalchemy.generics import GUID
@@ -16,42 +16,67 @@
 UUID_ID = uuid.UUID
 
 
+@declarative_mixin
 class SQLAlchemyBaseUserTable(Generic[ID]):
     """Base SQLAlchemy users table definition."""
 
     __tablename__ = "user"
 
-    id: ID
-    email: str = Column(String(length=320), unique=True, index=True, nullable=False)
-    hashed_password: str = Column(String(length=1024), nullable=False)
-    is_active: bool = Column(Boolean, default=True, nullable=False)
-    is_superuser: bool = Column(Boolean, default=False, nullable=False)
-    is_verified: bool = Column(Boolean, default=False, nullable=False)
-
-
+    if TYPE_CHECKING:  # pragma: no cover
+        id: ID
+        email: str
+        hashed_password: str
+        is_active: bool
+        is_superuser: bool
+        is_verified: bool
+    else:
+        email: str = Column(String(length=320), unique=True, index=True, nullable=False)
+        hashed_password: str = Column(String(length=1024), nullable=False)
+        is_active: bool = Column(Boolean, default=True, nullable=False)
+        is_superuser: bool = Column(Boolean, default=False, nullable=False)
+        is_verified: bool = Column(Boolean, default=False, nullable=False)
+
+
+@declarative_mixin
 class SQLAlchemyBaseUserTableUUID(SQLAlchemyBaseUserTable[UUID_ID]):
-    id: UUID_ID = Column(GUID, primary_key=True, default=uuid.uuid4)
+    if TYPE_CHECKING:  # pragma: no cover
+        id: UUID_ID
+    else:
+        id: UUID_ID = Column(GUID, primary_key=True, default=uuid.uuid4)
 
 
+@declarative_mixin
 class SQLAlchemyBaseOAuthAccountTable(Generic[ID]):
     """Base SQLAlchemy OAuth account table definition."""
 
     __tablename__ = "oauth_account"
 
-    id: ID
-    oauth_name: str = Column(String(length=100), index=True, nullable=False)
-    access_token: str = Column(String(length=1024), nullable=False)
-    expires_at: Optional[int] = Column(Integer, nullable=True)
-    refresh_token: Optional[str] = Column(String(length=1024), nullable=True)
-    account_id: str = Column(String(length=320), index=True, nullable=False)
-    account_email: str = Column(String(length=320), nullable=False)
-
-
+    if TYPE_CHECKING:  # pragma: no cover
+        id: ID
+        oauth_name: str
+        access_token: str
+        expires_at: Optional[int]
+        refresh_token: Optional[str]
+        account_id: str
+        account_email: str
+    else:
+        oauth_name: str = Column(String(length=100), index=True, nullable=False)
+        access_token: str = Column(String(length=1024), nullable=False)
+        expires_at: Optional[int] = Column(Integer, nullable=True)
+        refresh_token: Optional[str] = Column(String(length=1024), nullable=True)
+        account_id: str = Column(String(length=320), index=True, nullable=False)
+        account_email: str = Column(String(length=320), nullable=False)
+
+
+@declarative_mixin
 class SQLAlchemyBaseOAuthAccountTableUUID(SQLAlchemyBaseOAuthAccountTable[UUID_ID]):
-    id: UUID_ID = Column(GUID, primary_key=True, default=uuid.uuid4)
+    if TYPE_CHECKING:  # pragma: no cover
+        id: UUID_ID
+    else:
+        id: UUID_ID = Column(GUID, primary_key=True, default=uuid.uuid4)
 
     @declared_attr
-    def user_id(cls):
+    def user_id(cls) -> Column[GUID]:
         return Column(GUID, ForeignKey("user.id", ondelete="cascade"), nullable=False)
 
 

fastapi_users_db_sqlalchemy/access_token.py

@@ -6,30 +6,39 @@
 from fastapi_users.models import ID
 from sqlalchemy import Column, ForeignKey, String, select
 from sqlalchemy.ext.asyncio import AsyncSession
-from sqlalchemy.ext.declarative import declared_attr
+from sqlalchemy.orm import declarative_mixin, declared_attr
 
 from fastapi_users_db_sqlalchemy.generics import GUID, TIMESTAMPAware, now_utc
 
 
+@declarative_mixin
 class SQLAlchemyBaseAccessTokenTable(Generic[ID]):
     """Base SQLAlchemy access token table definition."""
 
     __tablename__ = "accesstoken"
 
-    token: str = Column(String(length=43), primary_key=True)
-    created_at: datetime = Column(
-        TIMESTAMPAware, index=True, nullable=False, default=now_utc
-    )
-    user_id: ID
+    if TYPE_CHECKING:  # pragma: no cover
+        token: str
+        created_at: datetime
+        user_id: ID
+    else:
+        token: str = Column(String(length=43), primary_key=True)
+        created_at: datetime = Column(
+            TIMESTAMPAware, index=True, nullable=False, default=now_utc
+        )
 
 
+@declarative_mixin
 class SQLAlchemyBaseAccessTokenTableUUID(SQLAlchemyBaseAccessTokenTable[uuid.UUID]):
-    if TYPE_CHECKING:
-        user_id: uuid.UUID  # pragma: no cover
+    if TYPE_CHECKING:  # pragma: no cover
+        user_id: uuid.UUID
     else:
+
         @declared_attr
-        def user_id(cls):
-            return Column(GUID, ForeignKey("user.id", ondelete="cascade"), nullable=False)
+        def user_id(cls) -> Column[GUID]:
+            return Column(
+                GUID, ForeignKey("user.id", ondelete="cascade"), nullable=False
+            )
 
 
 class SQLAlchemyAccessTokenDatabase(Generic[AP], AccessTokenDatabase[AP]):

fastapi_users_db_sqlalchemy/generics.py

@@ -15,7 +15,7 @@ class GUID(TypeDecorator):  # pragma: no cover
     """
 
     class UUIDChar(CHAR):
-        python_type = UUID4
+        python_type = UUID4  # type: ignore
 
     impl = UUIDChar
     cache_ok = True

tests/test_access_token.py

@@ -6,7 +6,7 @@
 from pydantic import UUID4
 from sqlalchemy import exc
 from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession, create_async_engine
-from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base
+from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import sessionmaker
 
 from fastapi_users_db_sqlalchemy import SQLAlchemyBaseUserTableUUID
@@ -15,7 +15,7 @@
     SQLAlchemyBaseAccessTokenTableUUID,
 )
 
-Base: DeclarativeMeta = declarative_base()
+Base = declarative_base()
 
 
 class AccessToken(SQLAlchemyBaseAccessTokenTableUUID, Base):

tests/test_users.py

@@ -3,7 +3,7 @@
 import pytest
 from sqlalchemy import Column, String, exc
 from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession, create_async_engine
-from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base
+from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import relationship, sessionmaker
 
 from fastapi_users_db_sqlalchemy import (
@@ -18,14 +18,14 @@ def create_async_session_maker(engine: AsyncEngine):
     return sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
 
 
-Base: DeclarativeMeta = declarative_base()
+Base = declarative_base()
 
 
 class User(SQLAlchemyBaseUserTableUUID, Base):
     first_name = Column(String, nullable=True)
 
 
-OAuthBase: DeclarativeMeta = declarative_base()
+OAuthBase = declarative_base()
 
 
 class OAuthAccount(SQLAlchemyBaseOAuthAccountTableUUID, OAuthBase):