工具

用于创建和设置配置的工具。

该模块导出的主要类是ManimConfig。该类包含所有配置选项,包括帧几何(例如帧高度/宽度、帧率)、输出(例如目录、日志记录)、样式(例如背景颜色、透明度)和一般行为(例如写入电影与写入单帧)。

请参阅配置了解Manim配置系统的介绍。

ManimConfig

类似字典的类,用于存储所有配置选项。

ManimFrame

函数

config_file_paths()[来源]

将搜索.cfg文件的路径。

当首次导入manim时,它会处理找到的任何.cfg文件。此函数返回搜索这些文件的位置。按照优先级升序排列,这些位置是:库范围的配置文件、用户范围的配置文件和文件夹范围的配置文件。

库范围的配置文件决定了manim的默认行为。用户范围的配置文件存储在用户的主文件夹中,并决定了用户从系统中的任何位置调用manim时的行为。文件夹范围的配置文件仅影响同一文件夹中的场景。后两个文件是可选的。

这些文件(如果存在)应该被加载到一个单一的configparser.ConfigParser对象中,然后由ManimConfig处理。

Returns:

可能包含.cfg文件的路径列表,按优先级升序排列。

Return type:

列表[路径]

注释

用户范围的配置文件的位置取决于操作系统。

make_config_parser(custom_file=None)[来源]

创建一个ConfigParser对象并加载任何.cfg文件。

如果存在用户范围的文件,它将覆盖库范围的文件。如果存在文件夹范围的文件,它将覆盖其他两个文件。

可以通过传递custom_file来忽略文件夹范围内的文件。然而,用户范围和库范围的配置文件不能被忽略。

Parameters:

custom_file (StrPath | None) – 自定义配置文件的路径。如果使用,相关目录中的文件夹范围文件将被忽略(如果存在)。如果为None,将使用文件夹范围文件(如果存在)。

Returns:

一个包含在找到的.cfg文件中的配置选项的解析器。它保证至少包含在库范围内文件中找到的配置选项。

Return type:

ConfigParser

另请参阅

config_file_paths()