Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Create config subpackage (#376)

Leo Torres9845998bec03
diff --git a/manim/__init__.py b/manim/__init__.py
index 6227c2688..dd1bf9c7e 100644
--- a/manim/__init__.py
+++ b/manim/__init__.py
@@ -1,11 +1,8 @@
#!/usr/bin/env python
# Importing the config module should be the first thing we do, since other
-# modules depend on the global config dict for initialization. Note that the
-# global config dict is called 'config', just like the module itself. That's
-# why we import the module first with a different name, and then the dict.
-from . import config as _config
-from .config import config, file_writer_config, camera_config, tempconfig
+# modules depend on the global config dict for initialization.
+from .config import *
from .constants import *
diff --git a/manim/__main__.py b/manim/__main__.py
index 4f0275865..14d524e06 100644
--- a/manim/__main__.py
+++ b/manim/__main__.py
@@ -8,14 +8,12 @@ import traceback
import importlib.util
import types
-from .config import file_writer_config, args
-from .utils import cfg_subcmds
+from . import constants, logger, console, file_writer_config
+from .config.config import args
+from .config import cfg_subcmds
from .scene.scene import Scene
-from .utils.sounds import play_error_sound
-from .utils.sounds import play_finish_sound
+from .utils.sounds import play_error_sound, play_finish_sound
from .utils.file_ops import open_file as open_media_file
-from . import constants
-from .logger import logger, console
def open_file_if_needed(file_writer):
diff --git a/manim/animation/fading.py b/manim/animation/fading.py
index 362f01f31..1e485435c 100644
--- a/manim/animation/fading.py
+++ b/manim/animation/fading.py
@@ -23,7 +23,7 @@ from ..constants import DOWN
from ..mobject.types.vectorized_mobject import VMobject
from ..utils.bezier import interpolate
from ..utils.rate_functions import there_and_back
-from ..logger import logger
+from .. import logger
DEFAULT_FADE_LAG_RATIO = 0
diff --git a/manim/animation/indication.py b/manim/animation/indication.py
index 1cf3e1bfb..2e1b03e14 100644
--- a/manim/animation/indication.py
+++ b/manim/animation/indication.py
@@ -18,8 +18,8 @@ __all__ = [
import numpy as np
+from .. import config
from ..constants import *
-from ..config import config
from ..animation.animation import Animation
from ..animation.movement import Homotopy
from ..animation.composition import AnimationGroup
diff --git a/manim/camera/camera.py b/manim/camera/camera.py
index 75bf48c2f..2a5fbb419 100644
--- a/manim/camera/camera.py
+++ b/manim/camera/camera.py
@@ -15,9 +15,8 @@ from scipy.spatial.distance import pdist
import cairo
import numpy as np
+from .. import logger, config, camera_config
from ..constants import *
-from ..config import config, camera_config
-from ..logger import logger
from ..mobject.types.image_mobject import AbstractImageMobject
from ..mobject.mobject import Mobject
from ..mobject.types.point_cloud_mobject import PMobject
diff --git a/manim/camera/moving_camera.py b/manim/camera/moving_camera.py
index 53bdadaa9..56304064f 100644
--- a/manim/camera/moving_camera.py
+++ b/manim/camera/moving_camera.py
@@ -1,8 +1,8 @@
__all__ = ["CameraFrame", "MovingCamera"]
+from .. import config
from ..camera.camera import Camera
-from ..config import config
from ..constants import ORIGIN, WHITE
from ..mobject.frame import ScreenRectangle
from ..mobject.types.vectorized_mobject import VGroup
diff --git a/manim/camera/three_d_camera.py b/manim/camera/three_d_camera.py
index c5dd12c60..b6ea00313 100644
--- a/manim/camera/three_d_camera.py
+++ b/manim/camera/three_d_camera.py
@@ -3,9 +3,9 @@ __all__ = ["ThreeDCamera"]
import numpy as np
+from .. import config
from ..camera.camera import Camera
from ..constants import *
-from ..config import config
from ..mobject.three_d_utils import get_3d_vmob_end_corner
from ..mobject.three_d_utils import get_3d_vmob_end_corner_unit_normal
from ..mobject.three_d_utils import get_3d_vmob_start_corner
diff --git a/manim/config/__init__.py b/manim/config/__init__.py
new file mode 100644
index 000000000..2711c21b0
--- /dev/null
+++ b/manim/config/__init__.py
@@ -0,0 +1,9 @@
+# Note that the global config dict is called 'config', just like the module
+# itself. That's why we import the module first with a different name
+# (_config), and then the dict.
+from . import config as _config
+from .config import config, tempconfig, file_writer_config, camera_config
+from .logger import logger, console
+
+__all__ = ["_config", "config", "tempconfig", "file_writer_config",
+ "camera_config", "logger", "console"]
diff --git a/manim/utils/cfg_subcmds.py b/manim/config/cfg_subcmds.py
similarity index 99%
rename from manim/utils/cfg_subcmds.py
rename to manim/config/cfg_subcmds.py
index 4f23e5dae..f5e457f14 100644
--- a/manim/utils/cfg_subcmds.py
+++ b/manim/config/cfg_subcmds.py
@@ -11,7 +11,7 @@ import configparser
from ast import literal_eval
from .config_utils import _run_config, _paths_config_file, finalized_configs_dict
-from .file_ops import guarantee_existence, open_file
+from ..utils.file_ops import guarantee_existence, open_file
from rich.console import Console
from rich.style import Style
diff --git a/manim/config.py b/manim/config/config.py
similarity index 97%
rename from manim/config.py
rename to manim/config/config.py
index 0e314af12..c1f0936e5 100644
--- a/manim/config.py
+++ b/manim/config/config.py
@@ -4,19 +4,22 @@ config.py
Process the manim.cfg file and the command line arguments into a single
config object.
"""
+
+
+__all__ = ["file_writer_config", "config", "camera_config", "tempconfig"]
+
+
import os
import sys
from contextlib import contextmanager
import colour
-from . import constants
-from .utils.config_utils import _run_config, _init_dirs, _from_command_line
+from .. import constants
+from .config_utils import _run_config, _init_dirs, _from_command_line
from .logger import logger
-from .utils.tex import TexTemplate, TexTemplateFromFile
-
-__all__ = ["file_writer_config", "config", "camera_config", "tempconfig"]
+from ..utils.tex import TexTemplate, TexTemplateFromFile
config = None
diff --git a/manim/utils/config_utils.py b/manim/config/config_utils.py
similarity index 99%
rename from manim/utils/config_utils.py
rename to manim/config/config_utils.py
index 7a1e1d562..37b265032 100644
--- a/manim/utils/config_utils.py
+++ b/manim/config/config_utils.py
@@ -6,6 +6,15 @@ Utility functions for parsing manim config files.
"""
+
+__all__ = [
+ "_run_config",
+ "_paths_config_file",
+ "_from_command_line",
+ "finalized_configs_dict",
+]
+
+
import argparse
import configparser
import os
@@ -14,14 +23,7 @@ import sys
import colour
from .. import constants
-from .tex import TexTemplate, TexTemplateFromFile
-
-__all__ = [
- "_run_config",
- "_paths_config_file",
- "_from_command_line",
- "finalized_configs_dict",
-]
+from ..utils.tex import TexTemplate, TexTemplateFromFile
def _parse_file_writer_config(config_parser, args):
@@ -459,7 +461,7 @@ def _from_dunder_main():
def _paths_config_file():
library_wide = os.path.abspath(
- os.path.join(os.path.dirname(__file__), "..", "default.cfg")
+ os.path.join(os.path.dirname(__file__), "default.cfg")
)
if sys.platform.startswith("win32"):
user_wide = os.path.expanduser(
diff --git a/manim/default.cfg b/manim/config/default.cfg
similarity index 100%
rename from manim/default.cfg
rename to manim/config/default.cfg
diff --git a/manim/logger.py b/manim/config/logger.py
similarity index 97%
rename from manim/logger.py
rename to manim/config/logger.py
index 7974a22e7..143509b34 100644
--- a/manim/logger.py
+++ b/manim/config/logger.py
@@ -5,6 +5,11 @@ This is the logging library for manim.
This library uses rich for coloured log outputs.
"""
+
+
+__all__ = ['logger', 'console']
+
+
import configparser
import logging
@@ -14,7 +19,7 @@ from rich.theme import Theme
from rich import print as printf
from rich import errors, color
-from .utils.config_utils import _run_config
+from .config_utils import _run_config
def parse_theme(fp):
diff --git a/manim/mobject/coordinate_systems.py b/manim/mobject/coordinate_systems.py
index e3c89d365..0bed1d4c2 100644
--- a/manim/mobject/coordinate_systems.py
+++ b/manim/mobject/coordinate_systems.py
@@ -4,8 +4,8 @@ __all__ = ["CoordinateSystem", "Axes", "ThreeDAxes", "NumberPlane", "ComplexPlan
import numpy as np
import numbers
+from .. import config
from ..constants import *
-from ..config import config
from ..mobject.functions import ParametricFunction
from ..mobject.geometry import Arrow
from ..mobject.geometry import Line
diff --git a/manim/mobject/frame.py b/manim/mobject/frame.py
index d2a8ccd0c..489b38573 100644
--- a/manim/mobject/frame.py
+++ b/manim/mobject/frame.py
@@ -6,8 +6,8 @@ __all__ = [
]
+from .. import config
from ..constants import *
-from ..config import config
from ..mobject.geometry import Rectangle
from ..utils.config_ops import digest_config
diff --git a/manim/mobject/functions.py b/manim/mobject/functions.py
index 68a5ebbee..902966ce4 100644
--- a/manim/mobject/functions.py
+++ b/manim/mobject/functions.py
@@ -1,8 +1,8 @@
__all__ = ["ParametricFunction", "FunctionGraph"]
+from .. import config
from ..constants import *
-from ..config import config
from ..mobject.types.vectorized_mobject import VMobject
from ..utils.config_ops import digest_config
import math
diff --git a/manim/mobject/mobject.py b/manim/mobject/mobject.py
index 5bd1ded62..20cb3125d 100644
--- a/manim/mobject/mobject.py
+++ b/manim/mobject/mobject.py
@@ -15,8 +15,8 @@ import sys
from colour import Color
import numpy as np
+from .. import config
from ..constants import *
-from ..config import config
from ..container import Container
from ..utils.color import color_gradient
from ..utils.color import interpolate_color
diff --git a/manim/mobject/number_line.py b/manim/mobject/number_line.py
index 0d827df26..1c148d072 100644
--- a/manim/mobject/number_line.py
+++ b/manim/mobject/number_line.py
@@ -6,8 +6,8 @@ __all__ = ["NumberLine", "UnitInterval"]
import operator as op
+from .. import config
from ..constants import *
-from ..config import config
from ..mobject.geometry import Line
from ..mobject.numbers import DecimalNumber
from ..mobject.types.vectorized_mobject import VGroup
diff --git a/manim/mobject/svg/drawings.py b/manim/mobject/svg/drawings.py
index 95614fddb..2bc9d870c 100644
--- a/manim/mobject/svg/drawings.py
+++ b/manim/mobject/svg/drawings.py
@@ -28,10 +28,10 @@ __all__ = [
import itertools as it
import string
+from ... import config
from ...animation.animation import Animation
from ...animation.rotation import Rotating
from ...constants import *
-from ...config import config
from ...mobject.geometry import AnnularSector
from ...mobject.geometry import Arc
from ...mobject.geometry import Circle
diff --git a/manim/mobject/svg/tex_mobject.py b/manim/mobject/svg/tex_mobject.py
index 9f6afa315..dc265e394 100644
--- a/manim/mobject/svg/tex_mobject.py
+++ b/manim/mobject/svg/tex_mobject.py
@@ -12,8 +12,8 @@ __all__ = [
from functools import reduce
import operator as op
+from ... import config
from ...constants import *
-from ...config import config
from ...mobject.geometry import Line
from ...mobject.svg.svg_mobject import SVGMobject
from ...mobject.svg.svg_mobject import VMobjectFromSVGPathstring
diff --git a/manim/mobject/svg/text_mobject.py b/manim/mobject/svg/text_mobject.py
index 6edfca975..c161d5d1b 100644
--- a/manim/mobject/svg/text_mobject.py
+++ b/manim/mobject/svg/text_mobject.py
@@ -7,10 +7,9 @@ import copy
import hashlib
import cairo
+from ... import config, file_writer_config, logger
from ...constants import *
-from ...config import config, file_writer_config
from ...container import Container
-from ...logger import logger
from ...mobject.geometry import Dot, Rectangle
from ...mobject.svg.svg_mobject import SVGMobject
from ...mobject.types.vectorized_mobject import VGroup
diff --git a/manim/mobject/vector_field.py b/manim/mobject/vector_field.py
index 48971ec71..f9078b226 100644
--- a/manim/mobject/vector_field.py
+++ b/manim/mobject/vector_field.py
@@ -18,9 +18,8 @@ import itertools as it
from PIL import Image
import random
+from .. import config, logger
from ..constants import *
-from ..config import config
-from ..logger import logger
from ..animation.composition import AnimationGroup
from ..animation.indication import ShowPassingFlash
from ..mobject.geometry import Vector
diff --git a/manim/scene/graph_scene.py b/manim/scene/graph_scene.py
index 67fd95daf..68789b5df 100644
--- a/manim/scene/graph_scene.py
+++ b/manim/scene/graph_scene.py
@@ -1,8 +1,9 @@
__all__ = ["GraphScene"]
+
import itertools as it
-from ..config import config
+from .. import config
from ..animation.creation import Write, DrawBorderThenFill, ShowCreation
from ..animation.transform import Transform
from ..animation.update import UpdateFromAlphaFunc
diff --git a/manim/scene/scene.py b/manim/scene/scene.py
index d3ad0f329..1ca43e09a 100644
--- a/manim/scene/scene.py
+++ b/manim/scene/scene.py
@@ -13,13 +13,12 @@ import copy
from tqdm import tqdm as ProgressDisplay
import numpy as np
+from .. import camera_config, file_writer_config, logger
from ..animation.animation import Animation
from ..animation.transform import MoveToTarget, ApplyMethod
from ..camera.camera import Camera
from ..constants import *
-from ..config import camera_config, file_writer_config
from ..container import Container
-from ..logger import logger
from ..mobject.mobject import Mobject
from ..scene.scene_file_writer import SceneFileWriter
from ..utils.iterables import list_update
diff --git a/manim/scene/scene_file_writer.py b/manim/scene/scene_file_writer.py
index 6f835fbbb..eb9e8b728 100644
--- a/manim/scene/scene_file_writer.py
+++ b/manim/scene/scene_file_writer.py
@@ -11,9 +11,8 @@ from time import sleep
import datetime
from PIL import Image
+from .. import file_writer_config, logger, console
from ..constants import FFMPEG_BIN, GIF_FILE_EXTENSION
-from ..config import file_writer_config
-from ..logger import logger, console
from ..utils.config_ops import digest_config
from ..utils.file_ops import guarantee_existence
from ..utils.file_ops import add_extension_if_not_present
diff --git a/manim/scene/three_d_scene.py b/manim/scene/three_d_scene.py
index 8b83f7cd7..6f8cfc4f4 100644
--- a/manim/scene/three_d_scene.py
+++ b/manim/scene/three_d_scene.py
@@ -1,10 +1,10 @@
__all__ = ["ThreeDScene", "SpecialThreeDScene"]
+from .. import config
from ..animation.transform import ApplyMethod
from ..camera.three_d_camera import ThreeDCamera
from ..constants import DEGREES
-from ..config import config
from ..mobject.coordinate_systems import ThreeDAxes
from ..mobject.geometry import Line
from ..mobject.three_dimensions import Sphere
diff --git a/manim/scene/vector_space_scene.py b/manim/scene/vector_space_scene.py
index 5f833deee..8d96d3ad6 100644
--- a/manim/scene/vector_space_scene.py
+++ b/manim/scene/vector_space_scene.py
@@ -3,6 +3,8 @@ __all__ = ["VectorScene", "LinearTransformationScene"]
import numpy as np
+from .. import config
+from ..constants import *
from ..animation.animation import Animation
from ..animation.creation import ShowCreation
from ..animation.creation import Write
@@ -11,8 +13,6 @@ from ..animation.growing import GrowArrow
from ..animation.transform import ApplyFunction
from ..animation.transform import ApplyPointwiseFunction
from ..animation.transform import Transform
-from ..constants import *
-from ..config import config
from ..mobject.coordinate_systems import Axes
from ..mobject.coordinate_systems import NumberPlane
from ..mobject.geometry import Arrow
diff --git a/manim/utils/hashing.py b/manim/utils/hashing.py
index 454b9b206..4946f6f88 100644
--- a/manim/utils/hashing.py
+++ b/manim/utils/hashing.py
@@ -6,7 +6,7 @@ import dis
import numpy as np
from types import ModuleType
-from ..logger import logger
+from .. import logger
class CustomEncoder(json.JSONEncoder):
diff --git a/manim/utils/tex_file_writing.py b/manim/utils/tex_file_writing.py
index b736c4f92..fefdd5821 100644
--- a/manim/utils/tex_file_writing.py
+++ b/manim/utils/tex_file_writing.py
@@ -2,9 +2,7 @@ import os
import hashlib
from pathlib import Path
-from .. import constants
-from ..config import file_writer_config, config
-from ..logger import logger
+from .. import file_writer_config, config, logger
def tex_hash(expression):
diff --git a/setup.py b/setup.py
index 019d96cd4..fa451113c 100755
--- a/setup.py
+++ b/setup.py
@@ -6,7 +6,7 @@ setup(
description="Animation engine for explanatory math videos",
license="MIT",
packages=find_namespace_packages(),
- package_data={"manim": ["*.tex", "*.cfg"]},
+ package_data={"manim": ["*.tex", "config/*.cfg"]},
entry_points={
"console_scripts": ["manim=manim.__main__:main", "manimcm=manim.__main__:main",]
},
diff --git a/tests/test_cli/manim.cfg b/tests/test_cli/manim.cfg
index ae9ef35bc..3f866d46f 100644
--- a/tests/test_cli/manim.cfg
+++ b/tests/test_cli/manim.cfg
@@ -6,3 +6,6 @@ verbosity = DEBUG
# write_all = False
save_last_frame = True
# save_pngs = False
+
+[logger]
+log_width = 512
\ No newline at end of file
diff --git a/tests/test_imports.py b/tests/test_imports.py
index 55ed89a48..4560d4e98 100644
--- a/tests/test_imports.py
+++ b/tests/test_imports.py
@@ -1,2 +1,13 @@
+from types import ModuleType
+
def test_import():
+ # check that the package imports without errors
import manim
+
+ # check that we have access to both the module and dict
+ from manim import _config, config
+ assert isinstance(_config, ModuleType)
+ assert isinstance(config, dict)
+
+ # check that we have access to the logger
+ from manim import logger, console