Working with Custom Views

基本示例

您可能需要向现有的 SQLAdmin 视图中添加自定义视图，例如创建仪表板、显示自定义信息或添加新表单。

要向管理员界面添加自定义视图，您可以使用 SQLAdmin 中包含的 BaseView。以下是添加自定义视图的示例：

示例

from sqladmin import BaseView, expose

class ReportView(BaseView):
    name = "报告页面"
    icon = "fa-solid fa-chart-line"

    @expose("/report", methods=["GET"])
    async def report_page(self, request):
        return await self.templates.TemplateResponse(request, "report.html")

admin.add_view(ReportView)

这假设您的项目中有一个 templates 目录，并且在该目录中创建了 report.html 文件。

如果您想使用自定义的目录名称，可以这样更改：

from sqladmin import Admin

admin = Admin(templates_dir="my_templates", ...)

现在访问 /admin/report，您就可以渲染您的 report.html 文件。

数据库访问

上面的示例非常基础，您可能希望在自定义视图中访问数据库和 SQLAlchemy 模型。您可以像 SQLAdmin 使用 sessionmaker 一样使用它来实现这一点：

示例

from sqlalchemy import Column, Integer, String, select, func
from sqlalchemy.orm import sessionmaker, declarative_base
from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
from sqladmin import Admin, BaseView, expose
from starlette.applications import Starlette

Base = declarative_base()
engine = create_async_engine("sqlite+aiosqlite:///test.db")
Session = sessionmaker(bind=engine, class_=AsyncSession)

app = Starlette()
admin = Admin(app=app, engine=engine)


class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String(length=16))


class ReportView(BaseView):
    name = "报告页面"
    icon = "fa-solid fa-chart-line"

    @expose("/report", methods=["GET"])
    async def report_page(self, request):
        # async with engine.begin() as conn:
        #     await conn.run_sync(Base.metadata.create_all)

        async with Session(expire_on_commit=False) as session:
            stmt = select(func.count(User.id))
            result = await session.execute(stmt)
            users_count = result.scalar_one()

        return await self.templates.TemplateResponse(
            request,
            "report.html",
            context={"users_count": users_count},
        )


admin.add_view(ReportView)

接下来，我们更新 templates 目录中的 report.html 文件，内容如下：

示例

{% extends "sqladmin/layout.html" %}
{% block content %}
<div class="col-12">
<div class="card">
    <div class="card-header">
    <h3 class="card-title">用户报告</h3>
    </div>
    <div class="card-body border-bottom py-3">
    用户数量: {{ users_count }}
    </div>
</div>
</div>
{% endblock %}

现在运行您的服务器，您可以访问 /admin/report 页面，并查看用户数量。