Add type annotations to `mobject.py` by henrikmidtiby · Pull Request #4388 · ManimCommunity/manim

henrikmidtiby · 2025-08-10T19:00:58Z

Overview: What does this pull request change?

This PR add type annotations to mobject.py.

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

henrikmidtiby · 2025-08-10T20:00:10Z

+            # error: Argument "tip" to "add_tip" of "TipableVMobject" has incompatible type "VMobject"; expected "ArrowTip | None"  [arg-type]
            self.add_tip(tip=old_tips[0])
        if has_start_tip:
+            # error: Argument "tip" to "add_tip" of "TipableVMobject" has incompatible type "VMobject"; expected "ArrowTip | None"  [arg-type]
            self.add_tip(tip=old_tips[1], at_start=True)


These issues can be handled by typing.cast, but I don't think that is the best way to deal with them.

henrikmidtiby · 2025-08-10T20:02:48Z

+    def __getitem__(self, key: int) -> VMobject:
+        return self.submobjects[key]
+


This method is used to define the return type when indexing into a VGroup. If the super class was used, this would return a Mobject, but in a VGroup it should be a VMobject.

henrikmidtiby · 2025-08-10T20:05:06Z

+        temp = self.get_basis_vectors()
+        i_hat = temp.submobjects[0]
+        j_hat = temp.submobjects[1]


Apparently the trick for defining the type of elements in a VGroup to be VMobject's does not work here. Which is the reason for this workaround.

That's strange, but OK...

henrikmidtiby · 2025-08-10T20:06:02Z

+        temp = array.get_entries()
+        x_coord = temp.submobjects[0]
+        y_coord = temp.submobjects[1]


Apparently the trick for defining the type of elements in a VGroup to be VMobject's does not work here. Which is the reason for this workaround.

henrikmidtiby · 2025-08-10T20:06:45Z

    reference_colors: Sequence[ParsableManimColor],
    length_of_output: int,
-) -> list[ManimColor] | ManimColor:
+) -> list[ManimColor]:


Same change as in PR #4380

henrikmidtiby · 2025-08-10T20:07:00Z

    """
    if length_of_output == 0:
-        return ManimColor(reference_colors[0])
+        return [ManimColor(reference_colors[0])]


Same change as in PR #4380.

henrikmidtiby · 2025-08-10T20:11:09Z

+    animation_overrides: dict[
+        type[Animation],
+        FunctionOverride,
+    ] = {}


By specifying the type of animation_overrides here, a lot of type errors like "type[Mobject]" has no attribute "animation_overrides" are removed.

henrikmidtiby · 2025-08-11T12:24:35Z

One of the main contributions in this PR is that when accessing elements in a VGroup, the type of these elements are now recognized as VMobjects.

This is achieved by adding/modifying these methods including type annotations to the VMobject class.

def __iter__(self) -> Iterator[VMobject]:
    return iter(self.split())
def split(self) -> list[VMobject]:
    result: list[VMobject] = [self] if len(self.points) > 0 else []
    return result + self.submobjects

And these to the VGroup class.

def __getitem__(self, key: int) -> VMobject:
    return self.submobjects[key]

…2282

… code for the remaning 10 errors

…in elements during runtime and not only during type checking

…future cleanup task

Co-authored-by: Francisco Manríquez Novoa <49853152+chopan050@users.noreply.github.com>

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

+        margin: float,
+        only_mobjects_in_frame: bool,
+        animate: Literal[False],
+    ) -> Mobject: ...


+        margin: float,
+        only_mobjects_in_frame: bool,
+        animate: Literal[True],
+    ) -> _AnimationBuilder: ...


henrikmidtiby · 2025-12-04T22:03:15Z

@chopan050 Thanks for all the comments, even the minor nitpicks! I feel they help me improving the PR.
I will get back to resolving the remaining suggestions in the coming days.

henrikmidtiby · 2025-12-05T08:34:11Z

The raise ValueError is now handled.
Then I discovered a new issue, with the following example

from manim import *

# Scene derived from the example given in the documentation
class TableExamples(Scene):
    def construct(self):
        t2 = MathTable(
            [["+", 0, 5, 10],
            [0, 0, 5, 10],
            [2, 2, 7, 12],
            [4, 4, 9, 14]],
            include_outer_lines=True)

        for line in t2.get_horizontal_lines()[:3]:
            line.set_color(BLUE)

        t2.get_vertical_lines().set_color(BLUE)
        t2.get_vertical_lines()[0].set_color(BLUE)

        # AttributeError: 'list' object has no attribute 'set_color'
        t2.get_vertical_lines()[:3].set_color(BLUE)

I have attempted to solve the issue through implementing a __getitem__ method in the VGroup class. But apparently it does not work... Here is the used implementation.

    def __getitem__(self, item: int) -> Self:
        return self.submobjects[item]

# Conflicts: # manim/mobject/matrix.py # manim/mobject/mobject.py # manim/mobject/types/vectorized_mobject.py

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

Replace Self with _UpdateBuilder

chopan050

LGTM!

github-project-automation Bot added this to Dev Board Aug 10, 2025

github-project-automation Bot moved this to 🆕 New in Dev Board Aug 10, 2025

henrikmidtiby commented Aug 10, 2025

View reviewed changes

github-advanced-security AI found potential problems Aug 10, 2025

View reviewed changes

Comment thread manim/mobject/mobject.py Fixed

henrikmidtiby changed the title ~~Typing mobject.py~~ Add type annotations to mobject.py Aug 13, 2025

henrikmidtiby mentioned this pull request Aug 13, 2025

Typing progress tracker #3375

Open

22 tasks

RBerga06 mentioned this pull request Aug 15, 2025

Add type annotations to opengl_mobject.py #4398

Merged

3 tasks

henrikmidtiby marked this pull request as ready for review August 21, 2025 21:31

henrikmidtiby added the typehints For adding/discussing typehints label Dec 1, 2025

henrikmidtiby added 14 commits December 2, 2025 15:43

Add type annotations to mobject.py

953c07d

More work on type annotations for mobject.py

8c35540

...

be6d3ca

Almost handled all mypy errors

7ce05ff

Add the mypy error messages to the lines that trigger them

4629173

Use typing.cast to avoid some mypy errors, as suggested by JasonGrace…

e80f22c

…2282

Used the ruff linter

e9e797e

Fixed one typing issue and added the error descriptions to the source…

8ec81a2

… code for the remaning 10 errors

Set the type of the elements in a VGroup to VMobject

3b39095

Use typing.cast to handle some specific cases.

0db274f

Code cleaning

9f45342

Updates

4f21679

When started to use typing.cast it is needed to import / define certa…

43a8b47

…in elements during runtime and not only during type checking

Fix bug introduced with the type annotations.

0ec7b7b

henrikmidtiby and others added 5 commits December 4, 2025 22:00

Code cleanup

edc8b8f

Renamed lines_alignment to lines_alignments and added a TODO about a …

47643dc

…future cleanup task

More code cleanup

470c8da

Update manim/mobject/matrix.py

14c4c45

Co-authored-by: Francisco Manríquez Novoa <49853152+chopan050@users.noreply.github.com>

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

642a92d

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

github-advanced-security AI found potential problems Dec 4, 2025

View reviewed changes

henrikmidtiby added 3 commits December 4, 2025 22:33

Addressing multiple comments from Chopan50

9b41510

Implementing more suggestions from Chopan50

658826a

More suggestions by Chopan50

e7f6f77

henrikmidtiby added 6 commits December 5, 2025 08:22

...

2e85869

More renaming and code cleanup, as suggested by Chopan50

eafb1ac

Restructure code

13c8c7d

anim_args

9371cdd

Update typing in vector_space_scene

81014c9

Implemented a number of suggestions from chopan50

8aa0b72

henrikmidtiby and others added 10 commits January 12, 2026 09:40

Merge branch 'main' into TypingMobject

694d62d

Make a list of faces with the type list[ThreeDVMobject]

4d6214a

Ensure to return a VGroup if slicing is used.

4ffc91f

Revert back to the original code in text_mobject.py

5894b7d

Merge branch 'main' into TypingMobject

b5bafdc

# Conflicts: # manim/mobject/matrix.py # manim/mobject/mobject.py # manim/mobject/types/vectorized_mobject.py

Merge branch 'main' into TypingMobject

2cafe78

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

2f552c8

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

Merge branch 'main' into TypingMobject

751287b

Add the propagate_colors option to Mobject as it is used by VMobject.

f1830f9

Replace Self with _UpdateBuilder

Simplify code

0d2ad52

chopan050 approved these changes Mar 11, 2026

View reviewed changes

chopan050 merged commit 4689298 into ManimCommunity:main Mar 11, 2026
15 checks passed

henrikmidtiby deleted the TypingMobject branch March 16, 2026 20:26

		def __getitem__(self, key: int) -> VMobject:
		return self.submobjects[key]

Conversation

henrikmidtiby commented Aug 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview: What does this pull request change?

Reviewer Checklist

Uh oh!

henrikmidtiby Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

henrikmidtiby Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

henrikmidtiby Aug 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chopan050 Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

henrikmidtiby Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

henrikmidtiby Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

henrikmidtiby Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

henrikmidtiby Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

henrikmidtiby commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Check notice

Check notice

henrikmidtiby commented Dec 4, 2025

Uh oh!

henrikmidtiby commented Dec 5, 2025

Uh oh!

chopan050 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

henrikmidtiby commented Aug 10, 2025 •

edited

Loading

henrikmidtiby Aug 10, 2025 •

edited

Loading

henrikmidtiby commented Aug 11, 2025 •

edited

Loading