reyserver 1.1.56__py3-none-any.whl → 1.1.57__py3-none-any.whl

reyserver/__init__.py

@@ -9,6 +9,7 @@
 
 Modules
 -------
+radmin : Admin methods.
 rall : All methods.
 rauth : Authentication methods.
 rbase : Base methods.

reyserver/radmin.py

@@ -0,0 +1,128 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+@Time    : 2025-10-14
+@Author  : Rey
+@Contact : reyxbo@163.com
+@Explain : Admin methods.
+"""
+
+
+from typing import Any, Type
+from collections.abc import Sequence
+from sqlalchemy.ext.asyncio import async_sessionmaker
+from sqladmin import Admin, ModelView
+from reydb import DatabaseEngineAsync, rorm
+from reykit.rbase import Singleton
+
+from .rbase import ServerBase
+from . import rserver
+
+
+__all__ = (
+    'ServerAdminModel',
+    'ServerAdminModelView',
+    'ServerAdminModelViewStats'
+)
+
+
+class ServerAdminModel(ModelView):
+    """
+    Server admin model type.
+    """
+
+
+class ServerAdminModelView(ServerAdminModel):
+    """
+    Server admin view model type.
+    """
+
+    category = 'View'
+    can_view_details = can_edit = can_create = can_delete = False
+
+
+class ServerAdminModelViewStats(ServerAdminModelView):
+    """
+    Server admin stats view model type.
+    """
+
+    column_list = ['item', 'value', 'comment']
+
+
+class ServerAdmin(ServerBase, Singleton):
+    """
+    Server admin type, singleton mode.
+    """
+
+
+    def __init__(self, server: 'rserver.Server') -> None:
+        """
+        Build instance attributes.
+
+        Parameters
+        ----------
+        server : Server.
+        """
+
+        # Build.
+        self.server = server
+
+        ## Admin.
+        self.api_admin_binds: dict[ServerAdminModel, DatabaseEngineAsync] = {}
+        'Admin API model bind database engine dictionary.'
+        Session = async_sessionmaker()
+        Session.configure(binds=self.api_admin_binds)
+        self.admin = Admin(self.server.app, session_maker=Session)
+
+
+    def add_model(
+        self,
+        model: Type[ServerAdminModel] | type[rorm.Model],
+        engine: DatabaseEngineAsync | str = None,
+        label: str | None = None,
+        name: str | None = None,
+        column: str | Sequence[str] | None = None,
+        **attrs: Any
+    ) -> None:
+        """
+        Add admin model type.
+
+        Parameters
+        ----------
+        model : Model type.
+            - `type[rorm.Model]`: Define as `ServerAdminModel`.
+        engine : Database engine or name.
+        label : Admin model class label.
+        name : Admin model name.
+        column : Admin model display column names.
+        attrs : Other admin model attributes.
+        """
+
+        # Parameter.
+        if issubclass(model, rorm.Model):
+            class ServerAdminModel_(ServerAdminModel, model=model): ...
+            model = ServerAdminModel_
+        if type(engine) == str:
+            engine = self.server.db[engine]
+        if label is not None:
+            model.category = label
+        if name is not None:
+            model.name = model.name_plural = name
+        if type(column) == str:
+            column = [column]
+        if column is not None:
+            model.column_list = list(column)
+        for key, value in attrs.items():
+            setattr(model, key, value)
+
+        # Add.
+        self.api_admin_binds[model.model] = engine.engine
+        self.admin.add_view(model)
+
+
+# Simple path.
+
+## Server admin model type.
+View = ServerAdminModelView
+ViewStats = ServerAdminModelViewStats

reyserver/rall.py

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

reyserver/rauth.py

@@ -14,7 +14,7 @@ from datetime import datetime as Datetime
 from fastapi import APIRouter, Request
 from reydb import rorm, DatabaseEngine, DatabaseEngineAsync
 from reykit.rdata import encode_jwt, is_hash_bcrypt
-from reykit.rtime import now, time_to
+from reykit.rtime import now
 
 from .rbase import ServerConfig, Bind, exit_api
 
@@ -74,7 +74,10 @@ class DatabaseORMTablePerm(rorm.Table):
     perm_id: int = rorm.Field(rorm.types_mysql.SMALLINT(unsigned=True), key_auto=True, comment='Permission ID.')
     name: str = rorm.Field(rorm.types.VARCHAR(50), not_null=True, index_u=True, comment='Permission name.')
     desc: str = rorm.Field(rorm.types.VARCHAR(500), comment='Permission description.')
-    api: str = rorm.Field(rorm.types.VARCHAR(1000), comment='API resource path regular expression "match" pattern.')
+    api: str = rorm.Field(
+        rorm.types.VARCHAR(1000),
+        comment=r'API method and resource path regular expression "match" pattern, case insensitive, format is "{method} {path}" (e.g. "GET /users").'
+    )
 
 
 class DatabaseORMTableUserRole(rorm.Table):

reyserver/rbase.py

@@ -11,7 +11,7 @@
 
 from typing import NoReturn, overload
 from http import HTTPStatus
-from fastapi import HTTPException, UploadFile as File
+from fastapi import HTTPException, Request, UploadFile as File
 from fastapi.params import (
     Depends,
     Path,
@@ -148,13 +148,13 @@ class ServerBindInstanceDatabaseSuper(ServerBase):
 
 class ServerBindInstanceDatabaseConnection(ServerBindInstanceDatabaseSuper, Singleton):
     """
-    Server API bind parameter build database connection instance type.
+    Server API bind parameter build database connection instance type, singleton mode.
     """
 
 
 class ServerBindInstanceDatabaseSession(ServerBindInstanceDatabaseSuper, Singleton):
     """
-    Server API bind parameter build database session instance type.
+    Server API bind parameter build database session instance type, singleton mode.
     """
 
 
@@ -325,7 +325,7 @@ class ServerBind(ServerBase, metaclass=StaticMeta):
     Server API bind parameter type.
     """
 
-    Depend = Depends
+    Request = Request
     Path = Path
     Query = Query
     Header = Header
@@ -334,6 +334,7 @@ class ServerBind(ServerBase, metaclass=StaticMeta):
     Form = Form
     Forms = Forms
     File = File
+    Depend = Depends
     JSON = DatabaseORMModel
     Conn = DatabaseConnectionAsync
     Sess = DatabaseORMSessionAsync

reyserver/rclient.py

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

reyserver/rserver.py

@@ -9,7 +9,7 @@
 """
 
 
-from typing import Literal
+from typing import Any, Literal, Type
 from collections.abc import Sequence, Callable, Coroutine
 from inspect import iscoroutinefunction
 from contextlib import asynccontextmanager, _AsyncGeneratorContextManager
@@ -19,11 +19,12 @@ 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 reydb import rorm, DatabaseAsync, DatabaseEngineAsync
 from reykit.rbase import CoroutineFunctionSimple, Singleton, throw
 from reykit.rrand import randchar
 
 from .rbase import ServerBase, ServerConfig, Bind
+from . import radmin
 
 
 __all__ = (
@@ -261,6 +262,46 @@ class Server(ServerBase, Singleton):
                 setattr(self.app, key, value)
 
 
+    def add_api_admin(self) -> None:
+        """
+        Add admin API.
+        """
+
+        # Add.
+        self.admin = radmin.ServerAdmin(self)
+
+
+    def add_admin_model(
+        self,
+        model: Type['radmin.ServerAdminModel'] | type[rorm.Model],
+        engine: DatabaseEngineAsync | str = None,
+        label: str | None = None,
+        name: str | None = None,
+        column: str | Sequence[str] | None = None,
+        **attrs: Any
+    ) -> None:
+        """
+        Add admin model type.
+
+        Parameters
+        ----------
+        model : Model type.
+            - `type[rorm.Model]`: Define as `ServerAdminModel`.
+        engine : Database engine or name.
+        label : Admin model class label.
+        name : Admin model name.
+        column : Admin model display column names.
+        attrs : Other admin model attributes.
+        """
+
+        # Check.
+        if not hasattr(self, 'admin'):
+            return
+
+        # Add.
+        self.admin.add_model(model, engine, label, name, column, **attrs)
+
+
     def add_api_auth(self, key: str | None = None, sess_seconds: int = 28800) -> None:
         """
         Add authentication API.
@@ -273,13 +314,23 @@ class Server(ServerBase, Singleton):
         sess_seconds : Session valid seconds.
         """
 
-        from .rauth import build_auth_db, auth_router
+        from .rauth import (
+            build_auth_db,
+            auth_router,
+            DatabaseORMTableUser,
+            DatabaseORMTableRole,
+            DatabaseORMTablePerm,
+            DatabaseORMTableUserRole,
+            DatabaseORMTableRolePerm
+        )
 
         # Parameter.
         if key is None:
             key = randchar(32)
 
-        # Build database.
+        # Database.
+        if 'auth' not in self.db:
+            throw(AssertionError, self.db)
         engine = self.db.auth
         build_auth_db(engine)
 
@@ -288,6 +339,13 @@ class Server(ServerBase, Singleton):
         self.api_auth_sess_seconds = sess_seconds
         self.app.include_router(auth_router, tags=['auth'])
 
+        ## Admin.
+        self.add_admin_model(DatabaseORMTableUser, engine, category='auth', name='User', column_list=['user_id', 'name'])
+        self.add_admin_model(DatabaseORMTableRole, engine, category='auth', name='Role', column_list=['role_id', 'name'])
+        self.add_admin_model(DatabaseORMTablePerm, engine, category='auth', name='Perm', column_list=['perm_id', 'name'])
+        self.add_admin_model(DatabaseORMTableUserRole, engine, category='auth', name='User Role')
+        self.add_admin_model(DatabaseORMTableRolePerm, engine, category='auth', name='Role Perm')
+
 
     def add_api_file(self, file_dir: str = 'file') -> None:
         """
@@ -300,12 +358,23 @@ class Server(ServerBase, Singleton):
         prefix : File API path prefix.
         """
 
-        from .rfile import build_file_db, file_router
+        from .rfile import (
+            build_file_db,
+            file_router,
+            DatabaseORMTableInfo,
+            DatabaseORMTableData
+        )
 
-        # Build database.
+        # Database.
+        if 'file' not in self.db:
+            throw(AssertionError, self.db)
         engine = self.db.file
         build_file_db(engine)
 
         # Add.
         self.api_file_dir = file_dir
         self.app.include_router(file_router, tags=['file'])
+
+        ## Admin.
+        self.add_admin_model(DatabaseORMTableInfo, engine, category='file', name='Info', column_list=['file_id', 'name'])
+        self.add_admin_model(DatabaseORMTableData, engine, category='file', name='Data')

{reyserver-1.1.56.dist-info → reyserver-1.1.57.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reyserver
-Version: 1.1.56
+Version: 1.1.57
 Summary: Backend server method set.
 Project-URL: homepage, https://github.com/reyxbo/reyserver/
 Author-email: Rey <reyxbo@163.com>
@@ -15,11 +15,10 @@ 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: fastapi[standard]
 Requires-Dist: reydb
 Requires-Dist: reykit
-Requires-Dist: sqladmin
+Requires-Dist: sqladmin[full]
 Requires-Dist: uvicorn[standard]
 Description-Content-Type: text/markdown
 

reyserver-1.1.57.dist-info/RECORD

@@ -0,0 +1,12 @@
+reyserver/__init__.py,sha256=Oq-lOcQInzhgKt1_4OB2jNx0OO2d9qZg9iZqUx6YRr8,398
+reyserver/radmin.py,sha256=Hwy8QsiQOyK2YP7abcS22IbRKB7sgcDGPHQ2-mHtf-8,3269
+reyserver/rall.py,sha256=MI1NnqUpq22CK9w3XPPBS0K8lNuf0BnbI0pn4MGMx38,293
+reyserver/rauth.py,sha256=5zQwi7eGjhHD2BHGQDQclLCn3HHg646Q4Cp2Bt6i3uc,11701
+reyserver/rbase.py,sha256=_bP_suBPF7dLd4RNKn96-X4ZAEx3vAjMS6vnheCokU4,6617
+reyserver/rclient.py,sha256=Ffm66YuWupzEtQ6RqEm2KCc6jSF8JeMB7Xq6pzRFZ6M,5073
+reyserver/rfile.py,sha256=CH2uJbBNmBH9ISDirn1LWL5wsjGW5xjB9ZIrdc5UzL0,8864
+reyserver/rserver.py,sha256=9-bhgVn_XZ6bvBl4GLdGkUs4UR1TSG08WC3F6ETQo7M,10986
+reyserver-1.1.57.dist-info/METADATA,sha256=xNQ5RW2H-ittdf-DEkYv5nIuWSwnX2xH_jKrIDkXp4k,1697
+reyserver-1.1.57.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reyserver-1.1.57.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reyserver-1.1.57.dist-info/RECORD,,

reyserver-1.1.56.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=pOkA7E4W31Ii8iCLkhhcoL5-ge9cFq7lMYxQtLYvQbg,11606
-reyserver/rbase.py,sha256=WbL2W6nc2jbkDumiXWrb25TaAhT-9xAI4wE0e_2prtg,6553
-reyserver/rclient.py,sha256=IWZ3smyIP0_YJrfSrM8JFCr0FCtN02AyT3hp8YuSsDQ,5103
-reyserver/rfile.py,sha256=CH2uJbBNmBH9ISDirn1LWL5wsjGW5xjB9ZIrdc5UzL0,8864
-reyserver/rserver.py,sha256=0lCvaac7N-A25vbrNAbQKQoWFqvxMNlHtMfnoVoGX0I,8563
-reyserver-1.1.56.dist-info/METADATA,sha256=M5Ocw__l3_sN1Pso7TryMu2505S-B82fOJ7uevyOIN0,1713
-reyserver-1.1.56.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reyserver-1.1.56.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reyserver-1.1.56.dist-info/RECORD,,