reyserver 1.1.66__py3-none-any.whl → 1.1.68__py3-none-any.whl

reyserver/rbase.py

@@ -11,8 +11,8 @@
 
 from typing import Literal, Type, NoReturn, overload
 from http import HTTPStatus
-from fastapi import APIRouter
-from fastapi import HTTPException, Request, UploadFile as File
+from fastapi import FastAPI, APIRouter, Request, UploadFile, HTTPException
+from fastapi.responses import HTMLResponse, FileResponse
 from fastapi.params import (
     Depends,
     Path,
@@ -26,6 +26,7 @@ from fastapi.params import (
 from reydb.rconn import DatabaseConnectionAsync
 from reydb.rorm import DatabaseORMSessionAsync
 from reykit.rbase import Base, Exit, StaticMeta, Singleton, throw
+from reykit.ros import File, Folder
 
 from . import rserver
 
@@ -40,7 +41,9 @@ __all__ = (
     'ServerBindInstanceDatabaseSession',
     'ServerBindInstance',
     'ServerBind',
-    'Bind'
+    'Bind',
+    'router_test',
+    'router_public'
 )
 
 
@@ -311,6 +314,26 @@ class ServerBindInstance(ServerBase, Singleton):
         return forms
 
 
+async def depend_server(request: Request) -> 'rserver.Server':
+    """
+    Dependencie function of now Server instance.
+
+    Parameters
+    ----------
+    request : Request.
+
+    Returns
+    -------
+    Server.
+    """
+
+    # Get.
+    app: FastAPI = request.app
+    server: rserver.Server = app.extra['server']
+
+    return server
+
+
 class ServerBind(ServerBase, metaclass=StaticMeta):
     """
     Server API bind parameter type.
@@ -332,15 +355,15 @@ class ServerBind(ServerBase, metaclass=StaticMeta):
     'Request body form parameter dependency type.'
     Forms = Forms
     'Request body multiple forms parameter dependency type.'
-    File = File
-    'Verify file type.'
+    File = UploadFile
+    'Type hints file type.'
     Depend = Depends
     'Dependency type.'
     Conn = DatabaseConnectionAsync
     Sess = DatabaseORMSessionAsync
     Server = Type['rserver.Server']
     'Server type.'
-    server: Depend
+    server: Depend = Depend(depend_server)
     'Server instance dependency type.'
     i = ServerBindInstance()
     'Server API bind parameter build instance.'
@@ -353,11 +376,11 @@ class ServerBind(ServerBase, metaclass=StaticMeta):
 
 
 Bind = ServerBind
+router_test = APIRouter()
+router_public = APIRouter()
 
-router_base = APIRouter()
 
-
-@router_base.get('/test')
+@router_test.get('/test')
 def test() -> Literal['test']:
     """
     Test.
@@ -373,8 +396,8 @@ def test() -> Literal['test']:
     return response
 
 
-@router_base.post('/test/echo')
-def echo(data: dict = Bind.i.body) -> dict:
+@router_test.post('/test/echo')
+def test_echo(data: dict = Bind.i.body) -> dict:
     """
     Echo test.
 
@@ -390,3 +413,41 @@ def echo(data: dict = Bind.i.body) -> dict:
     # Resposne.
 
     return data
+
+
+@router_public.get('/')
+def home(server: Bind.Server = Bind.server) -> HTMLResponse:
+    """
+    Home page.
+
+    Parameters
+    ----------
+    Home page HTML content.
+    """
+
+    # Parameter.
+    public_dir = server.api_public_dir
+    file_path = Folder(public_dir) + 'index.html'
+    file = File(file_path)
+
+    # Response.
+    response = HTMLResponse(file.str)
+
+    return response
+
+
+@router_public.get('/public/{relpath}')
+def get_public_file(relpath: str = Bind.i.path) -> FileResponse:
+    """
+    Get public file.
+
+    Parameters
+    ----------
+    relpath : Relative path of based on public directory.
+
+    Returns
+    -------
+    File.
+    """
+
+    ...

reyserver/rserver.py

@@ -19,6 +19,7 @@ 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.trustedhost import TrustedHostMiddleware
 from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware
 from reydb import DatabaseAsync
 from reykit.rbase import CoroutineFunctionSimple, Singleton, throw
@@ -42,14 +43,12 @@ class Server(ServerBase, Singleton):
 
     def __init__(
         self,
-        db: DatabaseAsync,
-        public: str | None = None,
+        db: DatabaseAsync | None = None,
+        db_warm: bool = False,
         depend: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
         before: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
         after: CoroutineFunctionSimple | Sequence[CoroutineFunctionSimple] | None = None,
-        ssl_cert: str | None = None,
-        ssl_key: str | None = None,
-        db_warm: bool = False,
+        to_https: bool = False,
         debug: bool = False
     ) -> None:
         """
@@ -58,19 +57,15 @@ class Server(ServerBase, Singleton):
         Parameters
         ----------
         db : Asynchronous database, must include database engines with APIs.
-        public : Public directory.
+        db_warm : Whether database pre create connection to warm all pool.
         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.
-        db_warm : Whether database pre create connection to warm all pool.
+        to_https : Whehter redirect http to https.
         debug : Whether use development mode debug server.
         """
 
         # Parameter.
-        if type(ssl_cert) != type(ssl_key):
-            throw(AssertionError, ssl_cert, ssl_key)
         if depend is None:
             depend = ()
         elif iscoroutinefunction(depend):
@@ -83,8 +78,6 @@ class Server(ServerBase, Singleton):
 
         # Build.
         self.db = db
-        self.ssl_cert = ssl_cert
-        self.ssl_key = ssl_key
         self.app = FastAPI(
             dependencies=depend,
             lifespan=lifespan,
@@ -92,22 +85,20 @@ class Server(ServerBase, Singleton):
             server=self
         )
 
-        # Public file.
-        if public is not None:
-            subapp = StaticFiles(directory=public, html=True)
-            self.app.mount('/', subapp)
-
         # Middleware
         self.wrap_middleware = self.app.middleware('http')
         'Decorator, add middleware to APP.'
         self.app.add_middleware(GZipMiddleware)
-        if not debug:
+        self.app.add_middleware(TrustedHostMiddleware)
+        if to_https:
             self.app.add_middleware(HTTPSRedirectMiddleware)
         self.__add_base_middleware()
 
         # API.
         self.is_started_auth: bool = False
         'Whether start authentication.'
+        self.api_public_dir: str
+        'Public directory.'
         self.api_auth_key: str
         'Authentication API JWT encryption key.'
         self.api_auth_sess_seconds: int
@@ -241,7 +232,9 @@ class Server(ServerBase, Singleton):
         host: str = '127.0.0.1',
         port: int = 8000,
         app: str | None = None,
-        workers: int = 1
+        workers: int = 1,
+        ssl_cert: str | None = None,
+        ssl_key: str | None = None
     ) -> None:
         """
         Run server.
@@ -255,6 +248,8 @@ class Server(ServerBase, Singleton):
             - `Application`: format is `module[.sub....]:var[.attr....]` (e.g. `module.sub:server.app`).
             - `Function`: format is `module[.sub....]:func` (e.g. `module.sub:main`).
         workers: Number of server work processes.
+        ssl_cert : SSL certificate file path.
+        ssl_key : SSL key file path.
 
         Examples
         --------
@@ -269,6 +264,8 @@ class Server(ServerBase, Singleton):
         """
 
         # Parameter.
+        if type(ssl_cert) != type(ssl_key):
+            throw(AssertionError, ssl_cert, ssl_key)
         if app is None:
             app = self.app
         if workers == 1:
@@ -280,8 +277,8 @@ class Server(ServerBase, Singleton):
             host=host,
             port=port,
             workers=workers,
-            ssl_certfile=self.ssl_cert,
-            ssl_keyfile=self.ssl_key
+            ssl_certfile=ssl_cert,
+            ssl_keyfile=ssl_key
         )
 
 
@@ -323,15 +320,34 @@ class Server(ServerBase, Singleton):
                 setattr(self.app, key, value)
 
 
-    def add_api_base(self) -> None:
+    def add_api_test(self) -> None:
+        """
+        Add test API.
+        """
+
+        from .rbase import router_test
+
+        # Add.
+        self.app.include_router(router_test, tags=['test'])
+
+
+    def add_api_public(self, path: str) -> None:
         """
-        Add base API.
+        Add public API,
+        mapping `{path}/index.html` to 'GET /',
+        mapping `{path}/{sub_path}` to `GET /public/{sub_path}`.
+
+        Parameters
+        path : Public directory.
         """
 
-        from .rbase import router_base
+        from .rbase import router_public
 
         # Add.
-        self.app.include_router(router_base, tags=['test'])
+        self.api_public_dir = path
+        self.app.include_router(router_public, tags=['public'])
+        subapp = StaticFiles(directory=path)
+        self.app.mount('/public', subapp)
 
 
     def add_api_auth(self, key: str | None = None, sess_seconds: int = 28800) -> None:
@@ -388,25 +404,4 @@ class Server(ServerBase, Singleton):
         self.app.include_router(router_file, tags=['file'], dependencies=(Bind.token,))
 
 
-async def depend_server(request: Request) -> Server:
-    """
-    Dependencie function of now Server instance.
-
-    Parameters
-    ----------
-    request : Request.
-
-    Returns
-    -------
-    Server.
-    """
-
-    # Get.
-    app: FastAPI = request.app
-    server = app.extra['server']
-
-    return server
-
-
 Bind.Server = Server
-Bind.server = Bind.Depend(depend_server)

{reyserver-1.1.66.dist-info → reyserver-1.1.68.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reyserver
-Version: 1.1.66
+Version: 1.1.68
 Summary: Backend server method set.
 Project-URL: homepage, https://github.com/reyxbo/reyserver/
 Author-email: Rey <reyxbo@163.com>

{reyserver-1.1.66.dist-info → reyserver-1.1.68.dist-info}/RECORD

@@ -1,11 +1,11 @@
 reyserver/__init__.py,sha256=7GX64p7uI2eetJH9NJ-DTg-8iyQwOsGcviADFJCPxVA,373
 reyserver/rall.py,sha256=riyDRTUsigco_Bee1H4aZFb8IgvjnxdX9qcnVb9i9mE,270
 reyserver/rauth.py,sha256=mqyo5FsN4vdW5GRgvZssWcpfku1Dfo_Md8vvoo8JzhU,15122
-reyserver/rbase.py,sha256=0ECJ1zuUpJhwaNc0u5GvR5VyGxIAnKQep-EdotwnLoE,7752
+reyserver/rbase.py,sha256=OKXZ_VOfPEVgO3oVn6j-pqHjnIbDL0UoZtp8GcN9hzw,8990
 reyserver/rclient.py,sha256=og5YuWm-PODkFn9njBwYQpGlk0j1BfqFuEarlCFSQYI,6229
 reyserver/rfile.py,sha256=6H5_7B9aiA3F56VToQDI9Trarkrl9gcIuFqYyCVCiCU,8877
-reyserver/rserver.py,sha256=3l6NoAfogeYli5lgHRfLpC9q5k7pwRCiacjN8Yt4fso,11199
-reyserver-1.1.66.dist-info/METADATA,sha256=njJDT00gu53ZHN4sFnbN29vl8qPli9hSvAyfP8bgJo4,1666
-reyserver-1.1.66.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reyserver-1.1.66.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reyserver-1.1.66.dist-info/RECORD,,
+reyserver/rserver.py,sha256=L_a92THAZHca1WHdGczoRf-rnIw5-aGcFuAfvhd5r9w,11332
+reyserver-1.1.68.dist-info/METADATA,sha256=9zPRRCTex-TayU1dBN7HqLvmTtKUwTgfwmflXJo0uK4,1666
+reyserver-1.1.68.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reyserver-1.1.68.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reyserver-1.1.68.dist-info/RECORD,,