fastapi-extra 0.1.3__tar.gz → 0.1.5__tar.gz

{fastapi_extra-0.1.3 → fastapi_extra-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: fastapi-extra
-Version: 0.1.3
+Version: 0.1.5
 Summary: extra package for fastapi.
 Author-email: Ziyan Yin <408856732@qq.com>
 License: BSD-3-Clause

{fastapi_extra-0.1.3 → fastapi_extra-0.1.5}/fastapi_extra/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.3"
+__version__ = "0.1.5"
 
 
 from fastapi import FastAPI

fastapi_extra-0.1.5/fastapi_extra/cache/__init__.py

@@ -0,0 +1,10 @@
+__author__ = "ziyan.yin"
+__date__ = "2025-01-10"
+
+from .redis import Redis, RedisCli, RedisMaker
+
+__all__ = [
+    "Redis",
+    "RedisMaker",
+    "RedisCli"
+]

fastapi_extra-0.1.5/fastapi_extra/cache/redis.py

@@ -0,0 +1,52 @@
+__author__ = "ziyan.yin"
+__date__ = "2025-01-17"
+
+
+from typing import Annotated, AsyncGenerator
+
+from fastapi.params import Depends
+from pydantic import BaseModel, Field, RedisDsn
+from redis.asyncio import ConnectionPool, Redis
+
+from fastapi_extra.settings import Settings
+
+
+class RedisConfig(BaseModel):
+    url: RedisDsn = RedisDsn("redis://localhost:6379/0")
+    max_connections: int | None = None
+    connection_kwargs: dict = Field(default_factory=dict)
+
+
+class DefaultRedisSettings(Settings):
+    redis: RedisConfig
+
+
+def load_pool(config: RedisConfig) -> ConnectionPool:
+    return ConnectionPool.from_url(
+        config.url, 
+        **config.model_dump(exclude_defaults=True, exclude={"url", "connection_kwargs"}), 
+        **config.connection_kwargs
+    )
+
+
+_settings = DefaultRedisSettings()  # type: ignore
+DEFAULT_POOL = load_pool(_settings.redis)
+
+
+async def dispose() -> None:
+    await DEFAULT_POOL.aclose()
+
+
+class RedisMaker(Depends):
+    
+    def __init__(self, pool: ConnectionPool):
+        super().__init__()
+        self.dependency = self
+        self.pool = pool
+    
+    async def __call__(self) -> AsyncGenerator[Redis, None]:
+        async with Redis(connection_pool=self.pool) as session:
+            yield session
+
+
+RedisCli = Annotated[Redis, RedisMaker(DEFAULT_POOL)]

fastapi_extra-0.1.5/fastapi_extra/database/__init__.py

@@ -0,0 +1,17 @@
+__author__ = "ziyan.yin"
+__date__ = "2025-01-05"
+
+
+from fastapi_extra.database.model import SQLBase
+from fastapi_extra.database.service import ModelService
+from fastapi_extra.database.session import AsyncSessionMaker
+from fastapi_extra.database.session import DefaultSession as Session
+from fastapi_extra.database.session import SessionMaker
+
+__all__ = [
+    "AsyncSessionMaker",
+    "ModelService",
+    "Session",
+    "SessionMaker",
+    "SQLBase"
+]

fastapi_extra-0.1.5/fastapi_extra/database/engine.py

@@ -0,0 +1,50 @@
+__author__ = "ziyan.yin"
+__date__ = "2024-12-26"
+
+
+from typing import Any, Literal
+
+from pydantic import AnyUrl, BaseModel, Field
+from sqlalchemy import Engine, NullPool
+from sqlalchemy.util import _concurrency_py3k
+from sqlmodel import create_engine
+
+from fastapi_extra.settings import Settings
+
+
+class DatabaseConfig(BaseModel):
+    url: AnyUrl
+    echo: bool = False
+    echo_pool: bool = False
+    isolation_level: Literal[
+        "SERIALIZABLE",
+        "REPEATABLE READ",
+        "READ COMMITTED",
+        "READ UNCOMMITTED",
+        "AUTOCOMMIT",
+    ] | None = None
+    options: dict = Field(default_factory=dict)
+
+
+class DefaultDatabaseSettings(Settings):
+    datasource: DatabaseConfig
+    
+
+def load_engine(config: DatabaseConfig, **kw: Any) -> Engine:
+    return create_engine(
+        url=str(config.url),
+        **config.model_dump(exclude_defaults=True, exclude={"url", "options"}), 
+        **config.options,
+        **kw
+    )
+    
+
+_settings = DefaultDatabaseSettings()  # type: ignore
+if _settings.mode == "test":
+    DEFAULT_ENGINE: Engine = load_engine(_settings.datasource, poolclass=NullPool)
+else:
+    DEFAULT_ENGINE: Engine = load_engine(_settings.datasource)
+
+
+async def dispose() -> None:
+    await _concurrency_py3k.greenlet_spawn(DEFAULT_ENGINE.dispose)

fastapi_extra-0.1.5/fastapi_extra/database/model.py

@@ -0,0 +1,80 @@
+__author__ = "ziyan.yin"
+__date__ = "2024-12-25"
+
+
+import datetime
+
+from sqlalchemy import BigInteger, DateTime, Integer, SmallInteger, func
+from sqlalchemy.ext.declarative import declared_attr
+from sqlmodel import Field, SQLModel
+
+from fastapi_extra.cursor import Cursor as _Cursor  # type: ignore
+from fastapi_extra.types import Cursor, LocalDateTime
+from fastapi_extra.utils import get_machine_seed
+
+
+class AutoPK(SQLModel):
+    id: int | None = Field(
+        default_factory=lambda: None, 
+        title="ID", 
+        primary_key=True,
+        sa_type=BigInteger,
+        sa_column_kwargs={"autoincrement": True},
+        schema_extra={"json_schema_extra": {"readOnly": True}},
+    )
+
+
+class LocalPK(SQLModel):
+    id: Cursor | None = Field(
+        default_factory=_Cursor(get_machine_seed()).next_val, 
+        title="ID", 
+        primary_key=True, 
+        sa_type=BigInteger,
+        sa_column_kwargs={"autoincrement": False},
+        schema_extra={"json_schema_extra": {"readOnly": True}},
+    )
+
+
+class Deleted(SQLModel):
+    deleted: int = Field(
+        default=0,
+        title="DELETED",
+        sa_type=SmallInteger,
+        sa_column_kwargs={"nullable": False, "comment": "DELETED"},
+        schema_extra={"json_schema_extra": {"readOnly": True}},
+    )
+
+
+class Versioned(SQLModel):
+    version_id: int = Field(
+        default=0,
+        title="VERSION_ID",
+        sa_type=Integer,
+        sa_column_kwargs={"nullable": False, "comment": "VERSION_ID"},
+        schema_extra={"json_schema_extra": {"readOnly": True}},
+    )
+    
+    @declared_attr  # type: ignore
+    def __mapper_args__(cls) -> dict:
+        return {"version_id_col": "version_id"}
+
+
+class Optime(SQLModel):
+    create_at: LocalDateTime = Field(
+        default_factory=datetime.datetime.now, 
+        title="CREATE_AT",
+        sa_type=DateTime,
+        sa_column_kwargs={"default": func.now(), "nullable": False, "comment": "CREATE_AT"},
+        schema_extra={"json_schema_extra": {"readOnly": True}},
+    )
+    update_at: LocalDateTime = Field(
+        default_factory=datetime.datetime.now, 
+        title="UPDATE_AT",
+        sa_type=DateTime,
+        sa_column_kwargs={"default": func.now(), "onupdate": func.now(), "nullable": False, "comment": "UPDATE_AT"},
+        schema_extra={"json_schema_extra": {"readOnly": True}},
+    )
+
+
+class SQLBase(LocalPK, Versioned, Deleted, Optime):
+    pass

fastapi_extra-0.1.5/fastapi_extra/database/service.py

@@ -0,0 +1,40 @@
+__author__ = "ziyan.yin"
+__date__ = "2025-01-12"
+
+from typing import Any, Generic, Self, TypeVar
+
+from fastapi_extra.database.model import SQLModel
+from fastapi_extra.database.session import DefaultSession
+from fastapi_extra.dependency import AbstractDependency
+
+Model = TypeVar("Model", bound=SQLModel)
+
+
+class ModelService(AbstractDependency, Generic[Model], annotated=False):
+    __slot__ = ("session", )
+    __model__: SQLModel
+    
+    @classmethod
+    def __class_getitem__(cls, item: type[SQLModel]) -> Self:
+        if not issubclass(item, SQLModel):
+            raise TypeError(f"type[SQLModel] expected, got {item}")
+        if not (table_arg := item.model_config.get("table", None)):
+            raise AttributeError(f"True expected for argument {item.__name__}.model_config.table, got {table_arg}")
+        cls.__model__ = item
+        return cls
+
+    def __init__(self, session: DefaultSession):
+        self.session = session
+
+    async def get(self, ident: int | str, **kwargs: Any) -> Model | None:
+        return await self.session.get(self.__model__, ident, **kwargs)
+
+    async def create(self, model: Model) -> Model:
+        return await self.session.add(model)
+    
+    async def create_model(self, **kwargs: Any) -> Model:
+        model = self.__model__.model_validate(kwargs)
+        return self.create(model)
+    
+    async def delete(self, model: Model) -> Model:
+        return await self.session.delete(model)

fastapi_extra-0.1.5/fastapi_extra/database/session.py

@@ -0,0 +1,39 @@
+__author__ = "ziyan.yin"
+__date__ = "2025-01-05"
+
+
+from typing import Annotated, AsyncGenerator, Generator
+
+from fastapi.params import Depends
+from sqlalchemy.ext.asyncio import AsyncEngine
+from sqlmodel import Session as _Session
+from sqlmodel.ext.asyncio.session import AsyncSession
+
+from fastapi_extra.database.engine import DEFAULT_ENGINE, Engine
+
+
+class SessionMaker(Depends):
+    __slots__ = ("engine", )
+    
+    def __init__(self, engine: Engine):
+        super().__init__()
+        self.engine = engine
+        self.dependency = self
+
+    def __call__(self) -> Generator[_Session, None, None]:
+        with _Session(self.engine) as session:
+            yield session
+
+
+class AsyncSessionMaker(SessionMaker):
+    
+    def __init__(self, engine: Engine):
+        super().__init__(engine)
+        self.async_engine: AsyncEngine = AsyncEngine(self.engine)
+    
+    async def __call__(self) -> AsyncGenerator[AsyncSession, None]:
+        async with AsyncSession(self.async_engine) as session:
+            yield session
+            
+
+DefaultSession = Annotated[AsyncSession, AsyncSessionMaker(DEFAULT_ENGINE)]

{fastapi_extra-0.1.3 → fastapi_extra-0.1.5}/fastapi_extra.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: fastapi-extra
-Version: 0.1.3
+Version: 0.1.5
 Summary: extra package for fastapi.
 Author-email: Ziyan Yin <408856732@qq.com>
 License: BSD-3-Clause

{fastapi_extra-0.1.3 → fastapi_extra-0.1.5}/fastapi_extra.egg-info/SOURCES.txt

@@ -15,5 +15,12 @@ fastapi_extra.egg-info/requires.txt
 fastapi_extra.egg-info/top_level.txt
 fastapi_extra/native/cursor.pyx
 fastapi_extra/native/routing.pyx
+fastapi_extra/cache/__init__.py
+fastapi_extra/cache/redis.py
+fastapi_extra/database/__init__.py
+fastapi_extra/database/engine.py
+fastapi_extra/database/model.py
+fastapi_extra/database/service.py
+fastapi_extra/database/session.py
 fastapi_extra/native/cursor.pyx
 fastapi_extra/native/routing.pyx

{fastapi_extra-0.1.3 → fastapi_extra-0.1.5}/pyproject.toml

@@ -44,7 +44,7 @@ pgsql = ["asyncpg"]
 aiomysql = ["aiomysql"]
 
 [tool.setuptools]
-packages = ["fastapi_extra"]
+packages = ["fastapi_extra", "fastapi_extra.database", "fastapi_extra.cache"]
 ext-modules = [
     { name = "fastapi_extra.cursor", sources = ["fastapi_extra/native/cursor.pyx"] },
     { name = "fastapi_extra.routing", sources = ["fastapi_extra/native/routing.pyx"] }