reyserver 1.1.80__py3-none-any.whl → 1.1.82__py3-none-any.whl

reyserver/__init__.py

@@ -12,6 +12,8 @@ Modules
 rall : All methods.
 rauth : Authentication methods.
 rbase : Base methods.
+rbind : Dependency bind methods.
+rcache : Cache methods.
 rclient : Client methods.
 rfile : File methods.
 rpublic : Public methods.

reyserver/rall.py

@@ -12,6 +12,7 @@
 from .rauth import *
 from .rbase import *
 from .rbind import *
+from .rcache import *
 from .rclient import *
 from .rfile import *
 from .rpublic import *

reyserver/rbase.py

@@ -12,6 +12,7 @@
 from typing import NoReturn
 from http import HTTPStatus
 from fastapi import HTTPException
+from fastapi.params import Depends
 from reykit.rbase import Base, Exit, throw
 
 
@@ -19,7 +20,8 @@ __all__ = (
     'ServerBase',
     'ServerExit',
     'ServerExitAPI',
-    'exit_api'
+    'exit_api',
+    'depend_pass'
 )
 
 
@@ -61,3 +63,12 @@ def exit_api(code: int = 400, text: str | None = None) -> NoReturn:
 
     # Throw exception.
     raise ServerExitAPI(code, text)
+
+
+async def depend_pass_func() -> None:
+    """
+    Depend pass.
+    """
+
+
+depend_pass = Depends(depend_pass_func)

reyserver/rbind.py

@@ -23,10 +23,10 @@ from fastapi.params import (
 )
 from reydb.rconn import DatabaseConnectionAsync
 from reydb.rorm import DatabaseORMSessionAsync
-from reykit.rbase import StaticMeta, Singleton
+from reykit.rbase import StaticMeta, Singleton, throw
 
 from . import rserver
-from .rbase import ServerBase
+from .rbase import ServerBase, depend_pass
 
 
 __all__ = (
@@ -67,6 +67,10 @@ class ServerBindInstanceDatabaseSuper(ServerBase):
             Dependencie function of asynchronous database.
             """
 
+            # Check.
+            if server.db is None:
+                throw(TypeError, server.db)
+
             # Parameter.
             engine = server.db[name]
 
@@ -324,7 +328,7 @@ class ServerBind(ServerBase, metaclass=StaticMeta):
     'Server API bind parameter asynchronous database connection.'
     sess = ServerBindInstanceDatabaseSession()
     'Server API bind parameter asynchronous database session.'
-    token: Depend
+    token: Depend = depend_pass
     'Server authentication token dependency type.'
 
 

reyserver/rcache.py

@@ -0,0 +1,116 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+@Time    : 2025-10-25
+@Author  : Rey
+@Contact : reyxbo@163.com
+@Explain : Cache methods.
+"""
+
+
+from typing import Any
+from collections.abc import Callable
+from inspect import  iscoroutinefunction
+from fastapi import Request, Response
+from fastapi_cache import FastAPICache
+from fastapi_cache.coder import PickleCoder
+from fastapi_cache.backends.redis import RedisBackend
+from fastapi_cache.decorator import cache as fastapi_cache_cache
+from redis.asyncio import Redis
+from reykit.rbase import CallableT
+from reykit.ros import get_md5
+from reykit.rre import sub
+
+
+__all__ = (
+    'init_cache',
+    'wrap_cache'
+)
+
+
+def init_cache(redis: Redis, redis_expire: int | None = None) -> None:
+    """
+    Initialize cache based on Redis.
+
+    Parameters
+    ----------
+    redis : Asynchronous Redis
+    redis_expire : Redis cache expire seconds.
+    """
+
+
+    def key_builder(
+        func: Callable,
+        namespace: str,
+        request: Request | None,
+        response: Response | None,
+        args: tuple,
+        kwargs: dict[str, Any],
+    ) -> str:
+        """
+        Cache key builder.
+
+        Parameters
+        ----------
+        func : Decorated function.
+        namespace : Cache key prefix.
+        request : API Request.
+        response : API response.
+        args : Position arguments of decorated function.
+        kwargs : Keyword arguments of decorated function.
+        """
+
+        # Parameter.
+        data = f'{func.__module__}:{func.__name__}:{args}:{kwargs}'
+        pattern = r' object at 0x[0-9a-fA-F]+>'
+        data = sub(pattern, data, '>')
+
+        # Build.
+        key = get_md5(data)
+
+        return key
+
+
+    # Initialize.
+    backend = RedisBackend(redis)
+    FastAPICache.init(
+        backend,
+        expire=redis_expire,
+        coder=PickleCoder,
+        key_builder=key_builder
+    )
+
+
+def wrap_cache(func_or_expire: CallableT | int | None = None) -> CallableT | Callable[[CallableT], CallableT]:
+    """
+    Decorator, use Redis cache.
+    When Redis is not set, then skip.
+
+    Parameters
+    ----------
+    func_or_expire : Decorated function or Redis cache expire seconds.
+
+    Returns
+    -------
+    Decorated function or decorator.
+
+    Examples
+    --------
+    No parameter.
+    >>> @wrap_cache
+    >>> def foo(): ...
+
+    Set parameter.
+    >>> @wrap_cache(60)
+    >>> def foo(): ...
+    """
+
+    # Decorate.
+    if callable(func_or_expire):
+        decorator = fastapi_cache_cache()
+        func = decorator(func_or_expire)
+        return func
+    else:
+        decorator = fastapi_cache_cache(func_or_expire)
+        return decorator

reyserver/rclient.py

@@ -126,9 +126,6 @@ class ServerClient(ServerBase):
         return response
 
 
-    # request = copy_type_hints(_request, request)
-
-
     def upload_file(
         self,
         source: str | bytes,

reyserver/rfile.py

@@ -16,6 +16,7 @@ from reykit.ros import get_md5
 
 from .rbase import exit_api
 from .rbind import Bind
+from .rcache import wrap_cache
 
 
 __all__ = (
@@ -182,6 +183,7 @@ router_file = APIRouter()
 
 
 @router_file.get('/files/{file_id}')
+@wrap_cache
 async def get_file_info(
     file_id: int = Bind.i.path,
     sess: Bind.Sess = Bind.sess.file

reyserver/rserver.py

@@ -20,6 +20,8 @@ from fastapi.staticfiles import StaticFiles
 from fastapi.middleware.gzip import GZipMiddleware
 from fastapi.middleware.trustedhost import TrustedHostMiddleware
 from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware
+from fastapi_cache import FastAPICache
+from redis.asyncio import Redis
 from reydb import DatabaseAsync
 from reykit.rbase import CoroutineFunctionSimple, Singleton, throw
 from reykit.ros import FileStore
@@ -27,6 +29,7 @@ from reykit.rrand import randchar
 
 from .rbase import ServerBase
 from .rbind import Bind
+from .rcache import init_cache
 
 
 __all__ = (
@@ -59,6 +62,8 @@ class Server(ServerBase, Singleton):
         self,
         db: DatabaseAsync | None = None,
         db_warm: bool = False,
+        redis: Redis | None = None,
+        redis_expire: int | None = None,
         depend: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
         before: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
         after: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
@@ -70,8 +75,10 @@ class Server(ServerBase, Singleton):
 
         Parameters
         ----------
-        db : Asynchronous database, must include database engines with APIs.
+        db : Asynchronous database, include database engines required for APIs.
         db_warm : Whether database pre create connection to warm all pool.
+        redis : Asynchronous Redis, activate cache function.
+        redis_expire : Redis cache expire seconds.
         depend : Global api dependencies.
         before : Execute before server start.
         after : Execute after server end.
@@ -88,10 +95,16 @@ class Server(ServerBase, Singleton):
             Bind.Depend(task)
             for task in depend
         ]
-        lifespan = self.__create_lifespan(before, after, db_warm)
+        lifespan = self.__create_lifespan(
+            before,
+            after,
+            db_warm,
+            redis_expire
+        )
 
         # Build.
         self.db = db
+        self.redis = redis
         self.app = FastAPI(
             dependencies=depend,
             lifespan=lifespan,
@@ -113,7 +126,8 @@ class Server(ServerBase, Singleton):
         self,
         before: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None,
         after: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None,
-        db_warm: bool
+        db_warm: bool,
+        redis_expire: int | None
     ) -> _AsyncGeneratorContextManager[None, None]:
         """
         Create asynchronous function of lifespan manager.
@@ -123,6 +137,7 @@ class Server(ServerBase, Singleton):
         before : Execute before server start.
         after : Execute after server end.
         db_warm : Whether database pre create connection to warm all pool.
+        redis_expire : Redis cache expire seconds.
 
         Returns
         -------
@@ -158,6 +173,12 @@ class Server(ServerBase, Singleton):
             if db_warm:
                 await self.db.warm_all()
 
+            ## Redis.
+            if self.redis is not None:
+                init_cache(self.redis, redis_expire)
+            else:
+                FastAPICache._enable = False
+
             # Runing.
             yield
 
@@ -166,7 +187,8 @@ class Server(ServerBase, Singleton):
                 await after()
 
             ## Database.
-            await self.db.dispose_all()
+            if self.db is not None:
+                await self.db.dispose_all()
 
 
         return lifespan
@@ -370,8 +392,11 @@ class Server(ServerBase, Singleton):
             key = randchar(32)
 
         # Database.
-        if 'auth' not in self.db:
-            throw(AssertionError, self.db)
+        if (
+            self.db is None
+            or 'auth' not in self.db
+        ):
+            throw(TypeError, self.db)
         engine = self.db.auth
         build_db_auth(engine)
 
@@ -395,8 +420,11 @@ class Server(ServerBase, Singleton):
         from .rfile import build_db_file, router_file
 
         # Database.
-        if 'file' not in self.db:
-            throw(AssertionError, self.db)
+        if (
+            self.db is None
+            or 'file' not in self.db
+        ):
+            throw(TypeError, self.db)
         engine = self.db.file
         build_db_file(engine)
 

{reyserver-1.1.80.dist-info → reyserver-1.1.82.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reyserver
-Version: 1.1.80
+Version: 1.1.82
 Summary: Backend server method set.
 Project-URL: homepage, https://github.com/reyxbo/reyserver/
 Author-email: Rey <reyxbo@163.com>
@@ -14,6 +14,7 @@ License: Copyright 2025 ReyXBo
 License-File: LICENSE
 Keywords: API,async,asynchronous,backend,rey,reyxbo,server
 Requires-Python: >=3.12
+Requires-Dist: fastapi-cache2[redis]
 Requires-Dist: fastapi[standard]
 Requires-Dist: reydb
 Requires-Dist: reykit

reyserver-1.1.82.dist-info/RECORD

@@ -0,0 +1,16 @@
+reyserver/__init__.py,sha256=WnSqy03gZLHltfWe7bbg-q8-z-fn9UF9tokkXTc3ycI,513
+reyserver/rall.py,sha256=ZK-Dn7wmG_GkiCefN7Fx5UJ3r8w_1gJ7OhyPP8__M0s,387
+reyserver/rauth.py,sha256=7mANcRcbJ3e4u0PDSMquBeCWKchHbmVeFOVv7syU7Q0,15236
+reyserver/rbase.py,sha256=JVgFso6Aohow1sEgZCH83xB90sriZPv6DHlNwGTfOhw,1314
+reyserver/rbind.py,sha256=zGXRzKWbhhFNJIdAj-cqO307fVhs3yzDBAKnAy2ixt4,6930
+reyserver/rcache.py,sha256=DLNea4gcLKjh3pkuI2A9aDV0lNtw6dzWuREGzptS1wk,2756
+reyserver/rclient.py,sha256=s2uXigkSnpzdkQ_nLroyDvwo9XyHbxUFHVHUn_Z5QzU,6234
+reyserver/rfile.py,sha256=_-MGyIst3jzUheYOhhJUYvw8Ed20rD660za0pTgKypg,8936
+reyserver/rpublic.py,sha256=ixKDWdDihdVQ8Pqjpril7veJ9kkFK9yiRm8CTwmck4Q,1095
+reyserver/rredirect.py,sha256=c7wgXn5UeF53irMlbJ8vctec2KEc3DuHhBOa8NBoFjA,857
+reyserver/rserver.py,sha256=BUpP0U0ycZO6z_OTa1QYlK1RaLJCIQ_UVApKO7YHYEQ,12153
+reyserver/rtest.py,sha256=MPYsyRzO3mZL5LJfUeBY1cafXvDsT2BGqoXq49wmJeo,777
+reyserver-1.1.82.dist-info/METADATA,sha256=k2nB0e9XO19xvqda0eNp5pkOaMepmk-plcCunD0zZOk,1703
+reyserver-1.1.82.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reyserver-1.1.82.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reyserver-1.1.82.dist-info/RECORD,,

reyserver-1.1.80.dist-info/RECORD

@@ -1,15 +0,0 @@
-reyserver/__init__.py,sha256=iT5IWIBDvaeYvxs0HuV6mZfN2D0G4xkb_0DhX-VpsDk,454
-reyserver/rall.py,sha256=a3e8o1wtV_wBlR2m-df94SQ7TakC9-jPUoxNZfix1nM,364
-reyserver/rauth.py,sha256=7mANcRcbJ3e4u0PDSMquBeCWKchHbmVeFOVv7syU7Q0,15236
-reyserver/rbase.py,sha256=mq6ChIcxb8-RUZgYqJZ8LOa0XTr0d8VU-xVzhJ0q5AQ,1134
-reyserver/rbind.py,sha256=QrRCT8p-2bwxxBQNZmFq4RAsVHs3_mRuobsbHo1Uc9M,6792
-reyserver/rclient.py,sha256=Q-nU-knvvuyO7hHYnAvKteVkUhk26K4kGKVExrO8Kww,6290
-reyserver/rfile.py,sha256=xudSM-bVRqzCvifCUTgiZwitPzPNe1KQ2GXLgHtu2zg,8891
-reyserver/rpublic.py,sha256=ixKDWdDihdVQ8Pqjpril7veJ9kkFK9yiRm8CTwmck4Q,1095
-reyserver/rredirect.py,sha256=c7wgXn5UeF53irMlbJ8vctec2KEc3DuHhBOa8NBoFjA,857
-reyserver/rserver.py,sha256=GnsGTsjTUogIqY8o1onKzYqIAoGUSVXWnpxJoW7nvSg,11329
-reyserver/rtest.py,sha256=MPYsyRzO3mZL5LJfUeBY1cafXvDsT2BGqoXq49wmJeo,777
-reyserver-1.1.80.dist-info/METADATA,sha256=ZV5cAro5bMrbz0Aojifa_ApMY4LNVnciqYMrcsjfvvU,1666
-reyserver-1.1.80.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reyserver-1.1.80.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reyserver-1.1.80.dist-info/RECORD,,