Pass scene argument to play and wait

Author: eulertour

manim/renderer/cairo_renderer.py

@@ -9,11 +9,9 @@
 from ..camera.camera import Camera
 
 
-def manage_scene_reference(func):
+def pass_scene_reference(func):
     def wrapper(self, scene, *args, **kwargs):
-        setattr(self, "scene", scene)
-        func(self, *args, **kwargs)
-        delattr(self, "scene")
+        func(self, scene, *args, **kwargs)
 
     return wrapper
 
@@ -39,10 +37,10 @@ def handle_play_like_call(func):
         to the video file stream.
     """
 
-    def wrapper(self, *args, **kwargs):
+    def wrapper(self, scene, *args, **kwargs):
         allow_write = not file_writer_config["skip_animations"]
         self.file_writer.begin_animation(allow_write)
-        func(self, *args, **kwargs)
+        func(self, scene, *args, **kwargs)
         self.file_writer.end_animation(allow_write)
         self.num_plays += 1
 
@@ -88,17 +86,17 @@ def init(self, scene):
             **file_writer_config,
         )
 
-    @manage_scene_reference
+    @pass_scene_reference
     @handle_caching_play
     @handle_play_like_call
-    def play(self, *args, **kwargs):
-        self.scene.play_internal(*args, **kwargs)
+    def play(self, scene, *args, **kwargs):
+        scene.play_internal(*args, **kwargs)
 
-    @manage_scene_reference
+    @pass_scene_reference
     @handle_caching_wait
     @handle_play_like_call
-    def wait(self, duration=DEFAULT_WAIT_TIME, stop_condition=None):
-        self.scene.wait_internal(duration=duration, stop_condition=stop_condition)
+    def wait(self, scene, duration=DEFAULT_WAIT_TIME, stop_condition=None):
+        scene.wait_internal(duration=duration, stop_condition=stop_condition)
 
     def update_frame(  # TODO Description in Docstring
         self,

manim/utils/caching.py

@@ -15,21 +15,21 @@ def handle_caching_play(func):
         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):
+    def wrapper(self, scene, *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)
+        animations = scene.compile_play_args_to_animation_list(*args, **kwargs)
+        scene.add_mobjects_from_animations(animations)
         if file_writer_config["skip_animations"]:
             logger.debug(f"Skipping animation {self.num_plays}")
-            func(self, *args, **kwargs)
+            func(self, scene, *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()
+            mobjects_on_scene = scene.get_mobjects()
             hash_play = get_hash_from_play_call(
                 self, self.camera, animations, mobjects_on_scene
             )
@@ -47,7 +47,7 @@ def wrapper(self, *args, **kwargs):
             "List of the first few animation hashes of the scene: %(h)s",
             {"h": str(self.animations_hashes[:5])},
         )
-        func(self, *args, **kwargs)
+        func(self, scene, *args, **kwargs)
 
     return wrapper
 
@@ -64,20 +64,20 @@ def handle_caching_wait(func):
         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):
+    def wrapper(self, scene, 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)
+            func(self, scene, 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()
+                self, self.camera, duration, stop_condition, scene.get_mobjects()
             )
             if self.file_writer.is_already_cached(hash_wait):
                 logger.info(
@@ -92,6 +92,6 @@ def wrapper(self, duration=DEFAULT_WAIT_TIME, stop_condition=None):
             "Animations hashes list of the scene : (concatened to 5) %(h)s",
             {"h": str(self.animations_hashes[:5])},
         )
-        func(self, duration, stop_condition)
+        func(self, scene, duration, stop_condition)
 
     return wrapper