模块解析

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

类型别名

class AliasInfo
dict[str, str]

字典包含一个definition键,该键包含TypeAlias的定义作为字符串,以及可选的doc键,该键包含该别名的文档(如果存在)。

class AliasCategoryDict
dict[str, AliasInfo]

字典,其中包含同一类别中每个别名名称的AliasInfo

class ModuleLevelAliasDict
dict[str, AliasCategoryDict]

包含模块中定义的每个TypeAlias的字典, 按类别分类在不同的AliasCategoryDict对象中。

class AliasDocsDict
dict[str, ModuleLevelAliasDict]

字典,对于Manim中的每个模块,包含关于其模块级属性的文档,这些属性被明确定义为TypeAlias,将它们与其他属性分开。

class DataDict
dict[str, list[str]]

类型为字典,对于每个模块,包含一个列表,其中列出了所有已记录的模块级属性(由Sphinx通过data角色识别,因此得名),这些属性未明确定义为TypeAlias

函数

parse_module_attributes()[source]

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

Returns:

  • ALIAS_DOCS_DICT (AliasDocsDict) – 包含Manim中所有类型别名信息的字典。更多信息请参见AliasDocsDict

  • DATA_DICT (DataDict) – 包含所有已记录的模块级属性名称的字典,这些属性不是TypeAlias

Return type:

元组[AliasDocsDict, DataDict]