reyserver 1.1.61__py3-none-any.whl → 1.1.63__py3-none-any.whl

reyserver/rauth.py

@@ -11,9 +11,7 @@
 
 from typing import Any, TypedDict, NotRequired, Literal
 from datetime import datetime as Datetime
-from re import PatternError
 from fastapi import APIRouter, Request
-from fastapi.params import Depends
 from fastapi.security import OAuth2PasswordBearer
 from reydb import rorm, DatabaseEngine, DatabaseEngineAsync
 from reykit.rdata import encode_jwt, decode_jwt, is_hash_bcrypt
@@ -34,8 +32,8 @@ __all__ = (
 )
 
 
-UserInfo = TypedDict(
-    'UserInfo',
+UserData = TypedDict(
+    'UserData',
     {
         'create_time': float,
         'udpate_time': float,
@@ -50,19 +48,19 @@ UserInfo = TypedDict(
         'password': NotRequired[str]
     }
 )
-TokenInfo = TypedDict(
-    'TokenInfo',
+TokenData = TypedDict(
+    'TokenData',
     {
         'sub': int,
         'iat': int,
         'nbf': int,
         'exp': int,
-        'user': UserInfo
+        'user': UserData
     }
 )
 Token = str
-ResponseToken = TypedDict(
-    'ResponseToken',
+JSONToken = TypedDict(
+    'JSONToken',
     {
         'access_token': Token,
         'token_type': Literal['Bearer']
@@ -241,19 +239,19 @@ def build_db_auth(engine: DatabaseEngine | DatabaseEngineAsync) -> None:
 
 bearer = OAuth2PasswordBearer(
     tokenUrl='/token',
-    scheme_name='RBACBearer',
-    description='Global authentication of based on RBAC model and Bearer framework.',
+    scheme_name='OAuth2Password',
+    description='Authentication of OAuth2 password model.',
     auto_error=False
 )
 
 
-async def depend_auth(
+async def depend_token(
     request: Request,
     server: Bind.Server = Bind.server,
-    token: Token | None = Depends(bearer)
-) -> UserInfo:
+    token: Token | None = Bind.Depend(bearer)
+) -> TokenData:
     """
-    Dependencie function of authentication.
+    Dependencie function of authentication token.
     If the verification fails, then response status code is 401 or 403.
 
     Parameters
@@ -264,7 +262,7 @@ async def depend_auth(
 
     Returns
     -------
-    User information
+    Token data.
     """
 
     # Check.
@@ -278,18 +276,17 @@ async def depend_auth(
     api_path = f'{request.method} {request.url.path}'
 
     # Cache.
-    user: UserInfo | None = getattr(request.state, 'user', None)
+    token_data: UserData | None = getattr(request.state, 'token_data', None)
 
     # Decode.
-    if user is None:
-        json: TokenInfo | None = decode_jwt(token, key)
-        if json is None:
+    if token_data is None:
+        token_data: TokenData | None = decode_jwt(token, key)
+        if token_data is None:
             exit_api(401)
-        user = json['user']
-        request.state.user = user
+        request.state.token_data = token_data
 
     # Authentication.
-    perm_apis = json['user']['perm_apis']
+    perm_apis = token_data['user']['perm_apis']
     perm_apis = [
         f'^{pattern}$'
         for pattern in perm_apis
@@ -298,20 +295,22 @@ async def depend_auth(
     if result is None:
         exit_api(403)
 
-    return user
+    return token_data
 
 
+Bind.token = Bind.Depend(depend_token)
+
 router_auth = APIRouter()
 
 
-async def get_user_info(
+async def get_user_data(
     conn: Bind.Conn,
     account: str,
-    account_type: Literal['name', 'email', 'phone'],
+    account_type: Literal['user_id', 'name', 'email', 'phone'] = 'name',
     filter_invalid: bool = True
-) -> UserInfo | None:
+) -> UserData | None:
     """
-    Get user information.
+    Get user data.
 
     Parameters
     ----------
@@ -325,7 +324,7 @@ async def get_user_info(
 
     Returns
     -------
-    User information or null.
+    User data or null.
     """
 
     # Parameters.
@@ -356,6 +355,7 @@ async def get_user_info(
         '    SELECT `create_time`, `update_time`, `user_id`, `password`, `name`, `email`, `phone`, `avatar`\n'
         '    FROM `test`.`user`\n'
         f'{sql_where}'
+        '    LIMIT 1\n'
         ') as `user`\n'
         'LEFT JOIN (\n'
         '    SELECT `user_id`, `role_id`\n'
@@ -389,7 +389,7 @@ async def get_user_info(
         info = None
     else:
         row: dict[str, Datetime | Any] = result.to_row()
-        info: UserInfo = {
+        info: UserData = {
             'create_time': row['create_time'].timestamp(),
             'udpate_time': row['update_time'].timestamp(),
             'user_id': row['user_id'],
@@ -412,9 +412,9 @@ async def create_sessions(
     password: str = Bind.i.form,
     conn: Bind.Conn = Bind.conn.auth,
     server: Bind.Server = Bind.server
-) -> ResponseToken:
+) -> JSONToken:
     """
-    Create session.
+    Create token.
 
     Parameters
     ----------
@@ -430,25 +430,25 @@ async def create_sessions(
     key = server.api_auth_key
     sess_seconds = server.api_auth_sess_seconds
 
-    # User information.
-    info = await get_user_info(conn, username)
+    # User data.
+    user_data = await get_user_data(conn, username)
 
     # Check.
-    if info is None:
+    if user_data is None:
         exit_api(401)
-    password_hash = info.pop('password')
+    password_hash = user_data.pop('password')
     if not is_hash_bcrypt(password, password_hash):
         exit_api(401)
 
     # Response.
     now_timestamp_s = now('timestamp_s')
-    user_id = info.pop('user_id')
-    data: TokenInfo = {
+    user_id = user_data.pop('user_id')
+    data: TokenData = {
         'sub': str(user_id),
         'iat': now_timestamp_s,
         'nbf': now_timestamp_s,
         'exp': now_timestamp_s + sess_seconds,
-        'user': info
+        'user': user_data
     }
     token = encode_jwt(data, key)
     response = {

reyserver/rbase.py

@@ -9,9 +9,9 @@
 """
 
 
-from typing import Type, NoReturn, overload
+from typing import Literal, Type, NoReturn, overload
 from http import HTTPStatus
-from fastapi import FastAPI
+from fastapi import APIRouter
 from fastapi import HTTPException, Request, UploadFile as File
 from fastapi.params import (
     Depends,
@@ -24,7 +24,7 @@ from fastapi.params import (
     File as Forms
 )
 from reydb.rconn import DatabaseConnectionAsync
-from reydb.rorm import DatabaseORMModel, DatabaseORMSessionAsync
+from reydb.rorm import DatabaseORMSessionAsync
 from reykit.rbase import Base, Exit, StaticMeta, Singleton, throw
 
 from . import rserver
@@ -311,49 +311,82 @@ 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 = app.extra['server']
-
-    return server
-
-
 class ServerBind(ServerBase, metaclass=StaticMeta):
     """
     Server API bind parameter type.
     """
 
     Request = Request
+    'Reqeust instance dependency type.'
     Path = Path
+    'URL source path dependency type.'
     Query = Query
+    'URL query parameter dependency type.'
     Header = Header
+    'Request header parameter dependency type.'
     Cookie = Cookie
+    'Request header cookie parameter dependency type.'
     Body = Body
+    'Request body JSON parameter dependency type.'
     Form = Form
+    'Request body form parameter dependency type.'
     Forms = Forms
+    'Request body multiple forms parameter dependency type.'
     File = File
+    'Verify file type.'
     Depend = Depends
-    JSON = DatabaseORMModel
+    'Dependency type.'
     Conn = DatabaseConnectionAsync
     Sess = DatabaseORMSessionAsync
     Server = Type['rserver.Server']
-    server = Depends(depend_server)
+    'Server type.'
+    server: Depend
+    'Server instance dependency type.'
     i = ServerBindInstance()
+    'Server API bind parameter build instance.'
     conn = ServerBindInstanceDatabaseConnection()
+    'Server API bind parameter asynchronous database connection.'
     sess = ServerBindInstanceDatabaseSession()
+    'Server API bind parameter asynchronous database session.'
+    token: Depend
+    'Server authentication token dependency type.'
 
 
 Bind = ServerBind
+
+router_base = APIRouter()
+
+
+@router_base.get('/test')
+def test() -> Literal['test']:
+    """
+    Test.
+
+    Returns
+    -------
+    Text `test`.
+    """
+
+    # Resposne.
+    response = 'test'
+
+    return response
+
+
+@router_base.post('/test/echo')
+def echo(data: dict = Bind.i.body) -> dict:
+    """
+    Echo test.
+
+    Paremeters
+    ----------
+    data : Echo data.
+
+    Returns
+    -------
+    Echo data.
+    """
+
+    # Resposne.
+
+    return data

reyserver/rclient.py

@@ -84,7 +84,7 @@ class ServerClient(ServerBase):
         # Request.
         response = request(url, data=data, check=True)
         response_dict = response.json()
-        token = response_dict['token']
+        token = response_dict['access_token']
 
         return token
 

reyserver/rserver.py

@@ -9,7 +9,7 @@
 """
 
 
-from typing import Any, Literal, Type
+from typing import Literal
 from collections.abc import Sequence, Callable, Coroutine
 from inspect import iscoroutinefunction
 from contextlib import asynccontextmanager, _AsyncGeneratorContextManager
@@ -19,7 +19,7 @@ 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 rorm, DatabaseAsync, DatabaseEngineAsync
+from reydb import DatabaseAsync
 from reykit.rbase import CoroutineFunctionSimple, Singleton, throw
 from reykit.rrand import randchar
 
@@ -216,16 +216,50 @@ class Server(ServerBase, Singleton):
             return response
 
 
-    def run(self) -> None:
+    def run(
+        self,
+        host: str = '127.0.0.1',
+        port: int = 1024,
+        app: str | None = None,
+        workers: int = 1
+    ) -> None:
         """
         Run server.
+
+        Parameters
+        ----------
+        host : Server host.
+        port: Server port.
+        app : Application path, format is `Module[.Sub....]:Variable[.Attributre....]` (e.g. `module.sub:server.app`).
+            - `None`: Cannot use parameter `workers`.
+        workers: Number of server work processes.
+
+        Examples
+        --------
+        >>> server = Server(db)
+
+        Single work process.
+        >>> server.run()
+
+        Multiple work processes.
+        >>> server = Server(db)
+        >>> if __name__ == '__main__':
+        >>>     server('module.sub:server.app')
         """
 
+        # Parameter.
+        if app is None:
+            app = self.app
+
         # Run.
         uvicorn_run(
-            self.app,
+            app,
+            host=host,
+            port=port,
+            workers=workers,
             ssl_certfile=self.ssl_cert,
-            ssl_keyfile=self.ssl_key
+            ssl_keyfile=self.ssl_key,
+            # factory=True
         )
 
 
@@ -272,29 +306,10 @@ class Server(ServerBase, Singleton):
         Add base API.
         """
 
-        from fastapi import Depends, Form
-        from time import time
-
-        form = Form()
-        def func():
-            return int(time())
-        depend = Depends(func)
-        @self.app.get('/test')
-        async def test(a: int = form, b: int = form) -> str:
-            print(a, b)
-            return 'test'
-        @self.app.get('/test1')
-        async def test1(a: int = depend, b: int = depend) -> str:
-            print(a, b)
-            return 'test'
-        @self.app.get('/test2')
-        async def test2(a: int = form, b: int = depend) -> str:
-            print(a, b)
-            return 'test'
-        @self.app.get('/test3')
-        async def test3(a: int = form, b: int = depend) -> str:
-            print(a, b)
-            return 'test'
+        from .rbase import router_base
+
+        # Add.
+        self.app.include_router(router_base, tags=['test'])
 
 
     def add_api_auth(self, key: str | None = None, sess_seconds: int = 28800) -> None:
@@ -338,7 +353,6 @@ class Server(ServerBase, Singleton):
         file_dir : File API store directory path.
         """
 
-        from .rauth import depend_auth
         from .rfile import build_db_file, router_file
 
         # Database.
@@ -349,4 +363,28 @@ class Server(ServerBase, Singleton):
 
         # Add.
         self.api_file_dir = file_dir
-        self.app.include_router(router_file, tags=['file'])
+        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.61.dist-info → reyserver-1.1.63.dist-info}/METADATA

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

reyserver-1.1.63.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=JGo5lLTRGoP1SFPyQA-Q5EE-O3OU_86Mb3pvwhvFu-w,15125
+reyserver/rbase.py,sha256=0ECJ1zuUpJhwaNc0u5GvR5VyGxIAnKQep-EdotwnLoE,7752
+reyserver/rclient.py,sha256=og5YuWm-PODkFn9njBwYQpGlk0j1BfqFuEarlCFSQYI,6229
+reyserver/rfile.py,sha256=6H5_7B9aiA3F56VToQDI9Trarkrl9gcIuFqYyCVCiCU,8877
+reyserver/rserver.py,sha256=sSFoWTnsSRBJ9SZT5i6yzMzDnwg0_YFbSUI7e_8QfiA,10465
+reyserver-1.1.63.dist-info/METADATA,sha256=de-VXiY3vj5atn-pdBUX0zz6FFg_7hWVJV_JEABCnTw,1666
+reyserver-1.1.63.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reyserver-1.1.63.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reyserver-1.1.63.dist-info/RECORD,,

reyserver-1.1.61.dist-info/RECORD

@@ -1,11 +0,0 @@
-reyserver/__init__.py,sha256=7GX64p7uI2eetJH9NJ-DTg-8iyQwOsGcviADFJCPxVA,373
-reyserver/rall.py,sha256=riyDRTUsigco_Bee1H4aZFb8IgvjnxdX9qcnVb9i9mE,270
-reyserver/rauth.py,sha256=hXI21VrZ_sDrFZzd982ENymFJfPWi6U1XHmGmiglez0,15103
-reyserver/rbase.py,sha256=kzSbo6yoPlWquR6XiseTKi5hEbllaG3qVmmwnnKKac0,6898
-reyserver/rclient.py,sha256=a07zHDUH4Y3f-WdAXMX7Wq9PocwvlrDfdIl2s-M4IWo,6222
-reyserver/rfile.py,sha256=6H5_7B9aiA3F56VToQDI9Trarkrl9gcIuFqYyCVCiCU,8877
-reyserver/rserver.py,sha256=mrtsYu8wsxJmctmh2qWfwD9l70gOZq57UrKcDJ9EAVM,9856
-reyserver-1.1.61.dist-info/METADATA,sha256=IghNj6ce-pWACkbexwa3jvtkMx0lc8hto2XGWhWtWyo,1666
-reyserver-1.1.61.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reyserver-1.1.61.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reyserver-1.1.61.dist-info/RECORD,,