A community-maintained Python framework for creating mathematical animations.
Move caching functions
Devin Neal57a2ead55e41
diff --git a/manim/renderer/cairo_renderer.py b/manim/renderer/cairo_renderer.pyindex ac91f5882..a72260372 100644--- a/manim/renderer/cairo_renderer.py+++ b/manim/renderer/cairo_renderer.py@@ -5,100 +5,7 @@ from ..utils.exceptions import EndSceneEarlyExceptionfrom ..utils.hashing import get_hash_from_play_call, get_hash_from_wait_callfrom ..constants import DEFAULT_WAIT_TIMEfrom ..scene.scene_file_writer import SceneFileWriter---def handle_caching_play(func):- """- Decorator that returns a wrapped version of func that will compute the hash of the play invocation.-- The returned function will act according to the computed hash: either skip the animation because it's already cached, or let the invoked function play normally.-- Parameters- ----------- func : Callable[[...], None]- The play like function that has to be written to the video file stream. Take the same parameters as `scene.play`.- """-- def wrapper(self, *args, **kwargs):- self.revert_to_original_skipping_status()- self.update_skipping_status()- animations = self.scene.compile_play_args_to_animation_list(*args, **kwargs)- self.scene.add_mobjects_from_animations(animations)- if file_writer_config["skip_animations"]:- logger.debug(f"Skipping animation {self.num_plays}")- func(self, *args, **kwargs)- # If the animation is skipped, we mark its hash as None.- # When sceneFileWriter will start combining partial movie files, it won't take into account None hashes.- self.animations_hashes.append(None)- self.file_writer.add_partial_movie_file(None)- return- if not file_writer_config["disable_caching"]:- mobjects_on_scene = self.scene.get_mobjects()- hash_play = get_hash_from_play_call(- self, self.camera, animations, mobjects_on_scene- )- if self.file_writer.is_already_cached(hash_play):- logger.info(- f"Animation {self.num_plays} : Using cached data (hash : %(hash_play)s)",- {"hash_play": hash_play},- )- file_writer_config["skip_animations"] = True- else:- hash_play = "uncached_{:05}".format(self.num_plays)- self.animations_hashes.append(hash_play)- self.file_writer.add_partial_movie_file(hash_play)- logger.debug(- "List of the first few animation hashes of the scene: %(h)s",- {"h": str(self.animations_hashes[:5])},- )- func(self, *args, **kwargs)-- return wrapper---def handle_caching_wait(func):- """- Decorator that returns a wrapped version of func that will compute the hash of the wait invocation.-- The returned function will act according to the computed hash: either skip the animation because it's already cached, or let the invoked function play normally.-- Parameters- ----------- func : Callable[[...], None]- The wait like function that has to be written to the video file stream. Take the same parameters as `scene.wait`.- """-- def wrapper(self, duration=DEFAULT_WAIT_TIME, stop_condition=None):- self.revert_to_original_skipping_status()- self.update_skipping_status()- if file_writer_config["skip_animations"]:- logger.debug(f"Skipping wait {self.num_plays}")- func(self, duration, stop_condition)- # If the animation is skipped, we mark its hash as None.- # When sceneFileWriter will start combining partial movie files, it won't take into account None hashes.- self.animations_hashes.append(None)- self.file_writer.add_partial_movie_file(None)- return- if not file_writer_config["disable_caching"]:- hash_wait = get_hash_from_wait_call(- self, self.camera, duration, stop_condition, self.scene.get_mobjects()- )- if self.file_writer.is_already_cached(hash_wait):- logger.info(- f"Wait {self.num_plays} : Using cached data (hash : {hash_wait})"- )- file_writer_config["skip_animations"] = True- else:- hash_wait = "uncached_{:05}".format(self.num_plays)- self.animations_hashes.append(hash_wait)- self.file_writer.add_partial_movie_file(hash_wait)- logger.debug(- "Animations hashes list of the scene : (concatened to 5) %(h)s",- {"h": str(self.animations_hashes[:5])},- )- func(self, duration, stop_condition)-- return wrapper+from ..utils.caching import handle_caching_play, handle_caching_waitdef handle_play_like_call(func):diff --git a/manim/utils/caching.py b/manim/utils/caching.pynew file mode 100644index 000000000..e6f745aba--- /dev/null+++ b/manim/utils/caching.py@@ -0,0 +1,97 @@+from .. import file_writer_config, logger+from ..utils.hashing import get_hash_from_play_call, get_hash_from_wait_call+from ..constants import DEFAULT_WAIT_TIME+++def handle_caching_play(func):+ """+ Decorator that returns a wrapped version of func that will compute the hash of the play invocation.++ The returned function will act according to the computed hash: either skip the animation because it's already cached, or let the invoked function play normally.++ Parameters+ ----------+ func : Callable[[...], None]+ The play like function that has to be written to the video file stream. Take the same parameters as `scene.play`.+ """++ def wrapper(self, *args, **kwargs):+ self.revert_to_original_skipping_status()+ self.update_skipping_status()+ animations = self.scene.compile_play_args_to_animation_list(*args, **kwargs)+ self.scene.add_mobjects_from_animations(animations)+ if file_writer_config["skip_animations"]:+ logger.debug(f"Skipping animation {self.num_plays}")+ func(self, *args, **kwargs)+ # If the animation is skipped, we mark its hash as None.+ # When sceneFileWriter will start combining partial movie files, it won't take into account None hashes.+ self.animations_hashes.append(None)+ self.file_writer.add_partial_movie_file(None)+ return+ if not file_writer_config["disable_caching"]:+ mobjects_on_scene = self.scene.get_mobjects()+ hash_play = get_hash_from_play_call(+ self, self.camera, animations, mobjects_on_scene+ )+ if self.file_writer.is_already_cached(hash_play):+ logger.info(+ f"Animation {self.num_plays} : Using cached data (hash : %(hash_play)s)",+ {"hash_play": hash_play},+ )+ file_writer_config["skip_animations"] = True+ else:+ hash_play = "uncached_{:05}".format(self.num_plays)+ self.animations_hashes.append(hash_play)+ self.file_writer.add_partial_movie_file(hash_play)+ logger.debug(+ "List of the first few animation hashes of the scene: %(h)s",+ {"h": str(self.animations_hashes[:5])},+ )+ func(self, *args, **kwargs)++ return wrapper+++def handle_caching_wait(func):+ """+ Decorator that returns a wrapped version of func that will compute the hash of the wait invocation.++ The returned function will act according to the computed hash: either skip the animation because it's already cached, or let the invoked function play normally.++ Parameters+ ----------+ func : Callable[[...], None]+ The wait like function that has to be written to the video file stream. Take the same parameters as `scene.wait`.+ """++ def wrapper(self, duration=DEFAULT_WAIT_TIME, stop_condition=None):+ self.revert_to_original_skipping_status()+ self.update_skipping_status()+ if file_writer_config["skip_animations"]:+ logger.debug(f"Skipping wait {self.num_plays}")+ func(self, duration, stop_condition)+ # If the animation is skipped, we mark its hash as None.+ # When sceneFileWriter will start combining partial movie files, it won't take into account None hashes.+ self.animations_hashes.append(None)+ self.file_writer.add_partial_movie_file(None)+ return+ if not file_writer_config["disable_caching"]:+ hash_wait = get_hash_from_wait_call(+ self, self.camera, duration, stop_condition, self.scene.get_mobjects()+ )+ if self.file_writer.is_already_cached(hash_wait):+ logger.info(+ f"Wait {self.num_plays} : Using cached data (hash : {hash_wait})"+ )+ file_writer_config["skip_animations"] = True+ else:+ hash_wait = "uncached_{:05}".format(self.num_plays)+ self.animations_hashes.append(hash_wait)+ self.file_writer.add_partial_movie_file(hash_wait)+ logger.debug(+ "Animations hashes list of the scene : (concatened to 5) %(h)s",+ {"h": str(self.animations_hashes[:5])},+ )+ func(self, duration, stop_condition)++ return wrapperdiff --git a/tests/control_data/logs_data/BasicSceneLoggingTest.txt b/tests/control_data/logs_data/BasicSceneLoggingTest.txtindex 1fb4753b5..576252e49 100644--- a/tests/control_data/logs_data/BasicSceneLoggingTest.txt+++ b/tests/control_data/logs_data/BasicSceneLoggingTest.txt@@ -2,7 +2,7 @@{"levelname": "DEBUG", "module": "hashing", "message": "Hashing ..."}{"levelname": "DEBUG", "module": "hashing", "message": "Hashing done in <> s."}{"levelname": "DEBUG", "module": "hashing", "message": "Hash generated : <>"}-{"levelname": "DEBUG", "module": "cairo_renderer", "message": "List of the first few animation hashes of the scene: <>"}+{"levelname": "DEBUG", "module": "caching", "message": "List of the first few animation hashes of the scene: <>"}{"levelname": "INFO", "module": "scene_file_writer", "message": "Animation 0 : Partial movie file written in <>"}{"levelname": "DEBUG", "module": "scene_file_writer", "message": "Partial movie files to combine (1 files): <>"}{"levelname": "INFO", "module": "scene_file_writer", "message": "\nFile ready at <>\n"}