Type annotations for manim/scene/*.py #3981

henrikmidtiby · 2024-10-26T20:51:48Z

Overview: What does this pull request change?

The pull request add type annotations to the files manim/scene/*.py and some of its dependencies.
The request is still a work in progress, as mypy currently lists 90 errors.
With the pull request I hope to get some feedback and advise on how to proceed with the work.

The pull request is a continuation of the work in #3961

Motivation and Explanation: Why and how do your changes improve the library?

Type annotations help identify errors during development.

Further Information and Comments

I would suggest to make some changes to certain default values.
https://github.com/henrikmidtiby/manim/blob/6c137ee0f9f7b414bd5c1e0b6657eeaab005e088/manim/scene/scene.py#L128-L131
https://github.com/henrikmidtiby/manim/blob/6c137ee0f9f7b414bd5c1e0b6657eeaab005e088/manim/scene/scene.py#L119-L122
https://github.com/henrikmidtiby/manim/blob/6c137ee0f9f7b414bd5c1e0b6657eeaab005e088/manim/scene/scene.py#L119-L122

A change related to the background of a new Camera instance.
https://github.com/henrikmidtiby/manim/blob/6c137ee0f9f7b414bd5c1e0b6657eeaab005e088/manim/scene/vector_space_scene.py#L133-L135

It appears as the property target_text is not really used for something.
https://github.com/henrikmidtiby/manim/blob/6c137ee0f9f7b414bd5c1e0b6657eeaab005e088/manim/scene/vector_space_scene.py#L1117-L1122

In some cases I have chosen to insert assertions about the type of certain data.
See e.g. here. Is this a suitable approach?
https://github.com/henrikmidtiby/manim/blob/6c137ee0f9f7b414bd5c1e0b6657eeaab005e088/manim/scene/scene.py#L1333

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

…her files

…ct.py

…e_matchers.py

…ructor.

…he constructor." This reverts commit 80ae857.

…sonGrace2282

This reverts commit d477c9a.

… from JasonGrace2282" This reverts commit 07bbe3f.

Error count: 308 -> 303

Error count: 303 -> 272

…y file Error count: 272 -> 343

Error count: 332 -> 330

Error count: 330 -> 285

Error count: 285 -> 282

Error count: 282 -> 281

Error count: 267

Error count: 267 -> 248

Error count: 248 -> 216

Error count: 216 -> 225

…era is the OpenGLCamera Error count: 225 -> 182

Error count: 182 -> 167

…rtain methods. This is mainly related to interactive elements and the 3D camera used in the ThreeDScene Error count: 167 -> 143

Error count: 143 -> 143

Error count: 143 -> 131

Error count: 131 -> 121

Error count: 121 -> 116

Error count: 116 -> 112

Error count: 112 -> 102

Error count: 102 -> 97

Error count: 97 -> 90

Error count: 90 -> 66

manim/gui/gui.py

@@ -11,6 +11,8 @@


 from .. import __version__, config
+from ..renderer.cairo_renderer import CairoRenderer


manim/gui/gui.py

@@ -11,6 +11,8 @@


 from .. import __version__, config
+from ..renderer.cairo_renderer import CairoRenderer
+from ..renderer.opengl_renderer import OpenGLRenderer


manim/renderer/opengl_renderer.py

+if TYPE_CHECKING:
+    from typing_extensions import Self
+
+    from manim.mobject.mobject import Mobject


manim/renderer/opengl_renderer.py

+    from typing_extensions import Self
+
+    from manim.mobject.mobject import Mobject
+    from manim.scene.scene import Scene


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, OpenGLRenderer


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]:


manim/scene/scene.py

@@ -493,7 +514,7 @@
                self.add(mob)
                curr_mobjects += mob.get_family()

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


manim/scene/scene.py

        if not self.check_interactive_embed_is_valid():
            return
        self.interactive_mode = True

-        def ipython(shell, namespace):
+        def ipython(shell: InteractiveShellEmbed, namespace: dict[str, Any]) -> None:


manim/scene/scene_file_writer.py

 from .section import DefaultSectionType, Section

 if TYPE_CHECKING:
+    from manim.renderer.cairo_renderer import CairoRenderer


manim/utils/family_ops.py

+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from manim.mobject.mobject import Mobject


… not used anywhere.

henrikmidtiby · 2024-11-03T19:29:18Z

@JasonGrace2282 I need some help to proceed with this work.

At the current state of the code, there are 75 errors from mypy when the errors from mypy-manim.scene is no longer ignored.
The 75 errors are listed below.
I would love to get rid of the issues, but I think that it requires more indepth knowledge of the codebase and the intended code style to choose the proper solutions.

$ mypy
manim/scene/zoomed_scene.py:180: error: Item "OpenGLCamera" of "Camera | OpenGLCamera" has no attribute "frame_height"  [union-attr]
manim/scene/zoomed_scene.py:181: error: Item "OpenGLCamera" of "Camera | OpenGLCamera" has no attribute "frame_width"  [union-attr]
manim/scene/vector_space_scene.py:132: error: Missing positional argument "scene" in call to "update_frame" of "CairoRenderer"  [call-arg]
manim/scene/vector_space_scene.py:132: error: Missing positional argument "scene" in call to "update_frame"  [call-arg]
manim/scene/vector_space_scene.py:157: error: "VectorScene" has no attribute "plane"  [attr-defined]
manim/scene/vector_space_scene.py:158: error: "VectorScene" has no attribute "plane"  [attr-defined]
manim/scene/vector_space_scene.py:548: error: Argument 1 to "VMobject" has incompatible type "*Generator[Dot, None, None]"; expected "ManimColor | int | str | tuple[int, int, int] | tuple[float, float, float] | <6 more items> | None"  [arg-type]
manim/scene/vector_space_scene.py:548: error: Argument 1 to "VMobject" has incompatible type "*Generator[Dot, None, None]"; expected "float"  [arg-type]
manim/scene/vector_space_scene.py:548: error: Argument 1 to "VMobject" has incompatible type "*Generator[Dot, None, None]"; expected "LineJointType | None"  [arg-type]
manim/scene/vector_space_scene.py:548: error: Argument 1 to "VMobject" has incompatible type "*Generator[Dot, None, None]"; expected "ndarray[Any, dtype[floating[_64Bit]]]"  [arg-type]
manim/scene/vector_space_scene.py:548: error: Argument 1 to "VMobject" has incompatible type "*Generator[Dot, None, None]"; expected "bool"  [arg-type]
manim/scene/vector_space_scene.py:548: error: Argument 1 to "VMobject" has incompatible type "*Generator[Dot, None, None]"; expected "Image | str | None"  [arg-type]
manim/scene/vector_space_scene.py:548: error: Argument 1 to "VMobject" has incompatible type "*Generator[Dot, None, None]"; expected "int"  [arg-type]
manim/scene/vector_space_scene.py:548: error: Argument 1 to "VMobject" has incompatible type "*Generator[Dot, None, None]"; expected "CapStyleType"  [arg-type]
manim/scene/vector_space_scene.py:677: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "Sequence[float] | None"  [arg-type]
manim/scene/vector_space_scene.py:677: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "float | None"  [arg-type]
manim/scene/vector_space_scene.py:677: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "dict[str, Any] | None"  [arg-type]
manim/scene/vector_space_scene.py:677: note: "Dict" is invariant -- see https://mypy.readthedocs.io/en/stable/common_issues.html#variance
manim/scene/vector_space_scene.py:677: note: Consider using "Mapping" instead, which is covariant in the value type
manim/scene/vector_space_scene.py:677: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "int"  [arg-type]
manim/scene/vector_space_scene.py:677: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "bool"  [arg-type]
manim/scene/vector_space_scene.py:677: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "dict[str, Any]"  [arg-type]
manim/scene/vector_space_scene.py:684: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "Sequence[float] | None"  [arg-type]
manim/scene/vector_space_scene.py:684: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "float | None"  [arg-type]
manim/scene/vector_space_scene.py:684: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "dict[str, Any] | None"  [arg-type]
manim/scene/vector_space_scene.py:684: note: "Dict" is invariant -- see https://mypy.readthedocs.io/en/stable/common_issues.html#variance
manim/scene/vector_space_scene.py:684: note: Consider using "Mapping" instead, which is covariant in the value type
manim/scene/vector_space_scene.py:684: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "int"  [arg-type]
manim/scene/vector_space_scene.py:684: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "bool"  [arg-type]
manim/scene/vector_space_scene.py:684: error: Argument 1 to "NumberPlane" has incompatible type "**dict[str, object]"; expected "dict[str, Any]"  [arg-type]
manim/scene/vector_space_scene.py:729: error: Signature of "add_foreground_mobject" incompatible with supertype "Scene"  [override]
manim/scene/vector_space_scene.py:729: note:      Superclass:
manim/scene/vector_space_scene.py:729: note:          def add_foreground_mobject(self, mobject: Mobject) -> Scene
manim/scene/vector_space_scene.py:729: note:      Subclass:
manim/scene/vector_space_scene.py:729: note:          def add_foreground_mobject(self, *mobjects: Mobject) -> None
manim/scene/vector_space_scene.py:940: error: "MathTex" has no attribute "target_text"  [attr-defined]
manim/scene/vector_space_scene.py:942: error: "MathTex" has no attribute "target_text"  [attr-defined]
manim/scene/vector_space_scene.py:945: error: "MathTex" has no attribute "vector"  [attr-defined]
manim/scene/vector_space_scene.py:946: error: "MathTex" has no attribute "kwargs"  [attr-defined]
manim/scene/vector_space_scene.py:947: error: "Never" has no attribute "__iter__" (not iterable)  [attr-defined]
manim/scene/vector_space_scene.py:948: error: "Never" has no attribute "pop"  [attr-defined]
manim/scene/vector_space_scene.py:1119: error: Incompatible types in assignment (expression has type "MethodType", variable has type "MathTex | str")  [assignment]
manim/scene/vector_space_scene.py:1120: error: Argument after ** must be a mapping, not "MethodType"  [arg-type]
manim/scene/vector_space_scene.py:1121: error: "MethodType" has no attribute "target"  [attr-defined]
manim/scene/three_d_scene.py:138: error: Incompatible types in assignment (expression has type "ThreeDCamera", variable has type "OpenGLCamera")  [assignment]
manim/scene/three_d_scene.py:167: error: "ThreeDCamera" has no attribute "clear_updaters"  [attr-defined]
manim/scene/three_d_scene.py:282: error: "ThreeDCamera" has no attribute "copy"  [attr-defined]
manim/scene/three_d_scene.py:297: error: "ThreeDCamera" has no attribute "height"  [attr-defined]
manim/scene/three_d_scene.py:299: error: "object" object is not iterable  [misc]
manim/scene/three_d_scene.py:307: error: Cannot determine type of "method"  [has-type]
manim/scene/three_d_scene.py:315: error: Argument "mobject" to "Transform" has incompatible type "ThreeDCamera"; expected "Mobject | None"  [arg-type]
manim/scene/three_d_scene.py:449: error: "ThreeDScene" has no attribute "default_camera_orientation_kwargs"; maybe "default_angled_camera_orientation_kwargs" or "set_camera_orientation"?  [attr-defined]
manim/scene/three_d_scene.py:505: error: "CairoRenderer" has no attribute "camera_config"  [attr-defined]
manim/scene/scene_file_writer.py:45: error: Function is missing a type annotation  [no-untyped-def]
manim/scene/scene_file_writer.py:62: error: Function is missing a return type annotation  [no-untyped-def]
manim/scene/scene_file_writer.py:70: error: "Stream" has no attribute "encode"  [attr-defined]
manim/scene/scene_file_writer.py:73: error: "Stream" has no attribute "encode"  [attr-defined]
manim/scene/scene_file_writer.py:372: error: Argument 2 to "convert_audio" has incompatible type "_TemporaryFileWrapper[bytes]"; expected "Path"  [arg-type]
manim/scene/scene_file_writer.py:433: error: Argument 1 to "from_ndarray" of "VideoFrame" has incompatible type "ndarray[Any, dtype[signedinteger[_64Bit]]]"; expected "ndarray[Any, dtype[unsignedinteger[_8Bit]]] | ndarray[Any, dtype[unsignedinteger[_16Bit]]] | ndarray[Any, dtype[floating[_32Bit]]]"  [arg-type]
manim/scene/scene_file_writer.py:434: error: Cannot determine type of "video_stream"  [has-type]
manim/scene/scene_file_writer.py:435: error: Cannot determine type of "video_container"  [has-type]
manim/scene/scene_file_writer.py:453: error: Item "ndarray[Any, Any]" of "ndarray[Any, Any] | OpenGLRenderer" has no attribute "get_frame"  [union-attr]
manim/scene/scene_file_writer.py:463: error: Item "ndarray[Any, Any]" of "ndarray[Any, Any] | OpenGLRenderer" has no attribute "get_image"  [union-attr]
manim/scene/scene_file_writer.py:465: error: Argument 1 to "fromarray" has incompatible type "ndarray[Any, Any] | OpenGLRenderer"; expected "SupportsArrayInterface"  [arg-type]
manim/scene/scene_file_writer.py:536: error: Call to untyped function "to_av_frame_rate" in typed context  [no-untyped-call]
manim/scene/scene_file_writer.py:664: error: Call to untyped function "to_av_frame_rate" in typed context  [no-untyped-call]
manim/scene/scene_file_writer.py:690: error: Incompatible types in assignment (expression has type "VideoFrame | AudioFrame", variable has type "VideoFrame")  [assignment]
manim/scene/scene.py:156: error: Argument "camera_class" to "CairoRenderer" has incompatible type "type[Camera]"; expected "Camera | None"  [arg-type]
manim/scene/scene.py:183: error: Argument 2 to "deepcopy" has incompatible type "list[Any]"; expected "dict[int, Any] | None"  [arg-type]
manim/scene/scene.py:229: error: Missing return statement  [return]
manim/scene/scene.py:246: error: Item "CairoRenderer" of "CairoRenderer | OpenGLRenderer" has no attribute "clear_screen"  [union-attr]
manim/scene/scene.py:459: error: Name "OpenGLMobject" is not defined  [name-defined]
manim/scene/scene.py:485: error: Argument 1 to "remove" of "Scene" has incompatible type "*list[Object3D]"; expected "Mobject"  [arg-type]
manim/scene/scene.py:512: error: Argument 1 to "__iadd__" of "list" has incompatible type "Sequence[OpenGLMobject]"; expected "Iterable[Mobject]"  [arg-type]
manim/scene/scene.py:1325: error: Item "OpenGLRenderer" of "CairoRenderer | OpenGLRenderer" has no attribute "static_image"  [union-attr]
manim/scene/scene.py:1386: error: Item "None" of "FrameType | None" has no attribute "f_back"  [union-attr]
manim/scene/scene.py:1386: error: Item "None" of "FrameType | Any | None" has no attribute "f_locals"  [union-attr]
manim/scene/scene.py:1498: error: Item "None" of "PromptSession[Any] | None" has no attribute "app"  [union-attr]
manim/scene/scene.py:1540: error: Item "None" of "FrameType | None" has no attribute "f_locals"  [union-attr]
manim/scene/scene.py:1669: error: Item "CairoRenderer" of "CairoRenderer | OpenGLRenderer" has no attribute "pressed_keys"  [union-attr]
manim/scene/scene.py:1681: error: Argument "about_point" to "scale" of "OpenGLMobject" has incompatible type "ndarray[Any, dtype[floating[_64Bit]]]"; expected "Sequence[float] | None"  [arg-type]
manim/scene/scene.py:1699: error: Too few arguments  [call-arg]
manim/scene/moving_camera_scene.py:138: error: Item "OpenGLCamera" of "Any | OpenGLCamera" has no attribute "get_mobjects_indicating_movement"  [union-attr]
Found 75 errors in 6 files (checked 163 source files)

JasonGrace2282 · 2024-11-04T13:57:49Z

Firstly, I recommend that you resolve conflicts with the master branch :)
Your issues with OpenGL* not having attributes can probably be type ignored (you'd have to check if they're in the appropriate if config.render block).
For the ones about variance, check if you need the mutability. If you don't, Mapping might be a better fit over Dict.
Otherwise, I suspect you might need to add a lot of assert statements to get mypy to figure out the right type (see type narrowing)?

henrikmidtiby · 2024-11-04T21:27:16Z

@JasonGrace2282 Thanks for the input.
At the moment I can't figure out where to begin with the current state of this PR, so I started to work on a smaller PR here: #3999
I expect to get back to this PR later.

henrikmidtiby added 30 commits October 28, 2024 08:34

Removed typing errors in mobject/geometry/shape_matchers.py

ba5c73a

Added type annotations fo mobject/types/image_mobject.py and a few ot…

c6e071f

…her files

Adding type annotations to types/point_cloud_mobject.py

758e199

Fixing issues revealed by type annotations in types/point_cloud_mobje…

b54a624

…ct.py

Fix issue in the CI step related to the Camera class.

bdf0049

Adding type annotations to geometry/line.py

1962c73

Ignore type errors related to super and sub class in line.py and shap…

92d9908

…e_matchers.py

Dealing with some issues and ignoring others identified by type checking

bd4f02a

Ignored a number of type issues related to float and floating[Any].

a4bda5d

Help mypy to determine types.

45e18e8

More work on addressing typing issues.

c29a38e

Reverting two changes that triggers an error in the automatic testing.

11e6ffa

Further work on type hinting.

935fd0c

Avoid forwarding positional arguments from Arrow to Line in the const…

00f546d

…ructor.

Revert "Avoid forwarding positional arguments from Arrow to Line in t…

020a777

…he constructor." This reverts commit 80ae857.

Removed several type ignore statements and addressed comments from Ja…

ef6158a

…sonGrace2282

Revert "Activate mypy check of mobject.geometry.*"

e79fd75

This reverts commit d477c9a.

Revert "Removed several type ignore statements and addressed comments…

c85a19d

… from JasonGrace2282" This reverts commit 07bbe3f.

Added type annotations to zoomed_scene.py

6243990

Error count: 308 -> 303

Adding type annotations to all methods in vector_space_scene.py

ae06d89

Error count: 303 -> 272

Get rid of no-untyped-call errors from my in the vector_space_scene.p…

8d6d9c4

…y file Error count: 272 -> 343

Handle type issues related to ManimColor in vector_space_scene.py

e2284b1

Handle var-annotated issues in vector_space_scene.py

bfe61b0

Error count: 332 -> 330

Handling has-type type errors in vector_space_scene.py

eae2296

Error count: 330 -> 285

Handled name-defined type issues in vector_space_scene.py

9dd785a

Error count: 285 -> 282

Address type issue with calling an untyped method.

822dba2

Error count: 282 -> 281

Fix some typing issues in transform_mathcing_parts.py

501d774

Change stroke_width to float in vector_space_scene.py

fa9cad9

Handled a few type errors.

99c12c0

Error count: 267

Handled several typing issues in three_d_scene.py

dee6ef9

Error count: 267 -> 248

henrikmidtiby added 14 commits October 28, 2024 08:47

Dealing with type errors in scene_file_writer.py

5bf2d0e

Error count: 248 -> 216

Ensured that all methods in scene.py have type declarations.

da35261

Error count: 216 -> 225

Handle type issues related to interactivity by asserting that the cam…

79790db

…era is the OpenGLCamera Error count: 225 -> 182

Handle type issues in scene.py

080113f

Error count: 182 -> 167

Asserting that the renderer or camera is of the proper type to use ce…

abd7022

…rtain 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

3fc6197

Error count: 143 -> 143

Handling no-untyped-call type errors in manim/scene/scene.py

c5d5743

Error count: 143 -> 131

Handling assignment type errors in manim/scene/*.py

90de428

Error count: 131 -> 121

Handling arg-type type errors in manim/scene/*.py

0a8c41e

Error count: 121 -> 116

Handling arg-type type errors in manim/scene/*.py

e8d9741

Error count: 116 -> 112

Fixing various type errors

059566e

Error count: 112 -> 102

Fixing various type errors

5bba091

Error count: 102 -> 97

Fixing various type errors

1165469

Error count: 97 -> 90

Some aggressive changes to silence a significant number of type errors.

4c14674

Error count: 90 -> 66

henrikmidtiby force-pushed the type_annotations_scene branch from 6c137ee to 4c14674 Compare October 28, 2024 07:51

github-advanced-security bot found potential problems Oct 28, 2024

View reviewed changes

henrikmidtiby added 6 commits October 28, 2024 08:55

Commented out an import (IPython) that makes the CI tests fail.

bf7a82f

Fix various type errors.

a172b37

More type annotations.

21965d1

Code cleanup.

4a31821

Remove the property mobject_updater_lists of the Scene class as it is…

ab59045

… not used anywhere.

Handle import-untyped typing issues.

54cbe6c

henrikmidtiby mentioned this pull request Nov 4, 2024

Adding type annotations to manim.utils.* #3999

Open

3 tasks

chopan050 mentioned this pull request Nov 7, 2024

Add a time property to scene #3997

Merged

henrikmidtiby mentioned this pull request Nov 14, 2024

Typing progress tracker #3375

Open

22 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Type annotations for manim/scene/*.py #3981

Type annotations for manim/scene/*.py #3981

henrikmidtiby commented Oct 26, 2024

henrikmidtiby commented Nov 3, 2024

JasonGrace2282 commented Nov 4, 2024

henrikmidtiby commented Nov 4, 2024

		@@ -11,6 +11,8 @@


		from .. import __version__, config
		from ..renderer.cairo_renderer import CairoRenderer

Type annotations for manim/scene/*.py #3981

Are you sure you want to change the base?

Type annotations for manim/scene/*.py #3981

Conversation

henrikmidtiby commented Oct 26, 2024

Overview: What does this pull request change?

Motivation and Explanation: Why and how do your changes improve the library?

Further Information and Comments

Reviewer Checklist

henrikmidtiby commented Nov 3, 2024

JasonGrace2282 commented Nov 4, 2024

henrikmidtiby commented Nov 4, 2024