reyserver 1.1.45__py3-none-any.whl → 1.1.47__py3-none-any.whl

reyserver/__init__.py

@@ -10,6 +10,7 @@
 Modules
 -------
 rall : All methods.
+rauth : Authentication methods.
 rbase : Base methods.
 rclient : Client methods.
 rfile : File methods.

reyserver/rall.py

@@ -9,6 +9,7 @@
 """
 
 
+from .rauth import *
 from .rbase import *
 from .rclient import *
 from .rfile import *

reyserver/rauth.py

@@ -0,0 +1,11 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+@Time    : 2025-10-10
+@Author  : Rey
+@Contact : reyxbo@163.com
+@Explain : Authentication methods.
+"""
+
+

reyserver/rbase.py

@@ -9,11 +9,24 @@
 """
 
 
-from typing import Sequence
+from typing import Sequence, Literal
 from inspect import iscoroutinefunction
-from contextlib import asynccontextmanager
-from fastapi import FastAPI
-from reykit.rbase import CoroutineFunctionSimple, Base, ConfigMeta
+from contextlib import asynccontextmanager, _AsyncGeneratorContextManager
+from fastapi import FastAPI, HTTPException, status, UploadFile as File
+from fastapi.params import (
+    Depends,
+    Path,
+    Query,
+    Header,
+    Cookie,
+    Body,
+    Form,
+    File as Forms
+)
+from reydb.rconn import DatabaseConnectionAsync
+from reydb.rorm import DatabaseORMModel, DatabaseORMSessionAsync
+from reykit.rwrap import wrap_cache
+from reykit.rbase import CoroutineFunctionSimple, Base, Exit, StaticMeta, ConfigMeta
 
 from . import rserver
 
@@ -21,6 +34,9 @@ from . import rserver
 __all__ = (
     'ServerBase',
     'ServerConfig',
+    'ServerExit',
+    'ServerExitHTTP',
+    'ServerExitHTTP404',
     'create_lifespan',
     'create_depend_sess'
 )
@@ -41,78 +57,177 @@ class ServerConfig(ServerBase, metaclass=ConfigMeta):
     'Server instance.'
 
 
-def create_lifespan(
-    before: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
-    after: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
-):
+class ServerExit(ServerBase, Exit):
+    """
+    Server exit type.
     """
-    Create function of lifespan manager.
 
-    Parameters
-    ----------
-    before : Execute before server start.
-    after : Execute after server end.
+
+class ServerExitHTTP(ServerExit, HTTPException):
+    """
+    Server HTTP exit type.
     """
 
-    # Parameter.
-    if before is None:
-        before = ()
-    elif iscoroutinefunction(before):
-        before = (before,)
-    if after is None:
-        after = ()
-    elif iscoroutinefunction(after):
-        after = (after,)
+    status_code: int
 
 
-    @asynccontextmanager
-    async def lifespan(app: FastAPI):
+    def __init__(self, text: str | None = None):
         """
-        Server lifespan manager.
+        Build instance attributes.
 
         Parameters
         ----------
-        app : Server APP.
+        text : Explain text.
         """
 
-        # Before.
-        for task in before:
-            await task()
-        yield
+        # Super.
+        super().__init__(self.status_code, text)
 
-        # After.
-        for task in after:
-            await after()
 
+class ServerExitHTTP404(ServerExitHTTP):
+    """
+    Server HTTP 404 exit type.
+    """
 
-    return lifespan
+    status_code = status.HTTP_404_NOT_FOUND
 
 
-def create_depend_sess(database: str):
+class ServerBind(ServerBase, metaclass=StaticMeta):
     """
-    Create dependencie function of asynchronous database session.
-
-    Parameters
-    ----------
-    database : Database name.
-
-    Returns
-    -------
-    Dependencie function.
+    Server API bind parameter type.
     """
 
 
-    async def depend_sess():
+    def create_lifespan(
+        before: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
+        after: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
+    ) -> _AsyncGeneratorContextManager[None, None]:
         """
-        Dependencie function of asynchronous database session.
+        Create asynchronous function of lifespan manager.
+
+        Parameters
+        ----------
+        before : Execute before server start.
+        after : Execute after server end.
+
+        Returns
+        -------
+        Asynchronous function.
         """
 
         # Parameter.
-        engine = ServerConfig.server.db[database]
+        if before is None:
+            before = ()
+        elif iscoroutinefunction(before):
+            before = (before,)
+        if after is None:
+            after = ()
+        elif iscoroutinefunction(after):
+            after = (after,)
+
 
-        # Context.
-        async with engine.orm.session() as sess:
-            yield sess
+        @asynccontextmanager
+        async def lifespan(app: FastAPI):
+            """
+            Server lifespan manager.
+
+            Parameters
+            ----------
+            app : Server APP.
+            """
+
+            # Before.
+            for task in before:
+                await task()
+            yield
+
+            # After.
+            for task in after:
+                await after()
+
+
+        return lifespan
+
+
+    @wrap_cache
+    def create_depend_db(database: str, mode: Literal['sess', 'conn']) -> Depends:
+        """
+        Create dependencie type of asynchronous database.
+
+        Parameters
+        ----------
+        database : Database name.
+        mode : Mode.
+            - `Literl['sess']`: Create ORM session instance.
+            - `Literl['conn']`: Create connection instance.
+
+        Returns
+        -------
+        Dependencie type.
+        """
 
 
-    return depend_sess
+        async def depend_db():
+            """
+            Dependencie function of asynchronous database.
+            """
+
+            # Parameter.
+            engine = ServerConfig.server.db[database]
+
+            # Context.
+            if mode == 'sess':
+                async with engine.orm.session() as sess:
+                    yield sess
+            elif mode == 'conn':
+                async with engine.connect() as conn:
+                    yield conn
+
+
+        # Create.
+        depend = Depends(depend_db)
+
+        return depend
+
+
+    Depend = Depends
+    Path = Path
+    Query = Query
+    Header = Header
+    Cookie = Cookie
+    Body = Body
+    Form = Form
+    Forms = Forms
+    File = File
+    JSON = DatabaseORMModel
+    Conn = DatabaseConnectionAsync
+    Sess = DatabaseORMSessionAsync
+    path = Path()
+    'Path instance.'
+    query = Query()
+    'Query instance.'
+    header = Header()
+    'Header instance.'
+    cookie = Cookie()
+    'Cookie instance.'
+    body = Body()
+    'Body instance.'
+    form = Form()
+    'Form instance.'
+    forms = Forms()
+    'Forms instance.'
+    query_n = Query(None)
+    'Query instance, default `None`.'
+    header_n = Header(None)
+    'Header instance, default `None`.'
+    cookie_n = Cookie(None)
+    'Cookie instance, default `None`.'
+    body_n = Body(None)
+    'Body instance, default `None`.'
+    form_n = Form(None)
+    'Form instance, default `None`.'
+    forms_n = Forms(None)
+    'Forms instance, default `None`.'
+
+
+Bind = ServerBind

reyserver/rclient.py

@@ -9,8 +9,10 @@
 """
 
 
-from reykit.ros import File, get_md5
-from reykit.rnet import join_url, request
+from typing import TypedDict
+from datetime import datetime as Datetime
+from reykit.ros import File, Folder, overload
+from reykit.rnet import join_url, request, get_response_file_name
 
 from .rbase import ServerBase
 
@@ -20,6 +22,9 @@ __all__ = (
 )
 
 
+FileInfo = TypedDict('FileInfo', {'create_time': Datetime, 'md5': str, 'name': str | None, 'size': int, 'note': str | None})
+
+
 class ServerClient(ServerBase):
     """
     Server client type.
@@ -64,7 +69,7 @@ class ServerClient(ServerBase):
         """
 
         # Handle parameter.
-        url = join_url(self.url, 'file', 'upload')
+        url = join_url(self.url, 'files')
         match source:
 
             ## File path.
@@ -84,7 +89,7 @@ class ServerClient(ServerBase):
         if name is not None:
             file_name = name
 
-        # Upload.
+        # Request.
         data = {'name': file_name, 'note': note}
         files = {'file': file_bytes}
         response = request(url, data=data, files=files, check=True)
@@ -96,7 +101,85 @@ class ServerClient(ServerBase):
         return file_id
 
 
-    def download_file(self): ...
+    @overload
+    def download_file(
+        self,
+        file_id: int,
+        path: None = None
+    ) -> bytes: ...
+
+    @overload
+    def download_file(
+        self,
+        file_id: int,
+        path: str
+    ) -> str: ...
+
+    def download_file(
+        self,
+        file_id: int,
+        path: str | None = None
+    ) -> bytes | str:
+        """
+        Download file.
+
+        Parameters
+        ----------
+        file_id : File ID.
+        path : File save path.
+            - `None`: Not save and return file bytes.
+            - `str`: Save and return file path.
+                `File path`: Use this file path.
+                `Folder path`: Use this folder path and original name.
+
+        Returns
+        -------
+        File bytes or file path.
+        """
+
+        # Parameter.
+        url = join_url(self.url, 'files', file_id, 'download')
+
+        # Request.
+        response = request(url, check=True)
+        file_bytes = response.content
+
+        # Not save.
+        if path is None:
+            return file_bytes
+
+        # Save.
+        else:
+            folder = Folder(path)
+            if folder:
+                file_name = get_response_file_name(response)
+                path = folder + file_name
+            file = File(path)
+            file(file_bytes)
+            return file.path
+
+
+    def get_file_info(
+        self,
+        file_id: int
+    ) -> FileInfo:
+        """
+        Query file information.
+
+        Parameters
+        ----------
+        file_id : File ID.
+
+        Returns
+        -------
+        File information.
+        """
+
+        # Parameter.
+        url = join_url(self.url, 'files', file_id)
 
+        # Request.
+        response = request(url, check=True)
+        response_dict = response.json()
 
-    def index_file(self): ...
+        return response_dict

reyserver/rfile.py

@@ -9,18 +9,21 @@
 """
 
 
-from typing import Annotated
-from fastapi import APIRouter, Form, File, UploadFile, Depends
+from fastapi import APIRouter
+from fastapi.responses import FileResponse
 from reydb import rorm
+from reydb.rorm import DatabaseORMSessionAsync
+from reydb.rconn import DatabaseConnectionAsync
 from reykit.ros import FileStore, get_md5
 
-from .rbase import ServerConfig, create_depend_sess
+from .rbase import ServerConfig, ServerExitHTTP404, Bind
 
 
 __all__ = (
     'DatabaseORMTableInfo',
     'DatabaseORMTableData',
-    'build_file_db'
+    'build_file_db',
+    'file_router'
 )
 
 
@@ -50,61 +53,6 @@ class DatabaseORMTableData(rorm.Model, table=True):
     path: str = rorm.Field(rorm.types.VARCHAR(4095), not_null=True, comment='File disk storage path.')
 
 
-file_router = APIRouter()
-depend_sess_file = create_depend_sess('file')
-
-
-@file_router.post('/upload')
-async def upload(
-    file: Annotated[UploadFile, File()],
-    name: Annotated[str, Form()],
-    note: Annotated[str, Form()],
-    sess: Annotated[rorm.DatabaseORMSessionAsync, Depends(depend_sess_file)]
-):
-    """
-    Upload file.
-
-    Parameters
-    ----------
-    file : File instance.
-    note : File note.
-    sess : Asynchronous database session.
-    """
-
-    # Handle parameter.
-    file_store = FileStore(ServerConfig.server.api_file_dir)
-    file_bytes = await file.read()
-    file_md5 = get_md5(file_bytes)
-    file_size = len(file_bytes)
-
-    # Upload.
-    file_path = file_store.index(file_md5)
-
-    ## Data.
-    if file_path is None:
-        file_path = file_store.store(file_bytes)
-        table_data = DatabaseORMTableData(
-            md5=file_md5,
-            size=file_size,
-            path=file_path
-        )
-        await sess.add(table_data)
-
-    ## Information.
-    table_info = DatabaseORMTableInfo(
-        md5=file_md5,
-        name=name,
-        note=note
-    )
-    await sess.add(table_info)
-
-    # Get ID.
-    await sess.flush()
-    file_id = table_info.file_id
-
-    return {'file_id': file_id}
-
-
 def build_file_db() -> None:
     """
     Check and build `file` database tables.
@@ -226,3 +174,131 @@ def build_file_db() -> None:
 
     # Build.
     engine.sync_engine.build.build(tables=tables, views=views, views_stats=views_stats, skip=True)
+
+
+file_router = APIRouter()
+depend_file_sess = Bind.create_depend_db('file', 'sess')
+depend_file_conn = Bind.create_depend_db('file', 'conn')
+
+
+@file_router.post('/')
+async def upload_file(
+    file: Bind.File = Bind.forms,
+    name: str = Bind.forms_n,
+    note: str = Bind.forms_n,
+    sess: Bind.Sess = depend_file_sess
+) -> DatabaseORMTableInfo:
+    """
+    Upload file.
+
+    Parameters
+    ----------
+    file : File instance.
+    name : File name.
+    note : File note.
+
+    Returns
+    -------
+    File information.
+    """
+
+    # Handle parameter.
+    file_store = FileStore(ServerConfig.server.api_file_dir)
+    file_bytes = await file.read()
+    file_md5 = get_md5(file_bytes)
+    file_size = len(file_bytes)
+
+    # Upload.
+    file_path = file_store.index(file_md5)
+
+    ## Data.
+    if file_path is None:
+        file_path = file_store.store(file_bytes)
+        table_data = DatabaseORMTableData(
+            md5=file_md5,
+            size=file_size,
+            path=file_path
+        )
+        await sess.add(table_data)
+
+    ## Information.
+    table_info = DatabaseORMTableInfo(
+        md5=file_md5,
+        name=name,
+        note=note
+    )
+    await sess.add(table_info)
+
+    # Get ID.
+    await sess.flush()
+
+    return table_info
+
+
+@file_router.get('/{file_id}/download')
+async def download_file(
+    file_id: int = Bind.path,
+    conn: Bind.Conn = depend_file_conn
+) -> FileResponse:
+    """
+    Download file.
+
+    Parameters
+    ----------
+    file_id : File ID.
+
+    Returns
+    -------
+    File data.
+    """
+
+    # Search.
+    sql = (
+        'SELECT `name`, (\n'
+        '    SELECT `path`\n'
+        f'    FROM `{conn.engine.database}`.`data`\n'
+        f'    WHERE `md5` = `info`.`md5`\n'
+        '    LIMIT 1\n'
+        ') AS `path`\n'
+        f'FROM `{conn.engine.database}`.`info`\n'
+        'WHERE `file_id` = :file_id\n'
+        'LIMIT 1'
+    )
+    result = await conn.execute(sql, file_id=file_id)
+
+    # Check.
+    if result.empty:
+        raise ServerExitHTTP404("file ID '%s' not exist" % file_id)
+    file_name, file_path = result.first()
+
+    # Response.
+    response = FileResponse(file_path, filename=file_name)
+
+    return response
+
+
+@file_router.get('/{file_id}')
+async def get_file_info(
+    file_id: int = Bind.path,
+    sess: Bind.Sess = depend_file_sess
+) -> DatabaseORMTableInfo:
+    """
+    Get file information.
+
+    Parameters
+    ----------
+    file_id : File ID.
+
+    Returns
+    -------
+    File information.
+    """
+
+    # Get.
+    table_info = await sess.get(DatabaseORMTableInfo, file_id)
+
+    # Check.
+    if table_info is None:
+        raise ServerExitHTTP404("file ID '%s' not exist" % file_id)
+
+    return table_info

reyserver/rserver.py

@@ -9,15 +9,19 @@
 """
 
 
-from collections.abc import Sequence
+from typing import Literal
+from collections.abc import Sequence, Callable, Coroutine
 from inspect import iscoroutinefunction
 from uvicorn import run as uvicorn_run
-from fastapi import FastAPI, Depends
+from starlette.middleware.base import _StreamingResponse
+from fastapi import FastAPI, Request
 from fastapi.staticfiles import StaticFiles
+from fastapi.middleware.gzip import GZipMiddleware
+from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware
 from reydb import DatabaseAsync
-from reykit.rbase import CoroutineFunctionSimple, Singleton, throw
+from reykit.rbase import CallableT, CoroutineFunctionSimple, Singleton, throw
 
-from .rbase import ServerBase, ServerConfig, create_lifespan
+from .rbase import ServerBase, ServerConfig, Bind
 
 
 __all__ = (
@@ -42,31 +46,33 @@ class Server(ServerBase, Singleton):
         after: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
         ssl_cert: str | None = None,
         ssl_key: str | None = None,
+        debug: bool = False
     ) -> None:
         """
         Build instance attributes.
 
         Parameters
         ----------
-        db : Asynchronous database.
+        db : Asynchronous database, must include database engines with APIs.
         public : Public directory.
         depend : Global api dependencies.
         before : Execute before server start.
         after : Execute after server end.
         ssl_cert : SSL certificate file path.
         ssl_key : SSL key file path.
+        debug : Whether use development mode debug server.
         """
 
         # Parameter.
         if type(ssl_cert) != type(ssl_key):
             throw(AssertionError, ssl_cert, ssl_key)
-        lifespan = create_lifespan(before, after)
+        lifespan = Bind.create_lifespan(before, after)
         if depend is None:
             depend = ()
         elif iscoroutinefunction(depend):
             depend = (depend,)
         depend = [
-            Depends(task)
+            Bind.Depend(task)
             for task in depend
         ]
 
@@ -80,18 +86,57 @@ class Server(ServerBase, Singleton):
         self.app = FastAPI(
             dependencies=depend,
             lifespan=lifespan,
-            # debug=True
+            debug=debug
         )
 
-        ## Static.
         if public is not None:
             subapp = StaticFiles(directory=public, html=True)
             self.app.mount('/', subapp)
+        self.wrap_middleware = self.app.middleware('http')
+        'Decorator, add middleware to APP.'
 
-        ## API.
+        # Middleware
+        self.app.add_middleware(GZipMiddleware)
+        if not debug:
+            self.app.add_middleware(HTTPSRedirectMiddleware)
+        self.__add_default_middleware()
 
-        ### File.
+        # API.
         self.api_file_dir: str
+        'File API store directory path.'
+
+
+    def __add_default_middleware(self) -> None:
+        """
+        Add default handle middleware.
+        """
+
+        # Add.
+        @self.wrap_middleware
+        async def foo(
+            request: Request,
+            call_next: Callable[[Request], Coroutine[None, None, _StreamingResponse]]
+        ) -> _StreamingResponse:
+            """
+            Default handle middleware.
+
+            Parameters
+            ----------
+            Reqeust : Request instance.
+            call_next : Next middleware.
+            """
+
+            # Before.
+            ...
+
+            # Next.
+            response = await call_next(request)
+
+            # After.
+            if request.method == 'POST':
+                response.status_code = 201
+
+            return response
 
 
     def run(self) -> None:
@@ -107,16 +152,54 @@ class Server(ServerBase, Singleton):
         )
 
 
-    def add_api_base(self):
+    def set_doc(
+        self,
+        version: str | None = None,
+        title: str | None = None,
+        summary: str | None = None,
+        desc: str | None = None,
+        contact: dict[Literal['name', 'email', 'url'], str] | None = None
+    ) -> None:
+        """
+        Set server document.
+
+        Parameters
+        ----------
+        version : Server version.
+        title : Server title.
+        summary : Server summary.
+        desc : Server description.
+        contact : Server contact information.
+        """
+
+        # Parameter.
+        set_dict = {
+            'version': version,
+            'title': title,
+            'summary': summary,
+            'description': desc,
+            'contact': contact
+        }
+
+        # Set.
+        for key, value in set_dict.items():
+            if value is not None:
+                setattr(self.app, key, value)
+
+
+    def add_api_auth(self):
+        """
+        Add Authentication API.
+        Note: must include database engine of `auth` name.
+        """
 
-        @self.app.get('/test')
-        async def test():
-            return {'message': 'test'}
+        ...
 
 
     def add_api_file(self, file_dir: str = 'file') -> None:
         """
         Add file API.
+        Note: must include database engine of `file` name.
 
         Parameters
         ----------
@@ -131,4 +214,4 @@ class Server(ServerBase, Singleton):
 
         # Add.
         self.api_file_dir = file_dir
-        self.app.include_router(file_router, prefix='/file')
+        self.app.include_router(file_router, prefix='/files', tags=['file'])

{reyserver-1.1.45.dist-info → reyserver-1.1.47.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reyserver
-Version: 1.1.45
+Version: 1.1.47
 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: email-validator
 Requires-Dist: fastapi
 Requires-Dist: python-multipart
 Requires-Dist: reydb

reyserver-1.1.47.dist-info/RECORD

@@ -0,0 +1,11 @@
+reyserver/__init__.py,sha256=7GX64p7uI2eetJH9NJ-DTg-8iyQwOsGcviADFJCPxVA,373
+reyserver/rall.py,sha256=riyDRTUsigco_Bee1H4aZFb8IgvjnxdX9qcnVb9i9mE,270
+reyserver/rauth.py,sha256=QyY4gZ0ulpH9Kxvux_jnZBhzfWZZEuOWB1oYU9uzCnY,167
+reyserver/rbase.py,sha256=nJ0x4hm_YZN210quppSFu_6mRNKDLLNyS27jzSc0Yg8,5220
+reyserver/rclient.py,sha256=pTJtn78jPKgFo5EoQwZRdM0cYHdCs7QUKqfl-jUBRgk,4220
+reyserver/rfile.py,sha256=5ynG0LlJLdvNiuFBBBuZhT-0jf_1LxEzac55Q40bsk8,9086
+reyserver/rserver.py,sha256=hqpemzJHO6xHy_7pO3cvvjnfy8Yfqy8HfyIq4sjk4Dc,5889
+reyserver-1.1.47.dist-info/METADATA,sha256=gav3pRrTdUZXsbSxo-3JkNjlzhzhasdolU8iywyKQmc,1689
+reyserver-1.1.47.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reyserver-1.1.47.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reyserver-1.1.47.dist-info/RECORD,,

reyserver-1.1.45.dist-info/RECORD

@@ -1,10 +0,0 @@
-reyserver/__init__.py,sha256=JmDkcdP7oxmehE53rRRL_zhxmPinAbJRONpQp5qhsGI,340
-reyserver/rall.py,sha256=6vqacf9erEfVfK5sgGJMDXD1h4ebt5gDN7NrPdtELms,248
-reyserver/rbase.py,sha256=khBk6N0G33hstiisDWtz4Tdg1tvnFrGszOynBtnKxsI,2305
-reyserver/rclient.py,sha256=OjY_OEH_USrJK8TuCevXG6jNPVbM0lN-xMBozB7kSM8,2195
-reyserver/rfile.py,sha256=wf56tItty7Jbjcwvh1yMgcX2jlSSXAYbTDKnA5dI8Yw,7459
-reyserver/rserver.py,sha256=SfGs0W6StFtRtJ_UYI_avlL99euw7VvP55248mSOjLw,3387
-reyserver-1.1.45.dist-info/METADATA,sha256=N4nGN_EC1Czdd7Q5DIHr4mxM3NNiPQCgjDenIZJ25yg,1658
-reyserver-1.1.45.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reyserver-1.1.45.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reyserver-1.1.45.dist-info/RECORD,,