Adding type annotations to scene.py and vector_space_scene.py #4260

henrikmidtiby · 2025-05-26T14:46:38Z

Overview: What does this pull request change?

Further Information and Comments

This pull request is related to the ongoing effort of adding type annotations to Manim
#3375

Reviewer Checklist

The PR title is descriptive enough for the changelog, and the PR is labeled correctly
If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
If applicable: newly added functions and classes are tested

Count: 307 errors Type annotations on scene/vector_space_scene.py Add type annotations to scene/vector_space_scene.py Mypy count: 210 Reverting two changes that triggers an error in the automatic testing. Further work on type hinting. Avoid forwarding positional arguments from Arrow to Line in the constructor. Revert "Avoid forwarding positional arguments from Arrow to Line in the constructor." This reverts commit 80ae857. Removed several type ignore statements and addressed comments from JasonGrace2282 Revert "Activate mypy check of mobject.geometry.*" This reverts commit d477c9a. Revert "Removed several type ignore statements and addressed comments from JasonGrace2282" This reverts commit 07bbe3f. Added type annotations to zoomed_scene.py Error count: 308 -> 303 Adding type annotations to all methods in vector_space_scene.py Error count: 303 -> 272 Get rid of no-untyped-call errors from my in the vector_space_scene.py file Error count: 272 -> 343 Handle type issues related to ManimColor in vector_space_scene.py Handle var-annotated issues in vector_space_scene.py Error count: 332 -> 330 Handling has-type type errors in vector_space_scene.py Error count: 330 -> 285 Handled name-defined type issues in vector_space_scene.py Error count: 285 -> 282 Address type issue with calling an untyped method. Error count: 282 -> 281 Fix some typing issues in transform_mathcing_parts.py Change stroke_width to float in vector_space_scene.py Handled a few type errors. Error count: 267 Handled several typing issues in three_d_scene.py Error count: 267 -> 248 Dealing with type errors in scene_file_writer.py Error count: 248 -> 216 Ensured that all methods in scene.py have type declarations. Error count: 216 -> 225 Handle type issues related to interactivity by asserting that the camera is the OpenGLCamera Error count: 225 -> 182 Handle type issues in scene.py Error count: 182 -> 167 Asserting that the renderer or camera is of the proper type to use certain methods. This is mainly related to interactive elements and the 3D camera used in the ThreeDScene Error count: 167 -> 143 Avoid cyclic import of dependencies Error count: 143 -> 143 Handling no-untyped-call type errors in manim/scene/scene.py Error count: 143 -> 131 Handling assignment type errors in manim/scene/*.py Error count: 131 -> 121 Handling arg-type type errors in manim/scene/*.py Error count: 121 -> 116 Handling arg-type type errors in manim/scene/*.py Error count: 116 -> 112 Fixing various type errors Error count: 112 -> 102 Fixing various type errors Error count: 102 -> 97 Fixing various type errors Error count: 97 -> 90 Some aggressive changes to silence a significant number of type errors. Error count: 90 -> 66 Commented out an import (IPython) that makes the CI tests fail. Fix various type errors. More type annotations. Code cleanup. Remove the property mobject_updater_lists of the Scene class as it is not used anywhere. Handle import-untyped typing issues. More work on type annotations in manin/scene/.* More work on scenes/*.py looking at the dependency opengl_renderer.py More work on types in scenes/*.py Ignored an old bunch of type ignore statements. More work on dependencies for scene.py More work on dependencies for scene.py

mypy error count: 307

manim/renderer/opengl_renderer.py

+from manim.mobject.opengl.opengl_mobject import (
+    OpenGLMobject,
+    OpenGLPoint,
+    _AnimationBuilder,
+)


manim/renderer/opengl_renderer.py

    render_opengl_vectorized_mobject_stroke,
 )

+if TYPE_CHECKING:


manim/renderer/opengl_renderer.py

+    import numpy.typing as npt
+    from typing_extensions import Self
+
+    from manim.animation.animation import Animation


manim/scene/scene.py


 from .. import config, logger
 from ..animation.animation import Animation, Wait, prepare_animation
 from ..camera.camera import Camera
 from ..constants import *
 from ..gui.gui import configure_pygui
 from ..renderer.cairo_renderer import CairoRenderer
-from ..renderer.opengl_renderer import OpenGLRenderer
+from ..renderer.opengl_renderer import OpenGLCamera, OpenGLMobject, OpenGLRenderer


manim/scene/scene.py


 from .. import config, logger
 from ..animation.animation import Animation, Wait, prepare_animation
 from ..camera.camera import Camera
 from ..constants import *
 from ..gui.gui import configure_pygui
 from ..renderer.cairo_renderer import CairoRenderer
-from ..renderer.opengl_renderer import OpenGLRenderer
+from ..renderer.opengl_renderer import OpenGLCamera, OpenGLMobject, OpenGLRenderer


for more information, see https://pre-commit.ci

manim/gui/gui.py

 from .. import __version__, config
 from ..utils.module_ops import scene_classes_from_file

+if TYPE_CHECKING:
+    from ..renderer.opengl_renderer import OpenGLRenderer


manim/renderer/opengl_renderer.py

@@ -35,6 +38,15 @@
    render_opengl_vectorized_mobject_stroke,
 )

+if TYPE_CHECKING:


manim/renderer/opengl_renderer.py

@@ -411,8 +423,12 @@
            self.skip_animations = True
            raise EndSceneEarlyException()

+    from manim.utils.caching import handle_caching_play


manim/scene/scene.py

 from ..constants import *
 from ..gui.gui import configure_pygui
 from ..renderer.cairo_renderer import CairoRenderer
-from ..renderer.opengl_renderer import OpenGLRenderer
+from ..renderer.opengl_renderer import OpenGLCamera, OpenGLMobject, OpenGLRenderer


manim/renderer/opengl_renderer.py

@@ -216,6 +226,8 @@


 class OpenGLRenderer:
+    from ..scene.scene_file_writer import SceneFileWriter


manim/renderer/opengl_renderer.py

+
+
+if TYPE_CHECKING:
+    from manim.scene.scene import Scene


manim/renderer/opengl_renderer.py

+    from typing_extensions import Self
+
+    from manim.animation.animation import Animation
+    from manim.mobject.mobject import Mobject


manim/scene/scene.py

            num_families = sum((mobject in family) for family in families)
            return num_families == 1

        return list(filter(is_top_level, self.mobjects))

-    def get_mobject_family_members(self):
+    def get_mobject_family_members(self) -> list[mobject.Mobject]:


manim/scene/scene.py

@@ -448,7 +456,7 @@
                use_z_index=self.renderer.camera.use_z_index,
            )

-    def add(self, *mobjects: Mobject):
+    def add(self, *mobjects: mobject.Mobject | OpenGLMobject) -> Self:


manim/scene/scene.py


-    def remove(self, *mobjects: Mobject):
+    def remove(self, *mobjects: mobject.Mobject) -> Self:


manim/scene/scene.py


-    def remove(self, *mobjects: Mobject):
+    def remove(self, *mobjects: mobject.Mobject) -> Self:


manim/scene/scene.py

@@ -703,7 +727,7 @@
        return new_mobjects

    # TODO, remove this, and calls to this
-    def add_foreground_mobjects(self, *mobjects: Mobject):
+    def add_foreground_mobjects(self, *mobjects: mobject.Mobject) -> Scene:


manim/scene/scene.py

@@ -739,7 +763,7 @@
        """
        return self.add_foreground_mobjects(mobject)

-    def remove_foreground_mobjects(self, *to_remove: Mobject):
+    def remove_foreground_mobjects(self, *to_remove: mobject.Mobject) -> Scene:


manim/scene/scene.py

@@ -774,7 +798,7 @@
        """
        return self.remove_foreground_mobjects(mobject)

-    def bring_to_front(self, *mobjects: Mobject):
+    def bring_to_front(self, *mobjects: mobject.Mobject) -> Scene:


manim/scene/scene.py

@@ -793,7 +817,7 @@
        self.add(*mobjects)
        return self

-    def bring_to_back(self, *mobjects: Mobject):
+    def bring_to_back(self, *mobjects: mobject.Mobject) -> Scene:


henrikmidtiby added 2 commits May 26, 2025 13:02

Stop ignoring errors from manim/scene/scene.py

329e98a

mypy error count: 307

github-project-automation bot added this to Dev Board May 26, 2025

github-project-automation bot moved this to 🆕 New in Dev Board May 26, 2025

github-advanced-security bot found potential problems May 26, 2025

View reviewed changes

henrikmidtiby added 18 commits May 26, 2025 20:53

Adding type annotations to scene.py (C1)

294ea2a

Adding type annotations to scene.py (C2.1)

b8fa2c0

Adding type annotations to scene.py (C2.2)

68d5939

Adding type annotations to scene.py (C2.3)

94a56a0

Adding type annotations to scene.py (C3)

ca87c16

Adding type annotations to scene.py (C4)

f920d03

Adding type annotations to scene.py (C5)

86af814

Adding type annotations to scene.py (C6)

9bfc983

Adding type annotations to scene.py (C7)

591bc77

...

9a8f9bc

Focus on scene.py

241ebb0

Adding type annotations to vector_space_scene.py

e93dd55

Added types to opengl_renderer.py

203124f

Added types to cairo_renderer.py

2760cb2

Fixed the last mypy errors in scene.py - many was ignored

5215c9b

Fixed the last mypy errors in vector_space_scene.py - many was ignored

6a53cc1

Got rid of the last mypy errors.

d0bb1c0

Activate mypy check of vector_space_scene.py

04a437d

henrikmidtiby force-pushed the Typing_scene_take_two branch from 4b40f10 to 04a437d Compare May 26, 2025 19:33

pre-commit-ci bot and others added 2 commits May 26, 2025 19:33

[pre-commit.ci] auto fixes from pre-commit.com hooks

ce046c4

for more information, see https://pre-commit.ci

Code cleanup.

2e45b3b

github-advanced-security bot found potential problems May 27, 2025

View reviewed changes

manim/renderer/opengl_renderer.py Fixed Show fixed Hide fixed

manim/renderer/opengl_renderer.py Fixed Show fixed Hide fixed

manim/renderer/opengl_renderer.py Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems May 27, 2025

View reviewed changes

manim/scene/scene.py Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems May 27, 2025

View reviewed changes

henrikmidtiby force-pushed the Typing_scene_take_two branch from 8c6fc74 to 2e45b3b Compare May 27, 2025 11:34

henrikmidtiby mentioned this pull request May 27, 2025

Typing scene #4191

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adding type annotations to scene.py and vector_space_scene.py #4260

Adding type annotations to scene.py and vector_space_scene.py #4260

henrikmidtiby commented May 26, 2025

Uh oh!

Check notice

Check failure

Check failure

Check failure

Check failure

Check failure

Check failure

Check failure

Check failure

Uh oh!

Uh oh!

Uh oh!

Check failure

Check failure

Check failure

Uh oh!

Check notice

Check failure

Check notice

Check failure

Check failure

Check failure

Check failure

Check failure

Uh oh!

		@@ -216,6 +226,8 @@


		class OpenGLRenderer:
		from ..scene.scene_file_writer import SceneFileWriter


		def remove(self, *mobjects: Mobject):
		def remove(self, *mobjects: mobject.Mobject) -> Self:

Adding type annotations to scene.py and vector_space_scene.py #4260

Are you sure you want to change the base?

Adding type annotations to scene.py and vector_space_scene.py #4260

Conversation

henrikmidtiby commented May 26, 2025

Overview: What does this pull request change?

Further Information and Comments

Reviewer Checklist

Uh oh!

Check notice

Uh oh!

Check failure

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check failure

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check failure

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!