Skip to content
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

Adding type annotations to manim.utils.* #3999

Open
wants to merge 26 commits into
base: main
Choose a base branch
from
Open

Adding type annotations to manim.utils.* #3999

wants to merge 26 commits into from

Conversation

henrikmidtiby
Copy link
Contributor

Overview: What does this pull request change?

The PR adds type annotations to some of the elements in manim/utils

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

Type annotations are a good thing.

Further Information and Comments

I have chosen to go for smaller PR regarding adding type annotations.
The endeavor of #3981 is a bit frightening...

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

github-advanced-security[bot]
github-advanced-security bot found potential problems Nov 4, 2024
View reviewed changes
manim/utils/bezier.py
@@ -54,10 +56,12 @@
@overload
def bezier(
points: Sequence[Point3D_Array],
) -> Callable[[float | ColVector], Point3D_Array]: ...
) -> Callable[[float | ColVector], Point3D | Point3D_Array]: ...

Check notice

Code scanning / CodeQL

Statement has no effect Note

This statement has no effect.
manim/utils/bezier.py
def interpolate(start: Point3D, end: Point3D, alpha: float) -> Point3D: ...
def interpolate(
start: InternalPoint3D, end: InternalPoint3D, alpha: float
) -> Point3D: ...

Check notice

Code scanning / CodeQL

Statement has no effect Note

This statement has no effect.
manim/utils/bezier.py
def interpolate(start: Point3D, end: Point3D, alpha: ColVector) -> Point3D_Array: ...
def interpolate(
start: InternalPoint3D, end: InternalPoint3D, alpha: ColVector
) -> Point3D_Array: ...

Check notice

Code scanning / CodeQL

Statement has no effect Note

This statement has no effect.
manim/utils/bezier.py
@@ -1099,10 +1115,12 @@


@overload
def mid(start: Point3D, end: Point3D) -> Point3D: ...
def mid(start: InternalPoint3D, end: InternalPoint3D) -> Point3D: ...

Check notice

Code scanning / CodeQL

Statement has no effect Note

This statement has no effect.
manim/utils/bezier.py
def inverse_interpolate(start: float, end: float, value: Point3D) -> Point3D: ...
def inverse_interpolate(
start: float, end: float, value: InternalPoint3D
) -> InternalPoint3D: ...

Check notice

Code scanning / CodeQL

Statement has no effect Note

This statement has no effect.
manim/utils/bezier.py
def inverse_interpolate(start: Point3D, end: Point3D, value: Point3D) -> Point3D: ...
def inverse_interpolate(
start: InternalPoint3D, end: InternalPoint3D, value: InternalPoint3D
) -> Point3D: ...

Check notice

Code scanning / CodeQL

Statement has no effect Note

This statement has no effect.
manim/utils/color/core.py Fixed Show fixed Hide fixed
@henrikmidtiby henrikmidtiby mentioned this pull request Nov 4, 2024
Open
3 tasks
github-advanced-security[bot]
github-advanced-security bot found potential problems Nov 5, 2024
View reviewed changes
manim/scene/scene_file_writer.py Fixed Show fixed Hide fixed
manim/scene/scene_file_writer.py Fixed Show fixed Hide fixed
manim/utils/simple_functions.py


def clip(a, min_a, max_a):
@overload
def clip(a: float, min_a: float, max_a: float) -> float: ...

Check notice

Code scanning / CodeQL

Statement has no effect Note

This statement has no effect.
manim/utils/simple_functions.py


@overload
def clip(a: str, min_a: str, max_a: str) -> str: ...

Check notice

Code scanning / CodeQL

Statement has no effect Note

This statement has no effect.
@henrikmidtiby
Copy link
Contributor Author

@JasonGrace2282 Would you take a look at this PR?

@JasonGrace2282
Copy link
Member

I'll take a look when I find the time.

github-advanced-security[bot]
github-advanced-security bot found potential problems Nov 6, 2024
View reviewed changes
manim/utils/family_ops.py
@@ -2,20 +2,26 @@

import itertools as it

from manim.mobject.mobject import Mobject

Check failure

Code scanning / CodeQL

Module-level cyclic import Error

'Mobject' may not be defined if module
manim.mobject.mobject
Loading
is imported before module
manim.utils.family_ops
Loading
, as the
definition
Loading
of Mobject occurs after the cyclic
import
Loading
of manim.utils.family_ops.
'Mobject' may not be defined if module
manim.mobject.mobject
Loading
is imported before module
manim.utils.family_ops
Loading
, as the
definition
Loading
of Mobject occurs after the cyclic
import
Loading
of manim.utils.family_ops.
github-advanced-security[bot]
github-advanced-security bot found potential problems Nov 12, 2024
View reviewed changes
manim/utils/caching.py

def handle_caching_play(func: Callable[..., None]):
from manim.scene.scene import Scene

Check failure

Code scanning / CodeQL

Module-level cyclic import Error

'Scene' may not be defined if module
manim.scene.scene
Loading
is imported before module
manim.utils.caching
Loading
, as the
definition
Loading
of Scene occurs after the cyclic
import
Loading
of manim.utils.caching.
'Scene' may not be defined if module
manim.scene.scene
Loading
is imported before module
manim.utils.caching
Loading
, as the
definition
Loading
of Scene occurs after the cyclic
import
Loading
of manim.utils.caching.
'Scene' may not be defined if module
manim.scene.scene
Loading
is imported before module
manim.utils.caching
Loading
, as the
definition
Loading
of Scene occurs after the cyclic
import
Loading
of manim.utils.caching.
'Scene' may not be defined if module
manim.scene.scene
Loading
is imported before module
manim.utils.caching
Loading
, as the
definition
Loading
of Scene occurs after the cyclic
import
Loading
of manim.utils.caching.
'Scene' may not be defined if module
manim.scene.scene
Loading
is imported before module
manim.utils.caching
Loading
, as the
definition
Loading
of Scene occurs after the cyclic
import
Loading
of manim.utils.caching.
'Scene' may not be defined if module
manim.scene.scene
Loading
is imported before module
manim.utils.caching
Loading
, as the
definition
Loading
of Scene occurs after the cyclic
import
Loading
of manim.utils.caching.
'Scene' may not be defined if module
manim.scene.scene
Loading
is imported before module
manim.utils.caching
Loading
, as the
definition
Loading
of Scene occurs after the cyclic
import
Loading
of manim.utils.caching.
'Scene' may not be defined if module
manim.scene.scene
Loading
is imported before module
manim.utils.caching
Loading
, as the
definition
Loading
of Scene occurs after the cyclic
import
Loading
of manim.utils.caching.
'Scene' may not be defined if module
manim.scene.scene
Loading
is imported before module
manim.utils.caching
Loading
, as the
definition
Loading
of Scene occurs after the cyclic
import
Loading
of manim.utils.caching.
manim/utils/module_ops.py
__all__ = ["scene_classes_from_file"]


def get_module(file_name: Path):
def get_module(file_name: Path) -> types.ModuleType:

Check notice

Code scanning / CodeQL

Explicit returns mixed with implicit (fall through) returns Note

Mixing implicit and explicit returns may indicate an error as implicit returns always return None.
@henrikmidtiby
Handled mypy issues in utils/bezier.py
6e0d440
@henrikmidtiby
Disable mypy errors in manim.utils.*
8c887b5
@henrikmidtiby
Fix mypy errors in utils/unit.py
09b10c7
@henrikmidtiby
Handle mypy errors in utils/debug.py
5868534
@henrikmidtiby
Fix mypy issues in utils.color.*
57d4971
@henrikmidtiby
Avoid circular import.
f764767
@henrikmidtiby
Handle mypy errors in utils.simple_functions.*
1021c47
@henrikmidtiby
Handle my errors in utils.testing.*
0002711
@henrikmidtiby
Avoid circular import.
df742bc
@henrikmidtiby
Handle mypy errors in utils/family_ops.py
ce85521
@henrikmidtiby
Handle mypy errors in utils/parameter_parsing.py
21c1a44
@henrikmidtiby
Handle some of the mypy errors in utils.docbuild.*
e155bae
@henrikmidtiby
Handle mypy errors for utils/config_ops.py
2f5480d
@henrikmidtiby
Handle mypy errors from utils/commands.py
97227b2
@henrikmidtiby
Handle mypy errors in utils/tex_templates.py
3a2eaee
@henrikmidtiby
Handle mypy errors in utils/space_ops.py
d21525d
@henrikmidtiby
Fixed most type errors in utils/rate_functions.py
1b1e417
@henrikmidtiby
Handle type errors in utils/paths.py
7bb63bd
@henrikmidtiby
Handled type errors in utils/deprecation.py
a26da20
@henrikmidtiby
Handle type errors in utils/tex_file_writing.py
3b2e31d
@henrikmidtiby
Handle type error in utils/sounds.py
b1e815e
@henrikmidtiby
Handle type errors in utils/opengl.py
f086fec
@henrikmidtiby
Handle type errors in utils/module_ops.py
d51f929
@henrikmidtiby henrikmidtiby mentioned this pull request Nov 14, 2024
Open
22 tasks
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
None yet
Projects
Dev Board
Status: 🆕 New
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@henrikmidtiby @JasonGrace2282