Adding type annotations to scene.py and vector_space_scene.py

manim/gui/gui.py

@@ -10,17 +10,25 @@
     dearpygui_imported = False
 
 
+from typing import TYPE_CHECKING, Any
+
 from .. import __version__, config
 from ..utils.module_ops import scene_classes_from_file
 
+if TYPE_CHECKING:
+    from ..renderer.opengl_renderer import OpenGLRenderer
+
+
 __all__ = ["configure_pygui"]
 
 if dearpygui_imported:
     dpg.create_context()
     window = dpg.generate_uuid()
 
 
-def configure_pygui(renderer, widgets, update=True):
+def configure_pygui(
+    renderer: OpenGLRenderer, widgets: list[Any], update: bool = True
+) -> None:
     if not dearpygui_imported:
         raise RuntimeError("Attempted to use DearPyGUI when it isn't imported.")
     if update:

manim/mobject/matrix.py

@@ -400,7 +400,7 @@ def add_background_to_entries(self):
             mob.add_background_rectangle()
         return self
 
-    def get_mob_matrix(self):
+    def get_mob_matrix(self) -> list[list[MathTex]]:
         """Return the underlying mob matrix mobjects.
 
         Returns
@@ -435,7 +435,7 @@ def construct(self):
         """
         return self.elements
 
-    def get_brackets(self):
+    def get_brackets(self) -> VGroup:
         r"""Return the bracket mobjects.
 
         Returns

manim/mobject/text/tex_mobject.py

@@ -30,6 +30,8 @@
 from functools import reduce
 from textwrap import dedent
 
+from typing_extensions import Self
+
 from manim import config, logger
 from manim.constants import *
 from manim.mobject.geometry.line import Line
@@ -448,7 +450,7 @@ class Tex(MathTex):
 
     def __init__(
         self, *tex_strings, arg_separator="", tex_environment="center", **kwargs
-    ):
+    ) -> Self:
         super().__init__(
             *tex_strings,
             arg_separator=arg_separator,

manim/renderer/cairo_renderer.py

@@ -17,7 +17,7 @@
     from typing import Any
 
     from manim.animation.animation import Animation
     from manim.scene.scene import Scene
 
     from ..typing import PixelArray
 
@@ -33,11 +33,11 @@
 
     def __init__(
         self,
-        file_writer_class=SceneFileWriter,
-        camera_class=None,
-        skip_animations=False,
-        **kwargs,
-    ):
+        file_writer_class: type[SceneFileWriter] = SceneFileWriter,
+        camera_class: type[Camera] | None = None,
+        skip_animations: bool = False,
+        **kwargs: Any,
+    ) -> None:
         # All of the following are set to EITHER the value passed via kwargs,
         # OR the value stored in the global config dict at the time of
         # _instance construction_.
@@ -51,7 +51,7 @@
         self.time = 0
         self.static_image = None
 
-    def init_scene(self, scene):
+    def init_scene(self, scene: Scene) -> None:
         self.file_writer: Any = self._file_writer_class(
             self,
             scene.__class__.__name__,
@@ -119,12 +119,12 @@
 
     def update_frame(  # TODO Description in Docstring
         self,
-        scene,
+        scene: Scene,
         mobjects: typing.Iterable[Mobject] | None = None,
         include_submobjects: bool = True,
         ignore_skipping: bool = True,
-        **kwargs,
-    ):
+        **kwargs: Any,
+    ) -> None:
         """Update the frame.
 
         Parameters
@@ -263,7 +263,7 @@
             self.skip_animations = True
             raise EndSceneEarlyException()
 
-    def scene_finished(self, scene):
+    def scene_finished(self, scene: Scene) -> None:
         # If no animations in scene, render an image instead
         if self.num_plays:
             self.file_writer.finish()

manim/renderer/opengl_renderer.py

@@ -4,14 +4,18 @@
 import itertools as it
 import time
 from functools import cached_property
-from typing import Any
+from typing import TYPE_CHECKING, Any
 
 import moderngl
 import numpy as np
 from PIL import Image
 
 from manim import config, logger
-from manim.mobject.opengl.opengl_mobject import OpenGLMobject, OpenGLPoint
+from manim.mobject.opengl.opengl_mobject import (
+    OpenGLMobject,
+    OpenGLPoint,
+    _AnimationBuilder,
+)
 from manim.mobject.opengl.opengl_vectorized_mobject import OpenGLVMobject
 from manim.utils.caching import handle_caching_play
 from manim.utils.color import color_to_rgba
@@ -34,7 +38,16 @@
     render_opengl_vectorized_mobject_fill,
     render_opengl_vectorized_mobject_stroke,
 )
 
+if TYPE_CHECKING:
+    import numpy.typing as npt
+    from typing_extensions import Self
+
+    from manim.animation.animation import Animation
+    from manim.mobject.mobject import Mobject
+    from manim.scene.scene import Scene
+
+
 __all__ = ["OpenGLCamera", "OpenGLRenderer"]
 
 
@@ -102,7 +115,7 @@
         self.euler_angles = euler_angles
         self.refresh_rotation_matrix()
 
-    def get_position(self):
+    def get_position(self) -> npt.NDArray:
         return self.model_matrix[:, 3][:3]
 
     def set_position(self, position):
@@ -123,7 +136,7 @@
         self.set_height(self.frame_shape[1], stretch=True)
         self.move_to(self.center_point)
 
-    def to_default_state(self):
+    def to_default_state(self) -> Self:
         self.center()
         self.set_height(config["frame_height"])
         self.set_width(config["frame_width"])
@@ -166,28 +179,28 @@
         self.refresh_rotation_matrix()
         return self
 
-    def set_theta(self, theta):
+    def set_theta(self, theta: float) -> Self:
         return self.set_euler_angles(theta=theta)
 
-    def set_phi(self, phi):
+    def set_phi(self, phi: float) -> Self:
         return self.set_euler_angles(phi=phi)
 
-    def set_gamma(self, gamma):
+    def set_gamma(self, gamma: float) -> Self:
         return self.set_euler_angles(gamma=gamma)
 
-    def increment_theta(self, dtheta):
+    def increment_theta(self, dtheta: float) -> Self:
         self.euler_angles[0] += dtheta
         self.refresh_rotation_matrix()
         return self
 
-    def increment_phi(self, dphi):
+    def increment_phi(self, dphi: float) -> Self:
         phi = self.euler_angles[1]
         new_phi = clip(phi + dphi, -PI / 2, PI / 2)
         self.euler_angles[1] = new_phi
         self.refresh_rotation_matrix()
         return self
 
-    def increment_gamma(self, dgamma):
+    def increment_gamma(self, dgamma: float) -> Self:
         self.euler_angles[2] += dgamma
         self.refresh_rotation_matrix()
         return self
@@ -199,15 +212,15 @@
         # Assumes first point is at the center
         return self.points[0]
 
-    def get_width(self):
+    def get_width(self) -> float:
         points = self.points
         return points[2, 0] - points[1, 0]
 
-    def get_height(self):
+    def get_height(self) -> float:
         points = self.points
         return points[4, 1] - points[3, 1]
 
-    def get_focal_distance(self):
+    def get_focal_distance(self) -> float:
         return self.focal_distance * self.get_height()
 
     def interpolate(self, *args, **kwargs):
@@ -412,7 +425,9 @@
             raise EndSceneEarlyException()
 
     @handle_caching_play
-    def play(self, scene, *args, **kwargs):
+    def play(
+        self, scene: Scene, *args: Animation | Mobject | _AnimationBuilder, **kwargs
+    ):
         # TODO: Handle data locking / unlocking.
         self.animation_start_time = time.time()
         self.file_writer.begin_animation(not self.skip_animations)
@@ -440,11 +455,13 @@
         self.time += scene.duration
         self.num_plays += 1
 
-    def clear_screen(self):
+    def clear_screen(self) -> None:
         self.frame_buffer_object.clear(*self.background_color)
         self.window.swap_buffers()
 
-    def render(self, scene, frame_offset, moving_mobjects):
+    def render(
+        self, scene: Scene, frame_offset, moving_mobjects: list[Mobject]
+    ) -> None:
         self.update_frame(scene)
 
         if self.skip_animations: