Skip to content

Add type hints to animation #3457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Add type hints to animation #3457

wants to merge 10 commits into from

Conversation

Viicos
Copy link
Member

@Viicos Viicos commented Nov 16, 2023

Part of #3375.

Viicos
Viicos commented Nov 16, 2023
View reviewed changes
manim/animation/creation.py
@@ -400,9 +402,9 @@ def construct(self):
def __init__(
self,
vmobject: VMobject,
rate_func: Callable[[float], float] = linear,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should rate_func be passed to super? (i.e. in this case Write). It is currently unused.

github-advanced-security[bot]
github-advanced-security bot found potential problems Nov 16, 2023
View reviewed changes
manim/animation/animation.py
self.suspend_mobject_updating: bool = suspend_mobject_updating
self.lag_ratio: float = lag_ratio
self._on_finish: Callable[[Scene], None] = _on_finish
self.run_time = run_time

Check warning

Code scanning / CodeQL

Overwriting attribute in super-class or sub-class

Assignment overwrites attribute run_time, which was previously defined in subclass [Flash](1). Assignment overwrites attribute run_time, which was previously defined in subclass [TransformAnimations](2). Assignment overwrites attribute run_time, which was previously defined in subclass [TransformAnimations](3).
manim/animation/animation.py
self.lag_ratio: float = lag_ratio
self._on_finish: Callable[[Scene], None] = _on_finish
self.run_time = run_time
self.rate_func = rate_func

Check warning

Code scanning / CodeQL

Overwriting attribute in super-class or sub-class

Assignment overwrites attribute rate_func, which was previously defined in subclass [AnimationGroup](1). Assignment overwrites attribute rate_func, which was previously defined in subclass [ChangeSpeed](2).
manim/animation/animation.py
self.rate_func = rate_func
self.reverse_rate_function = reverse_rate_function
self.name = name
self.remover = remover

Check warning

Code scanning / CodeQL

Overwriting attribute in super-class or sub-class

Assignment overwrites attribute remover, which was previously defined in subclass [ShowPassingFlashWithThinningStrokeWidth](1).
@Viicos
Copy link
Member Author

Viicos commented Nov 16, 2023

pointwise_become_partial is only available on VMobject, so the type hint is probably invalid here?

manim/manim/animation/creation.py

Lines 122 to 130 in 4315549

def interpolate_submobject(
self,
submobject: Mobject,
starting_submobject: Mobject,
alpha: float,
) -> None:
submobject.pointwise_become_partial(
starting_submobject, *self._get_bounds(alpha)
)

@Viicos Viicos mentioned this pull request Nov 16, 2023
Open
22 tasks
@chopan050 chopan050 added the documentation Improvements or additions to documentation label Dec 21, 2023
@Viicos Viicos mentioned this pull request Jan 3, 2024
Merged
github-advanced-security[bot]
github-advanced-security bot found potential problems Jan 13, 2024
View reviewed changes
manim/typing.py
@@ -576,6 +576,8 @@
MappingFunction: TypeAlias = Callable[[Point3D], Point3D]
"""A function mapping a `Point3D` to another `Point3D`."""

RateFunc: TypeAlias = Callable[[float], float]

Check notice

Code scanning / CodeQL

Unused global variable

The global variable 'RateFunc' is not used.
@JasonGrace2282
Copy link
Member

pointwise_become_partial is only available on VMobject, so the type hint is probably invalid here?

manim/manim/animation/creation.py

Lines 122 to 130 in 4315549

def interpolate_submobject(
self,
submobject: Mobject,
starting_submobject: Mobject,
alpha: float,
) -> None:
submobject.pointwise_become_partial(
starting_submobject, *self._get_bounds(alpha)
)

It would seem so!

@Viicos Viicos marked this pull request as ready for review February 13, 2024 17:13
@Viicos
Copy link
Member Author

Viicos commented Feb 13, 2024

Consider this a first pass. They are still too many mypy errors to actually enable this module. I first want to go over simple modules and I'll come back to this one later.

@JasonGrace2282 JasonGrace2282 added typehints For adding/discussing typehints and removed documentation Improvements or additions to documentation labels Apr 18, 2024
@JasonGrace2282 JasonGrace2282 marked this pull request as draft May 28, 2024 02:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
typehints For adding/discussing typehints
Projects
Dev Board
Status: 🆕 New
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Viicos @JasonGrace2282 @chopan050