模块解析¶

读取并解析所有 Manim 模块，并从中提取文档。

类型别名

class AliasInfo¶

dict[str, str]

一个字典，其中包含一个 definition 键，其值是一个字符串，表示 TypeAlias 的定义；可选地，还包含一个 doc 键，其值包含该别名的文档（如果存在）。

class AliasCategoryDict¶

dict[str, AliasInfo]

一个字典，为同一类别中的每个别名都包含一个 AliasInfo。

class ModuleLevelAliasDict¶

dict[str, AliasCategoryDict]

一个字典，包含模块中定义的每个 TypeAlias，并根据类别分类到不同的 AliasCategoryDict 对象中。

class ModuleTypeVarDict¶

dict[str, str]

一个字典，包含模块中定义的每个 TypeVar。

class AliasDocsDict¶

dict[str, ModuleLevelAliasDict]

一个字典，其中包含 Manim 中每个模块的文档，内容是关于其模块级属性的，这些属性被明确定义为 TypeAlias，并将其与其余属性区分开。

class DataDict¶

dict[str, list[str]]

一个字典类型，其中包含每个模块的所有已文档化的模块级属性（通过 Sphinx 的 data 角色识别，因此得名）的名称列表，这些属性未明确定义为 TypeAlias。

class TypeVarDict¶

dict[str, ModuleTypeVarDict]

一个字典，将模块名称映射到 TypeVar 对象的字典。

函数

parse_module_attributes()[source]¶

读取所有文件，从它们生成抽象语法树，并提取文件中定义的类型别名的有用信息：它们所属的类别、它们的定义和描述，并将它们与“常规”模块属性区分开来。

返回:

ALIAS_DOCS_DICT (AliasDocsDict) – 一个字典，包含 Manim 中所有类型别名的信息。更多信息请参见 AliasDocsDict。
DATA_DICT (DataDict) – 一个字典，包含所有已文档化的非 TypeAlias 的模块级属性的名称。
TYPEVAR_DICT (TypeVarDict) – 一个字典，包含按模块组织的 TypeVar 对象的定义。

返回类型:

元组[AliasDocsDict, DataDict, TypeVarDict]