fastapi-extra 0.1.4__cp312-cp312-win_amd64.whl → 0.1.6__cp312-cp312-win_amd64.whl

fastapi_extra/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.4"
+__version__ = "0.1.6"
 
 
 from fastapi import FastAPI

fastapi_extra/cache/__init__.py

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

fastapi_extra/cache/redis.py

@@ -0,0 +1,59 @@
+__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.dependency import AbstractWidget
+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
+
+
+_settings = DefaultRedisSettings()  # type: ignore
+_loaded_pools: list[ConnectionPool] = []
+
+
+class RedisCli(AbstractWidget):
+    default_config = _settings.redis
+
+    
+    def __init__(self):
+        self._pool = None
+    
+    @property
+    def pool(self) -> ConnectionPool:
+        if not self._pool:
+            self._pool = ConnectionPool.from_url(
+                self.default_config.url, 
+                **self.default_config.model_dump(exclude_defaults=True, exclude={"url", "connection_kwargs"}), 
+                **self.default_config.connection_kwargs
+            )
+            _loaded_pools.append(self)
+        return self._pool
+
+
+async def dispose() -> None:
+    for redis_pool in _loaded_pools:
+        redis_pool.aclose()
+
+
+
+async def get_redis(redis_cli: RedisCli) -> AsyncGenerator[Redis, None]:
+    async with Redis(connection_pool=redis_cli.pool) as redis:
+        yield redis
+
+
+DefaultRedis = Annotated[Redis, Depends(get_redis)]

fastapi_extra/database/__init__.py

@@ -0,0 +1,14 @@
+__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 DefaultSession as Session
+
+__all__ = [
+    "AsyncSessionMaker",
+    "ModelService",
+    "Session",
+    "SQLBase"
+]

fastapi_extra/database/driver.py

@@ -0,0 +1,81 @@
+__author__ = "ziyan.yin"
+__date__ = "2024-12-26"
+
+
+from typing import Literal
+
+from pydantic import AnyUrl, BaseModel, Field
+from sqlalchemy import Engine, NullPool
+from sqlalchemy.ext.asyncio import AsyncEngine
+from sqlalchemy.util import _concurrency_py3k
+from sqlmodel import Session, create_engine
+from sqlmodel.ext.asyncio.session import AsyncSession
+
+from fastapi_extra.dependency import AbstractWidget
+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
+
+
+_settings = DefaultDatabaseSettings()  # type: ignore
+_loaded_engines: list[Engine] = []
+
+
+class DB(AbstractWidget):
+    default_config = _settings.datasource
+    default_options = {}
+    
+    def __init__(self):
+        self._engine = None
+    
+    @property
+    def engine(self) -> Engine:
+        if not self._engine:
+            self._engine = create_engine(
+                url=str(self.default_config.url),
+                **self.default_config.model_dump(exclude_defaults=True, exclude={"url", "options"}), 
+                **self.default_config.options,
+                **self.default_options
+            )
+            _loaded_engines.append(self._engine)
+        return self._engine
+
+    @property
+    def session(self) -> Session:
+        return Session(self.engine)
+
+
+class AsyncDB(DB):
+    
+    @property
+    def engine(self) -> AsyncEngine:
+        return AsyncEngine(super().engine)
+
+    @property
+    def session(self) -> AsyncSession:
+        return AsyncSession(self.engine)
+        
+
+if _settings.mode == "test":
+    DB.default_options = {"poolclass": NullPool}
+
+
+async def dispose() -> None:
+    for engine in _loaded_engines:
+        await _concurrency_py3k.greenlet_spawn(engine.dispose)

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/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/database/session.py

@@ -0,0 +1,24 @@
+__author__ = "ziyan.yin"
+__date__ = "2025-01-05"
+
+
+from typing import Annotated, AsyncGenerator, Generator
+
+from fastapi.params import Depends
+from sqlmodel import Session
+from sqlmodel.ext.asyncio.session import AsyncSession
+
+from fastapi_extra.database.driver import DB, AsyncDB
+
+
+async def get_async_session(db: AsyncDB) -> AsyncGenerator[AsyncSession, None]:
+    async with db.session as session:
+        yield session
+
+
+def get_session(db: DB) -> Generator[Session, None, None]:
+    with db.session as session:
+        yield session
+
+
+DefaultSession = Annotated[AsyncSession, Depends(get_async_session)]

{fastapi_extra-0.1.4.dist-info → fastapi_extra-0.1.6.dist-info}/METADATA

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

fastapi_extra-0.1.6.dist-info/RECORD

@@ -0,0 +1,23 @@
+fastapi_extra/__init__.py,sha256=s2AZTyatkiSeY9OmuW6p45fFgX9Dz_nVH0jV8ut52q0,286
+fastapi_extra/cursor.cp312-win_amd64.pyd,sha256=IWj0owGMJBYMGeuU-MXPSVRwUCt1hwrlJoqnp97OBNk,57344
+fastapi_extra/dependency.py,sha256=Pgl4Y9Mm6JY5pw19w_xJEmnnLkQ9p_K1h1w9lLVHUJQ,907
+fastapi_extra/form.py,sha256=LikaJkA16dSRGCqX9K7z2S8-e3SJcMiVXX5nRZU_kVY,957
+fastapi_extra/response.py,sha256=DHvhOSgwot5eBNKuI_jPYxZ5rshZ55Xkg-FNBJlHD1E,9609
+fastapi_extra/routing.cp312-win_amd64.pyd,sha256=to_HPQbAav7fTQeOYYaFT9zb1b4qdABNkWqQb1uDZdo,94720
+fastapi_extra/settings.py,sha256=cCcwaper5GiNNoT4gNKqf-iloSOTNnMsiUR0knJx4Mw,1461
+fastapi_extra/types.py,sha256=EUjT9jFryzlazHvWs4m-IfUezmSEvyxwaOGe_vTTBnY,763
+fastapi_extra/utils.py,sha256=tsPX3kpF_P5D9Bd3gnlG6rkVsLkv5gbxjml-s6ZL_6I,346
+fastapi_extra/cache/__init__.py,sha256=2bwWFRf6giDo0QiFWEvekQwga9kGTK_9BJdxe32Nru8,126
+fastapi_extra/cache/redis.py,sha256=N4ntWFNjW1w3OJB64AYSrXbLumPUPK9j2iQcfXxJTC8,1586
+fastapi_extra/database/__init__.py,sha256=B59umaoNjDuXyoNh7EYWYEk4xr9tfgVjXsSaOPz3y_Q,328
+fastapi_extra/database/driver.py,sha256=VOJxRtXusuRyOJHMHLu18ZYbPQtoIbrkQyyADpHs9cA,2146
+fastapi_extra/database/model.py,sha256=icHh6tnVKYVGl0hNX6pYypTiyGQt3g41geOkjBZTTv4,2467
+fastapi_extra/database/service.py,sha256=efDZuz__RqEom-UZHfKQ3rHkxnEYmQocWduVbm3rcy0,1478
+fastapi_extra/database/session.py,sha256=XZ5DfkDn4rHHqdJwhRDP87VPDcycxrq6-j_mu4w9Ou0,633
+fastapi_extra/native/cursor.pyx,sha256=bESprFDgk9gGjyPQ4YCSg51dov2WB6s60XrOs3r5-r0,1146
+fastapi_extra/native/routing.pyx,sha256=GrdGAoBospwCpxMHBon5cuRYcz9ifAFSSYa2Ytf49lg,3841
+fastapi_extra-0.1.6.dist-info/LICENSE,sha256=0vTjHDa3VDsxTT-R-sH6SpYcA2F1hKtbX9ZFZQm-EcU,1516
+fastapi_extra-0.1.6.dist-info/METADATA,sha256=U2HYhcc5OTpOGcN5-hOdLXJ4pEIbzqMk5FC5C62lAX0,1348
+fastapi_extra-0.1.6.dist-info/WHEEL,sha256=cRmSBGD-cl98KkuHMNqv9Ac9L9_VqTvcBYwpIvxN0cg,101
+fastapi_extra-0.1.6.dist-info/top_level.txt,sha256=B7D80bEftE2E-eSd1be2r9BWkLLMZN21dRTWpb4y4Ig,14
+fastapi_extra-0.1.6.dist-info/RECORD,,

fastapi_extra-0.1.4.dist-info/RECORD

@@ -1,16 +0,0 @@
-fastapi_extra/__init__.py,sha256=wZGS0_cF9HspqetdvcDTIxjV9lp-0yTS7toLQQnJI0Q,286
-fastapi_extra/cursor.cp312-win_amd64.pyd,sha256=Zj_hwMRczIkzNkXjW3dUeNqrpBXW-hcTyNPlHSYxW9s,57344
-fastapi_extra/dependency.py,sha256=Pgl4Y9Mm6JY5pw19w_xJEmnnLkQ9p_K1h1w9lLVHUJQ,907
-fastapi_extra/form.py,sha256=LikaJkA16dSRGCqX9K7z2S8-e3SJcMiVXX5nRZU_kVY,957
-fastapi_extra/response.py,sha256=DHvhOSgwot5eBNKuI_jPYxZ5rshZ55Xkg-FNBJlHD1E,9609
-fastapi_extra/routing.cp312-win_amd64.pyd,sha256=4Vlhy3oYaYhUzj9jxQuONzlLYjfo03OmTsCg8jUUbcQ,94720
-fastapi_extra/settings.py,sha256=cCcwaper5GiNNoT4gNKqf-iloSOTNnMsiUR0knJx4Mw,1461
-fastapi_extra/types.py,sha256=EUjT9jFryzlazHvWs4m-IfUezmSEvyxwaOGe_vTTBnY,763
-fastapi_extra/utils.py,sha256=tsPX3kpF_P5D9Bd3gnlG6rkVsLkv5gbxjml-s6ZL_6I,346
-fastapi_extra/native/cursor.pyx,sha256=bESprFDgk9gGjyPQ4YCSg51dov2WB6s60XrOs3r5-r0,1146
-fastapi_extra/native/routing.pyx,sha256=GrdGAoBospwCpxMHBon5cuRYcz9ifAFSSYa2Ytf49lg,3841
-fastapi_extra-0.1.4.dist-info/LICENSE,sha256=0vTjHDa3VDsxTT-R-sH6SpYcA2F1hKtbX9ZFZQm-EcU,1516
-fastapi_extra-0.1.4.dist-info/METADATA,sha256=2YlZPZ_9Y8rbBVG2th19mmT12zzXuBTt7MQDsRtgIjo,1348
-fastapi_extra-0.1.4.dist-info/WHEEL,sha256=cRmSBGD-cl98KkuHMNqv9Ac9L9_VqTvcBYwpIvxN0cg,101
-fastapi_extra-0.1.4.dist-info/top_level.txt,sha256=B7D80bEftE2E-eSd1be2r9BWkLLMZN21dRTWpb4y4Ig,14
-fastapi_extra-0.1.4.dist-info/RECORD,,