PackageRenderer

类源码

PackageRenderer(out_dir: str | PathLike[str], saver: SaverAbstract)

用来渲染文档页面的模块处理器。

针对每个模块包成员，调用该处理器、以处理其信息，渲染、并保存成对应的文档页面文件。

参数

输入

参数	类型	必选	说明
out_dir	str | PathLike[str]		用来保存输出文档的目录。
saver	SaverAbstract		用来导出文件的保存器。

方法

parse_class

self.parse_class(obj: DocClass)

当成员对象为类时，渲染其文档的实现。

输入

参数	类型	必选	说明
obj	DocClass		待渲染和保存的类信息。

---

parse_dataclass

self.parse_dataclass(obj: DocDataClass)

当成员对象为数据类时，渲染其文档的实现。

输入

参数	类型	必选	说明
obj	DocDataClass		待渲染和保存的数据类信息。

---

parse_enum

self.parse_enum(obj: DocEnum)

当成员对象为枚举类型时，渲染其文档的实现。

输入

参数	类型	必选	说明
obj	DocEnum		待渲染和保存的枚举类型信息。

---

parse_function

self.parse_function(obj: DocFunction)

当成员对象为函数时，渲染其文档的实现。

输入

参数	类型	必选	说明
obj	DocFunction		待渲染和保存的函数信息。

---

parse_module

self.parse_module(obj: DocModule)

当成员对象为模块时，渲染其文档的实现。

输入

参数	类型	必选	说明
obj	DocModule		待渲染和保存的模块信息。

---

parse_protocol

self.parse_protocol(obj: DocProtocol)

当成员对象为协议类型时，渲染其文档的实现。

输入

参数	类型	必选	说明
obj	DocProtocol		待渲染和保存的协议类型信息。

---

parse_typealias

self.parse_typealias(obj: DocTypeAlias)

当成员对象为类型别名时，渲染其文档的实现。

输入

参数	类型	必选	说明
obj	DocTypeAlias		待渲染和保存的类型别名信息。

---

parse_typeddict

self.parse_typeddict(obj: DocTypedDict)

当成员对象为类型提示字典时，渲染其文档的实现。

输入

参数	类型	必选	说明
obj	DocTypedDict		待渲染和保存的类型提示字典信息。

---

save_page

self.save_page(page: RendererPage)

保存文档页面的实现。

输入

参数	类型	必选	说明
page	RendererPage		待渲染和保存的页面。