Merge pull request #620 from ManimCommunity/feat-manim-configdict

Replace the global config dict with new class ManimConfig

Author: leotrs

docs/source/manim_directive.py

@@ -207,18 +207,18 @@ def run(self):
         video_dir = os.path.join(media_dir, "videos")
         output_file = f"{clsname}-{classnamedict[clsname]}"
 
-        file_writer_config_code = [
+        config_code = [
             f'config["frame_rate"] = {frame_rate}',
             f'config["pixel_height"] = {pixel_height}',
             f'config["pixel_width"] = {pixel_width}',
-            f'file_writer_config["media_dir"] = r"{media_dir}"',
-            f'file_writer_config["images_dir"] = r"{images_dir}"',
-            f'file_writer_config["tex_dir"] = r"{tex_dir}"',
-            f'file_writer_config["text_dir"] = r"{text_dir}"',
-            f'file_writer_config["video_dir"] = r"{video_dir}"',
-            f'file_writer_config["save_last_frame"] = {save_last_frame}',
-            f'file_writer_config["save_as_gif"] = {save_as_gif}',
-            f'file_writer_config["output_file"] = r"{output_file}"',
+            f'config["media_dir"] = r"{media_dir}"',
+            f'config["images_dir"] = r"{images_dir}"',
+            f'config["tex_dir"] = r"{tex_dir}"',
+            f'config["text_dir"] = r"{text_dir}"',
+            f'config["video_dir"] = r"{video_dir}"',
+            f'config["save_last_frame"] = {save_last_frame}',
+            f'config["save_as_gif"] = {save_as_gif}',
+            f'config["output_file"] = r"{output_file}"',
         ]
 
         user_code = self.content
@@ -229,7 +229,7 @@ def run(self):
 
         code = [
             "from manim import *",
-            *file_writer_config_code,
+            *config_code,
             *user_code,
             f"{clsname}().render()",
         ]

docs/source/reference.rst

@@ -128,6 +128,6 @@ Other modules
 .. autosummary::
    :toctree: reference
 
-   _config
+   config
    constants
    container

manim/__main__.py

@@ -3,7 +3,7 @@
 import sys
 import traceback
 
-from manim import constants, logger, console, config, file_writer_config
+from manim import constants, logger, console, config
 from manim import Scene
 from manim.utils.module_ops import (
     get_module,
@@ -12,38 +12,35 @@
 )
 from manim.utils.file_ops import open_file as open_media_file
 from manim.grpc.impl import frame_server_impl
+from manim.config.utils import init_dirs
 from manim.config.main_utils import *
 
 
 def open_file_if_needed(file_writer):
-    if file_writer_config["verbosity"] != "DEBUG":
+    if config["verbosity"] != "DEBUG":
         curr_stdout = sys.stdout
         sys.stdout = open(os.devnull, "w")
 
-    open_file = any(
-        [file_writer_config["preview"], file_writer_config["show_in_file_browser"]]
-    )
+    open_file = any([config["preview"], config["show_in_file_browser"]])
+
     if open_file:
         current_os = platform.system()
         file_paths = []
 
-        if file_writer_config["save_last_frame"]:
+        if config["save_last_frame"]:
             file_paths.append(file_writer.get_image_file_path())
-        if (
-            file_writer_config["write_to_movie"]
-            and not file_writer_config["save_as_gif"]
-        ):
+        if config["write_to_movie"] and not config["save_as_gif"]:
             file_paths.append(file_writer.get_movie_file_path())
-        if file_writer_config["save_as_gif"]:
+        if config["save_as_gif"]:
             file_paths.append(file_writer.gif_file_path)
 
         for file_path in file_paths:
-            if file_writer_config["show_in_file_browser"]:
+            if config["show_in_file_browser"]:
                 open_media_file(file_path, True)
-            if file_writer_config["preview"]:
+            if config["preview"]:
                 open_media_file(file_path, False)
 
-    if file_writer_config["verbosity"] != "DEBUG":
+    if config["verbosity"] != "DEBUG":
         sys.stdout.close()
         sys.stdout = curr_stdout
 
@@ -69,13 +66,10 @@ def main():
         #     something_else_here()
 
     else:
-        update_config_with_cli(args)
-        init_dirs(file_writer_config)
-
-        if file_writer_config["log_to_file"]:
-            set_file_logger()
+        config.digest_args(args)
+        init_dirs(config)
 
-        module = get_module(file_writer_config["input_file"])
+        module = get_module(config["input_file"])
         all_scene_classes = get_scene_classes_from_module(module)
         scene_classes_to_render = get_scenes_to_render(all_scene_classes)
         for SceneClass in scene_classes_to_render:

manim/camera/camera.py

@@ -14,7 +14,7 @@
 import cairo
 import numpy as np
 
-from .. import logger, config, camera_config
+from .. import logger, config
 from ..constants import *
 from ..mobject.types.image_mobject import AbstractImageMobject
 from ..mobject.mobject import Mobject
@@ -53,8 +53,6 @@ class Camera(object):
         # Note: frame height and width will be resized to match
         # the pixel aspect ratio
         "frame_center": ORIGIN,
-        "background_color": BLACK,
-        "background_opacity": 1,
         # Points in vectorized mobjects with norm greater
         # than this value will be rescaled.
         "image_mode": "RGBA",
@@ -91,6 +89,8 @@ def __init__(self, video_quality_config, background=None, **kwargs):
             "frame_height",
             "frame_width",
             "frame_rate",
+            "background_color",
+            "background_opacity",
         ]:
             setattr(self, attr, kwargs.get(attr, config[attr]))
 
@@ -1039,9 +1039,7 @@ def adjusted_thickness(self, thickness):
 
         """
         # TODO: This seems...unsystematic
-        big_sum = op.add(
-            camera_config["default_pixel_height"], camera_config["default_pixel_width"]
-        )
+        big_sum = op.add(config["default_pixel_height"], config["default_pixel_width"])
         this_sum = op.add(self.pixel_height, self.pixel_width)
         factor = fdiv(big_sum, this_sum)
         return 1 + (thickness - 1) / factor

manim/config/__init__.py

@@ -1,14 +1,14 @@
 import logging
 from contextlib import contextmanager
 
-from .utils import make_config_parser, make_logger, make_config, make_file_writer_config
+from .logger import make_logger
+from .utils import make_config_parser, ManimConfig, ManimFrame
 
 __all__ = [
     "logger",
     "console",
     "config",
-    "file_writer_config",
-    "camera_config",
+    "frame",
     "tempconfig",
 ]
 
@@ -22,9 +22,8 @@
 logging.getLogger("PIL").setLevel(logging.INFO)
 logging.getLogger("matplotlib").setLevel(logging.INFO)
 
-config = make_config(parser)
-camera_config = config
-file_writer_config = make_file_writer_config(parser, config)
+config = ManimConfig(parser)
+frame = ManimFrame(config)
 
 
 # This has to go here because it needs access to this module's config

manim/config/default.cfg

@@ -73,16 +73,13 @@ upto_animation_number = -1
 media_dir = ./media
 
 # --log_dir (by default "/logs", that will be put inside the media dir)
-log_dir = logs
+log_dir = {media_dir}/logs
 
-# # --video_dir
-# video_dir = %(MEDIA_DIR)s/videos
-
-# # --tex_dir
-# tex_dir = %(MEDIA_DIR)s/Tex
-
-# # --text_dir
-# text_dir = %(MEDIA_DIR)s/texts
+# the following do not have CLI arguments but depend on media_dir
+video_dir = {media_dir}/videos
+tex_dir = {media_dir}/Tex
+text_dir = {media_dir}/texts
+images_dir = {media_dir}/images
 
 # --use_js_renderer
 use_js_renderer = False
@@ -112,45 +109,6 @@ disable_caching = False
 # --tex_template
 tex_template =
 
-# These override the previous by using -t, --transparent
-[transparent]
-png_mode = RGBA
-movie_file_extension = .mov
-background_opacity = 0
-
-# These override the previous by using -k, --four_k
-[fourk_quality]
-pixel_height = 2160
-pixel_width = 3840
-frame_rate = 60
-
-# These override the previous by using -e, --high_quality
-[high_quality]
-pixel_height = 1440
-pixel_width = 2560
-frame_rate = 60
-
-# These override the previous by using -m, --medium_quality
-[medium_quality]
-pixel_height = 720
-pixel_width = 1280
-frame_rate = 30
-
-# These override the previous by using -l, --low_quality
-[low_quality]
-pixel_height = 480
-pixel_width = 854
-frame_rate = 15
-
-# These override the previous by using --dry_run
-# Note --dry_run overrides all of -w, -a, -s, -g, -i
-[dry_run]
-write_to_movie = False
-write_all = False
-save_last_frame = False
-save_pngs = False
-save_as_gif = False
-
 # Streaming settings
 [streaming]
 live_stream_name = LiveStream
@@ -170,10 +128,11 @@ streaming_console_banner = Manim is now running in streaming mode.
 # under media_dir, as is the default.
 [custom_folders]
 media_dir = videos
-video_dir = %(media_dir)s
-images_dir = %(media_dir)s
-text_dir = %(media_dir)s/temp_files
-tex_dir = %(media_dir)s/temp_files
+video_dir = {media_dir}
+images_dir = {media_dir}
+text_dir = {media_dir}/temp_files
+tex_dir = {media_dir}/temp_files
+log_dir = {media_dir}/temp_files
 
 # Rich settings
 [logger]
@@ -193,5 +152,6 @@ log_height = -1
 log_timestamps = True
 
 [ffmpeg]
-# Uncomment the following line to manually set the loglevel for ffmpeg. See ffmpeg manpage for accepted values
-# loglevel = error
+# Uncomment the following line to manually set the loglevel for ffmpeg. See
+# ffmpeg manpage for accepted values
+loglevel = ERROR