Add logger and replace print calls with appropriate logging functions

This commit adds a logger.py file and also replaces all `print` calls with logging functions like `logger.info`, `logger.warning`, `logger.error` etc.

Also adds rich as a dependency.

Author: kilacoda

manim/__init__.py

@@ -2,8 +2,7 @@
 from . import config
 from . import constants
 
-
-def main():
+def main():    
     args = config.parse_cli()
     cfg = config.get_configuration(args)
     constants.initialize_directories(cfg)

manim/camera/camera.py

@@ -10,6 +10,7 @@
 import numpy as np
 
 from ..constants import *
+from ..logger import logger
 from ..mobject.types.image_mobject import AbstractImageMobject
 from ..mobject.mobject import Mobject
 from ..mobject.types.point_cloud_mobject import PMobject
@@ -24,7 +25,6 @@
 from ..utils.space_ops import angle_of_vector
 from ..utils.space_ops import get_norm
 
-
 class Camera(object):
     """
     Base Camera class.
@@ -348,14 +348,14 @@ def make_background_from_func(self, coords_to_colors_func):
             The pixel array which can then be passed to set_background.
         """
 
-        print("Starting set_background; for reference, the current time is ", time.strftime("%H:%M:%S"))
+        logger.info("Starting set_background; for reference, the current time is ", time.strftime("%H:%M:%S"))
         coords = self.get_coords_of_all_pixels()
         new_background = np.apply_along_axis(
             coords_to_colors_func,
             2,
             coords
         )
-        print("Ending set_background; for reference, the current time is ", time.strftime("%H:%M:%S"))
+        logger.info("Ending set_background; for reference, the current time is ", time.strftime("%H:%M:%S"))
 
         return self.convert_pixel_array(new_background, convert_from_floats=True)
 

manim/config.py

@@ -5,7 +5,9 @@
 import types
 
 from . import constants
+from .logger import logger
 
+ 
 
 def parse_cli():
     try:
@@ -133,7 +135,7 @@ def parse_cli():
         )
         return parser.parse_args()
     except argparse.ArgumentError as err:
-        print(str(err))
+        logger.error(str(err))
         sys.exit(2)
 
 
@@ -229,8 +231,8 @@ def get_camera_configuration(args):
         try:
             camera_config["background_color"] = colour.Color(args.color)
         except AttributeError as err:
-            print("Please use a valid color")
-            print(err)
+            logger.warning("Please use a valid color")
+            logger.error(err)
             sys.exit(2)
 
     # If rendering a transparent image/move, make sure the

manim/constants.py

@@ -1,13 +1,13 @@
 import numpy as np
 import os
+from .logger import logger
 
 MEDIA_DIR = ""
 VIDEO_DIR = ""
 VIDEO_OUTPUT_DIR = ""
 TEX_DIR = ""
 TEXT_DIR = ""
 
-
 def initialize_directories(config):
     global MEDIA_DIR
     global VIDEO_DIR
@@ -27,13 +27,13 @@ def initialize_directories(config):
             )
         if not os.path.isdir(MEDIA_DIR):
             MEDIA_DIR = "./media"
-        print(
+        logger.info(
             f"Media will be written to {MEDIA_DIR + os.sep}. You can change "
             "this behavior with the --media_dir flag."
         )
     else:
         if config["media_dir"]:
-            print(
+            logger.warning(
                 "Ignoring --media_dir, since both --tex_dir and a video "
                 "directory were both passed"
             )
@@ -53,7 +53,6 @@ def initialize_directories(config):
             os.makedirs(folder)
 
 NOT_SETTING_FONT_MSG='''
-Warning:
 You haven't set font.
 If you are not using English, this may cause text rendering problem.
 You set font like:

manim/extract_scene.py

@@ -11,6 +11,7 @@
 from .utils.sounds import play_error_sound
 from .utils.sounds import play_finish_sound
 from . import constants
+from .logger import logger
 
 
 def open_file_if_needed(file_writer, **config):
@@ -83,7 +84,7 @@ def prompt_user_for_choice(scene_classes):
             for num_str in user_input.split(",")
         ]
     except KeyError:
-        print(constants.INVALID_NUMBER_MESSAGE)
+        logger.error(constants.INVALID_NUMBER_MESSAGE)
         sys.exit(2)
         user_input = input(constants.CHOOSE_NUMBER_MESSAGE)
         return [
@@ -96,7 +97,7 @@ def prompt_user_for_choice(scene_classes):
 
 def get_scenes_to_render(scene_classes, config):
     if len(scene_classes) == 0:
-        print(constants.NO_SCENE_MESSAGE)
+        logger.error(constants.NO_SCENE_MESSAGE)
         return []
     if config["write_all"]:
         return scene_classes
@@ -109,7 +110,7 @@ def get_scenes_to_render(scene_classes, config):
                 found = True
                 break
         if not found and (scene_name != ""):
-            print(
+            logger.error(
                 constants.SCENE_NOT_FOUND_MESSAGE.format(
                     scene_name
                 ),
@@ -141,7 +142,7 @@ def get_module(file_name):
             exec(code, module.__dict__)
             return module
         except Exception as e:
-            print(f"Failed to render scene: {str(e)}")
+            logger.error(f"Failed to render scene: {str(e)}")
             sys.exit(2)
     else:
         module_name = file_name.replace(os.sep, ".").replace(".py", "")

manim/logger.py

@@ -0,0 +1,12 @@
+import logging
+from rich.logging import RichHandler
+
+## Setting config for logger.
+logging.basicConfig(
+    level="NOTSET",
+    format="%(message)s",
+    datefmt="[%X]",
+    handlers=[RichHandler()]
+)
+
+logger = logging.getLogger("rich")

manim/mobject/svg/text_mobject.py

@@ -5,6 +5,7 @@
 import cairo
 from ...constants import *
 from ...container.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
@@ -287,7 +288,7 @@ def text2svg(self):
 
         if self.font == '':
             if NOT_SETTING_FONT_MSG != '':
-                print(NOT_SETTING_FONT_MSG)
+                logger.warning(NOT_SETTING_FONT_MSG)
 
         dir_name = TEXT_DIR
         hash_name = self.text2hash()

manim/mobject/vector_field.py

@@ -5,7 +5,7 @@
 import random
 
 from ..constants import *
-
+from ..logger import logger
 from ..animation.composition import AnimationGroup
 from ..animation.indication import ShowPassingFlash
 from ..mobject.geometry import Vector
@@ -85,7 +85,7 @@ def get_color_field_image_file(scalar_func,
     file_name = "%d.png" % func_hash
     full_path = os.path.join(RASTER_IMAGE_DIR, file_name)
     if not os.path.exists(full_path):
-        print("Rendering color field image " + str(func_hash))
+        logger.info("Rendering color field image " + str(func_hash))
         rgb_gradient_func = get_rgb_gradient_function(
             min_value=min_value,
             max_value=max_value,

manim/scene/scene.py

@@ -11,6 +11,7 @@
 from ..camera.camera import Camera
 from ..constants import *
 from ..container.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
@@ -110,7 +111,7 @@ def print_end_message(self):
         Used internally to print the number of
         animations played after the scene ends.
         """
-        print("Played {} animations".format(self.num_plays))
+        logger.info("Played {} animations".format(self.num_plays))
 
     def set_variables_as_attrs(self, *objects, **newly_named_objects):
         """

manim/scene/scene_file_writer.py

@@ -14,6 +14,7 @@
 from ..constants import STREAMING_PROTOCOL
 from ..constants import VIDEO_DIR
 from ..constants import VIDEO_OUTPUT_DIR
+from ..logger import logger
 from ..utils.config_ops import digest_config
 from ..utils.file_ops import guarantee_existence
 from ..utils.file_ops import add_extension_if_not_present
@@ -473,7 +474,7 @@ def combine_movie_files(self):
             **kwargs
         )
         if len(partial_movie_files) == 0:
-            print("No animations in this scene")
+            logger.error("No animations in this scene")
             return
 
         # Write a file partial_file_list.txt containing all
@@ -542,4 +543,4 @@ def print_file_ready_message(self, file_path):
         """
         Prints the "File Ready" message to STDOUT.
         """
-        print("\nFile ready at {}\n".format(file_path))
+        logger.info("\nFile ready at {}\n".format(file_path))