♻️ refactor(UI): 重构UI渲染服务为组件化分层架构 (#2025)
检查bot是否运行正常 / bot check (push) Waiting to run
Sequential Lint and Type Check / ruff-call (push) Waiting to run
Sequential Lint and Type Check / pyright-call (push) Blocked by required conditions
Release Drafter / Update Release Draft (push) Waiting to run
Force Sync to Aliyun / sync (push) Waiting to run
Update Version / update-version (push) Waiting to run
CodeQL Code Security Analysis / Analyze (${{ matrix.language }}) (none, javascript-typescript) (push) Has been cancelled
CodeQL Code Security Analysis / Analyze (${{ matrix.language }}) (none, python) (push) Has been cancelled

* ♻️ refactor(UI): 重构UI渲染服务为组件化分层架构

♻️ **架构重构**
- UI渲染服务重构为组件化分层架构
- 解耦主题管理、HTML生成、截图功能

✨ **新增功能**
- `zhenxun.ui` 统一入口,提供 `render`、`markdown`、`vstack` 等API
- `RenderableComponent` 基类和渲染协议抽象
- 新增主题管理器和截图引擎模块

⚙️ **配置优化**
- UI配置迁移至 `superuser/ui_manager.py`
- 新增"重载UI主题"管理指令

🔧 **性能改进**
- 优化渲染缓存,支持组件级透明缓存
- 所有UI组件适配新渲染流程

* 🚨 auto fix by pre-commit hooks

---------

Co-authored-by: webjoin111 <455457521@qq.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Rumio
2025-08-18 23:08:22 +08:00
committed by GitHub
co-authored by webjoin111 pre-commit-ci[bot]
parent 11524bcb04
commit 6124e217d0
43 changed files with 1334 additions and 928 deletions
+139 -39
View File
@@ -1,40 +1,140 @@
from . import builders, models
from .builders import (
InfoCardBuilder,
LayoutBuilder,
MarkdownBuilder,
NotebookBuilder,
PluginHelpPageBuilder,
PluginMenuBuilder,
TableBuilder,
)
from .models import (
HelpCategory,
HelpItem,
InfoCardData,
PluginHelpPageData,
PluginMenuCategory,
PluginMenuData,
PluginMenuItem,
RenderableComponent,
)
from pathlib import Path
from typing import Any, Literal
__all__ = [
"HelpCategory",
"HelpItem",
"InfoCardBuilder",
"InfoCardData",
"LayoutBuilder",
"MarkdownBuilder",
"NotebookBuilder",
"PluginHelpPageBuilder",
"PluginHelpPageData",
"PluginMenuBuilder",
"PluginMenuCategory",
"PluginMenuData",
"PluginMenuItem",
"RenderableComponent",
"TableBuilder",
"builders",
"models",
]
from zhenxun.services.renderer.protocols import Renderable
from .builders.core.layout import LayoutBuilder
from .models.core.base import RenderableComponent
from .models.core.markdown import MarkdownData
from .models.core.template import TemplateComponent
def template(path: str | Path, data: dict[str, Any]) -> TemplateComponent:
"""
创建一个基于独立模板文件的UI组件。
"""
if isinstance(path, str):
path = Path(path)
return TemplateComponent(template_path=path, data=data)
def markdown(content: str, style: str | Path | None = "default") -> MarkdownData:
"""
创建一个基于Markdown内容的UI组件。
"""
if isinstance(style, Path):
return MarkdownData(markdown=content, css_path=str(style.absolute()))
return MarkdownData(markdown=content, style_name=style)
def vstack(children: list[RenderableComponent], **layout_options) -> "LayoutBuilder":
"""
创建一个垂直布局组件。
"""
builder = LayoutBuilder.column(**layout_options)
for child in children:
builder.add_item(child)
return builder
def hstack(children: list[RenderableComponent], **layout_options) -> "LayoutBuilder":
"""
创建一个水平布局组件。
"""
builder = LayoutBuilder.row(**layout_options)
for child in children:
builder.add_item(child)
return builder
async def render(
component_or_path: Renderable | str | Path,
data: dict | None = None,
*,
use_cache: bool = False,
debug_mode: Literal["none", "log"] = "none",
**kwargs,
) -> bytes:
"""
统一的UI渲染入口。
用法:
1. 渲染一个已构建的UI组件: `render(my_builder.build())`
2. 直接渲染一个模板文件: `render("path/to/template", data={...})`
"""
from zhenxun.services import renderer_service
component: Renderable
if isinstance(component_or_path, str | Path):
if data is None:
raise ValueError("使用模板路径渲染时必须提供 'data' 参数。")
component = TemplateComponent(template_path=component_or_path, data=data)
else:
component = component_or_path
return await renderer_service.render(
component, use_cache=use_cache, debug_mode=debug_mode, **kwargs
)
async def render_template(
path: str | Path, data: dict, use_cache: bool = False, **kwargs
) -> bytes:
"""
渲染一个独立的Jinja2模板文件。
这是一个便捷函数,封装了 render() 函数的调用,提供更简洁的模板渲染接口。
参数:
path: 模板文件路径,相对于主题模板目录。
data: 传递给模板的数据字典。
use_cache: (可选) 是否启用渲染缓存,默认为 False。
**kwargs: 传递给渲染服务的额外参数。
返回:
bytes: 渲染后的图片数据。
"""
return await render(path, data, use_cache=use_cache, **kwargs)
async def render_markdown(
md: str, style: str | Path | None = "default", use_cache: bool = False, **kwargs
) -> bytes:
"""
将Markdown字符串渲染为图片。
这是一个便捷函数,封装了 render() 函数的调用,专门用于渲染Markdown内容。
参数:
md: 要渲染的Markdown内容字符串。
style: (可选) 样式名称或自定义CSS文件路径,默认为 "default"。
use_cache: (可选) 是否启用渲染缓存,默认为 False。
**kwargs: 传递给渲染服务的额外参数。
返回:
bytes: 渲染后的图片数据。
"""
component: MarkdownData
if isinstance(style, Path):
component = MarkdownData(markdown=md, css_path=str(style.absolute()))
else:
component = MarkdownData(markdown=md, style_name=style)
return await render(component, use_cache=use_cache, **kwargs)
from zhenxun.services.renderer.protocols import RenderResult
async def render_full_result(
component: Renderable, use_cache: bool = False, **kwargs
) -> RenderResult:
"""
渲染组件并返回包含图片和HTML的完整结果对象,用于调试和高级用途。
"""
from zhenxun.services import renderer_service
return await renderer_service._render_component(
component, use_cache=use_cache, **kwargs
)