utils

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

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

有关 Manim 配置系统的介绍，请参阅配置。

类

ManimConfig（Manim配置）	存储所有配置选项的类字典。
ManimFrame（Manim帧）

函数

config_file_paths()

将搜索 .cfg 文件的路径。

Manim 首次导入时，它会处理找到的任何 .cfg 文件。此函数返回搜索这些文件的位置。按优先顺序递增，它们是：库范围的配置文件、用户范围的配置文件和文件夹范围的配置文件。

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

这些文件（如果存在）旨在加载到单个 configparser.ConfigParser 对象中，然后由ManimConfig处理。

返回:

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

返回类型:

List[Path]

另请参阅

make_config_parser(), ManimConfig.digest_file(), ManimConfig.digest_parser()

注意

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

make_config_parser(custom_file=None)

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

用户范围文件（如果存在）会覆盖库范围文件。文件夹范围文件（如果存在）会覆盖其他两个。

通过传递 custom_file 可以忽略文件夹范围文件。但是，用户范围和库范围配置文件不能被忽略。

参数:

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

返回:

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

返回类型:

ConfigParser

另请参阅

config_file_paths()