✨ feat!(ui): 重构图表组件架构,实现数据与样式分离 (#2035)

* ✨ feat!(ui): 重构图表组件架构,实现数据与样式分离

🏗️ **架构重构**
- 移除charts.py中所有硬编码样式参数(grid、tooltip、legend等)
- 将样式配置迁移至主题层style.json文件
- 统一图表模板消费样式文件的能力

📊 **图表组件优化**
- bar_chart: 移除grid和坐标轴show参数
- pie_chart: 移除tooltip、legend样式和series视觉参数
- line_chart: 移除tooltip、grid和坐标轴配置
- radar_chart: 移除tooltip硬编码

🎨 **主题系统增强**
- 新增pie_chart、line_chart、radar_chart的style.json配置
- 更新bar_chart/style.json,添加grid、xAxis、yAxis样式
- 所有图表模板支持deepMerge样式合并逻辑

🔧 **Breaking Changes**
- 图表工厂函数不再接受样式参数
- 主题开发者现可通过style.json完全定制图表外观
- 提升组件可维护性和主题灵活性

* 📦️ build(pyinstaller): 引入 resources.spec 并更新 .gitignore 规则

* 🚨 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-28 09:20:15 +08:00
committed by GitHub
co-authored by webjoin111 pre-commit-ci[bot]
parent d9e65057cf
commit 7472cabd48
61 changed files with 2272 additions and 648 deletions
+101 -15
View File
@@ -1,8 +1,9 @@
from pathlib import Path
from typing import Any, Literal
from typing import Any
from zhenxun.services.renderer.protocols import Renderable
from . import builders
from .builders.core.layout import LayoutBuilder
from .models.core.base import RenderableComponent
from .models.core.markdown import MarkdownData
@@ -12,6 +13,14 @@ from .models.core.template import TemplateComponent
def template(path: str | Path, data: dict[str, Any]) -> TemplateComponent:
"""
创建一个基于独立模板文件的UI组件。
适用于不希望遵循标准主题结构,而是直接渲染单个HTML文件的场景。
参数:
path: 指向HTML模板文件的绝对或相对路径。
data: 传递给模板的上下文数据字典。
返回:
TemplateComponent: 一个可被 `render()` 函数处理的组件实例。
"""
if isinstance(path, str):
path = Path(path)
@@ -22,15 +31,35 @@ def template(path: str | Path, data: dict[str, Any]) -> TemplateComponent:
def markdown(content: str, style: str | Path | None = "default") -> MarkdownData:
"""
创建一个基于Markdown内容的UI组件。
参数:
content: 要渲染的Markdown字符串。
style: (可选) Markdown的样式名称(如 'github-light')或一个指向
自定义CSS文件的路径。
返回:
MarkdownData: 一个可被 `render()` 函数处理的组件实例。
"""
builder = builders.MarkdownBuilder().text(content)
component = builder.build()
if isinstance(style, Path):
return MarkdownData(markdown=content, css_path=str(style.absolute()))
return MarkdownData(markdown=content, style_name=style)
component.css_path = str(style.absolute())
else:
component.style_name = style
return component
def vstack(children: list[RenderableComponent], **layout_options) -> "LayoutBuilder":
"""
创建一个垂直布局组件。
便捷函数,用于将多个组件垂直堆叠。
参数:
children: 一个包含 `RenderableComponent` 实例的列表。
**layout_options: 传递给布局模板的额外选项,如 `padding`, `gap`。
返回:
LayoutBuilder: 一个配置好的垂直布局构建器。
"""
builder = LayoutBuilder.column(**layout_options)
for child in children:
@@ -41,6 +70,14 @@ def vstack(children: list[RenderableComponent], **layout_options) -> "LayoutBuil
def hstack(children: list[RenderableComponent], **layout_options) -> "LayoutBuilder":
"""
创建一个水平布局组件。
便捷函数,用于将多个组件水平排列。
参数:
children: 一个包含 `RenderableComponent` 实例的列表。
**layout_options: 传递给布局模板的额外选项,如 `padding`, `gap`。
返回:
LayoutBuilder: 一个配置好的水平布局构建器。
"""
builder = LayoutBuilder.row(**layout_options)
for child in children:
@@ -53,15 +90,25 @@ async def render(
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={...})`
1. 渲染一个已构建的UI组件: `render(my_builder.build())`
2. 直接渲染一个模板文件: `render("path/to/template", data={...})`
参数:
component_or_path: 一个 `Renderable` 实例,或一个指向模板文件的
`str` 或 `Path` 对象。
data: (可选) 当 `component_or_path` 是路径时,必须提供此数据字典。
use_cache: (可选) 是否为此渲染启用文件缓存,默认为 `False`。
**kwargs: 传递给底层截图引擎的额外参数,例如 `viewport`。
返回:
bytes: 渲染后的PNG图片字节数据。
"""
from zhenxun.services import renderer_service
@@ -73,9 +120,7 @@ async def render(
else:
component = component_or_path
return await renderer_service.render(
component, use_cache=use_cache, debug_mode=debug_mode, **kwargs
)
return await renderer_service.render(component, use_cache=use_cache, **kwargs)
async def render_template(
@@ -94,6 +139,9 @@ async def render_template(
返回:
bytes: 渲染后的图片数据。
异常:
RenderingError: 渲染失败时抛出。
"""
return await render(path, data, use_cache=use_cache, **kwargs)
@@ -114,12 +162,16 @@ async def render_markdown(
返回:
bytes: 渲染后的图片数据。
异常:
RenderingError: 渲染失败时抛出。
"""
component: MarkdownData
builder = builders.MarkdownBuilder().text(md)
component = builder.build()
if isinstance(style, Path):
component = MarkdownData(markdown=md, css_path=str(style.absolute()))
component.css_path = str(style.absolute())
else:
component = MarkdownData(markdown=md, style_name=style)
component.style_name = style
return await render(component, use_cache=use_cache, **kwargs)
@@ -131,10 +183,44 @@ async def render_full_result(
component: Renderable, use_cache: bool = False, **kwargs
) -> RenderResult:
"""
渲染组件并返回包含图片和HTML的完整结果对象,用于调试和高级用途。
渲染组件并返回包含图片和HTML的完整结果对象。
主要用于调试或需要同时访问图片和其源HTML的场景。
参数:
component: 一个 `Renderable` 实例。
use_cache: (可选) 是否为此渲染启用文件缓存,默认为 `False`。
**kwargs: 传递给底层截图引擎的额外参数。
返回:
RenderResult: 一个包含 `image_bytes` 和 `html_content` 的Pydantic模型。
"""
from zhenxun.services import renderer_service
from zhenxun.services.renderer.service import RenderContext
return await renderer_service._render_component(
component, use_cache=use_cache, **kwargs
if not renderer_service._initialized:
await renderer_service.initialize()
assert renderer_service._theme_manager is not None, "ThemeManager 未初始化"
assert renderer_service._screenshot_engine is not None, "ScreenshotEngine 未初始化"
context = RenderContext(
renderer=renderer_service,
theme_manager=renderer_service._theme_manager,
screenshot_engine=renderer_service._screenshot_engine,
component=component,
use_cache=use_cache,
render_options=kwargs,
)
return await renderer_service._render_component(context)
__all__ = [
"builders",
"hstack",
"markdown",
"render",
"render_full_result",
"render_markdown",
"render_template",
"template",
"vstack",
]