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

Mark some methods as internal #3793

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

Mark some methods as internal #3793

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8d7bb13
Add decorator
JasonGrace2282 May 30, 2024
bfea7da
Mark some methods as internal on Mobject/VMobject
JasonGrace2282 May 30, 2024
bd7eae7
Fix docstrings being weird and causing build warnings
JasonGrace2282 May 31, 2024
d5377cb
don't use ParamSpec
JasonGrace2282 May 31, 2024
b0df579
Merge branch 'main' into internal
JasonGrace2282 Jun 4, 2024
97b7a57
Change spacing
JasonGrace2282 Jun 5, 2024
0eddd98
Merge branch 'main' into internal
JasonGrace2282 Jun 5, 2024
10fa509
Improve decorator message
JasonGrace2282 Jul 14, 2024
c6c6533
Some feedback
JasonGrace2282 Jul 14, 2024
82d39f2
Merge branch 'main' into internal
JasonGrace2282 Jul 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion manim/mobject/mobject.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
color_gradient,
interpolate_color,
)
from ..utils.decorators import internal
from ..utils.exceptions import MultiAnimationOverrideException
from ..utils.iterables import list_update, remove_list_redundancies
from ..utils.paths import straight_path
Expand Down Expand Up @@ -83,6 +84,7 @@ class Mobject:

animation_overrides = {}

@internal
@classmethod
def __init_subclass__(cls, **kwargs) -> None:
super().__init_subclass__(**kwargs)
Expand Down Expand Up @@ -1712,6 +1714,7 @@ def stretch_to_fit_depth(self, depth: float, **kwargs) -> Self:

return self.rescale_to_fit(depth, 2, stretch=True, **kwargs)

@internal
Copy link
Member

Choose a reason for hiding this comment

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

why?

Copy link
Member Author

Choose a reason for hiding this comment

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

To be honest, I don't remember. However, I think that it's more common to use move_to or set_(x|y|z) as opposed to this method.
This PR was mostly an introduction of concept, so I'm happy to remove it if you disagree.

def set_coord(self, value, dim: int, direction: Vector3D = ORIGIN) -> Self:
curr = self.get_coord(dim, direction)
shift_vect = np.zeros(self.dim)
Expand Down Expand Up @@ -1902,6 +1905,7 @@ def set_colors_by_radial_gradient(
)
return self

@internal
Copy link
Member

Choose a reason for hiding this comment

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

why?

Copy link
Member Author

Choose a reason for hiding this comment

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

There was already a set_colors_by_gradient that used this internally and returning Self, so I figured that should be the public one.

def set_submobject_colors_by_gradient(self, *colors: Iterable[ParsableManimColor]):
if len(colors) == 0:
raise ValueError("Need at least one color")
Expand All @@ -1915,6 +1919,7 @@ def set_submobject_colors_by_gradient(self, *colors: Iterable[ParsableManimColor
mob.set_color(color, family=False)
return self

@internal
Copy link
Member

Choose a reason for hiding this comment

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

why?

Copy link
Member Author

Choose a reason for hiding this comment

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

Here, there was already a set_colors_by_radial_gradient that used this internally and returning Self, so I figured that should be the public one.

def set_submobject_colors_by_radial_gradient(
self,
center: Point3D | None = None,
Expand Down Expand Up @@ -2044,6 +2049,7 @@ def get_points_defining_boundary(self) -> Point3D_Array:
def get_num_points(self) -> int:
return len(self.points)

@internal
Copy link
Member

Choose a reason for hiding this comment

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

maybe also borderline

def get_extremum_along_dim(
self, points: Point3D_Array | None = None, dim: int = 0, key: int = 0
) -> np.ndarray | float:
Expand Down Expand Up @@ -2160,6 +2166,7 @@ def length_over_dim(self, dim: int) -> float:
dim,
) - self.reduce_across_dimension(min, dim)

@internal
JasonGrace2282 marked this conversation as resolved.
Show resolved Hide resolved
def get_coord(self, dim: int, direction: Vector3D = ORIGIN):
"""Meant to generalize ``get_x``, ``get_y`` and ``get_z``"""
return self.get_extremum_along_dim(dim=dim, key=direction[dim])
Expand Down Expand Up @@ -2196,6 +2203,7 @@ def point_from_proportion(self, alpha: float) -> Point3D:
def proportion_from_point(self, point: Point3D) -> float:
raise NotImplementedError("Please override in a child class.")

@internal
def get_pieces(self, n_pieces: float) -> Group:
template = self.copy()
template.submobjects = []
Expand Down Expand Up @@ -2312,11 +2320,13 @@ def split(self) -> list[Self]:
result = [self] if len(self.points) > 0 else []
return result + self.submobjects

@internal
def get_family(self, recurse: bool = True) -> list[Self]:
sub_families = [x.get_family() for x in self.submobjects]
sub_families = [x.get_family(recurse=recurse) for x in self.submobjects]
all_mobjects = [self] + list(it.chain(*sub_families))
return remove_list_redundancies(all_mobjects)

@internal
def family_members_with_points(self) -> list[Self]:
return [m for m in self.get_family() if m.get_num_points() > 0]

Expand Down Expand Up @@ -2683,6 +2693,7 @@ def construct(self):
return self.shuffle(*args, **kwargs)

# Alignment
@internal
def align_data(self, mobject: Mobject, skip_point_alignment: bool = False) -> None:
"""Aligns the data of this mobject with another mobject.

Expand Down Expand Up @@ -2784,6 +2795,7 @@ def add_n_more_submobjects(self, n: int) -> Self | None:
def repeat_submobject(self, submob: Mobject) -> Self:
return submob.copy()

@internal
Copy link
Member

Choose a reason for hiding this comment

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

borderline?

def interpolate(
self,
mobject1: Mobject,
Expand Down Expand Up @@ -2967,6 +2979,7 @@ def construct(self):
return self

# Errors
@internal
def throw_error_if_no_points(self) -> None:
if self.has_no_points():
caller_name = sys._getframe(1).f_code.co_name
Expand Down
39 changes: 38 additions & 1 deletion manim/mobject/types/vectorized_mobject.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
proportions_along_bezier_curve_for_point,
)
from manim.utils.color import BLACK, WHITE, ManimColor, ParsableManimColor
from manim.utils.decorators import internal
from manim.utils.iterables import (
make_even,
resize_array,
Expand Down Expand Up @@ -191,6 +192,7 @@ def get_mobject_type_class() -> type[VMobject]:
return VMobject

# Colors
@internal
def init_colors(self, propagate_colors: bool = True) -> Self:
self.set_fill(
color=self.fill_color,
Expand Down Expand Up @@ -221,6 +223,7 @@ def init_colors(self, propagate_colors: bool = True) -> Self:

return self

@internal
def generate_rgbas_array(
self, color: ManimColor | list[ManimColor], opacity: float | Iterable[float]
) -> RGBA_Array_Float:
Expand Down Expand Up @@ -249,6 +252,7 @@ def generate_rgbas_array(
rgbas = np.append(rgbas, light_rgbas, axis=0)
return rgbas

@internal
def update_rgbas_array(
self,
array_name: str,
Expand Down Expand Up @@ -708,6 +712,7 @@ def set_shade_in_3d(
submob.z_index_group = self
return self

@internal
Copy link
Member

Choose a reason for hiding this comment

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

boderline?

Copy link
Member Author

Choose a reason for hiding this comment

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

I mostly added this because of discussions on whether to make points a property (to add some memoization stuff).

def set_points(self, points: Point3D_Array) -> Self:
self.points: Point3D_Array = np.array(points)
return self
Expand Down Expand Up @@ -795,6 +800,7 @@ def append_points(self, new_points: Point3D_Array) -> Self:
self.points = points
return self

@internal
def start_new_path(self, point: Point3D) -> Self:
"""Append a ``point`` to the :attr:`VMobject.points`, which will be the
beginning of a new Bézier curve in the path given by the points. If
Expand Down Expand Up @@ -825,6 +831,7 @@ def start_new_path(self, point: Point3D) -> Self:
self.append_points([point])
return self

@internal
def add_cubic_bezier_curve(
self,
anchor1: CubicBezierPoints,
Expand All @@ -836,9 +843,11 @@ def add_cubic_bezier_curve(
self.append_points([anchor1, handle1, handle2, anchor2])

# what type is curves?
@internal
def add_cubic_bezier_curves(self, curves) -> None:
self.append_points(curves.flatten())

@internal
def add_cubic_bezier_curve_to(
self,
handle1: CubicBezierPoints,
Expand Down Expand Up @@ -871,6 +880,7 @@ def add_cubic_bezier_curve_to(
self.append_points([self.get_last_point()] + new_points)
return self

@internal
def add_quadratic_bezier_curve_to(
self,
handle: QuadraticBezierPoints,
Expand Down Expand Up @@ -1114,11 +1124,13 @@ def make_smooth(self) -> Self:
def make_jagged(self) -> Self:
return self.change_anchor_mode("jagged")

@internal
def add_subpath(self, points: Point3D_Array) -> Self:
assert len(points) % 4 == 0
self.append_points(points)
return self

@internal
def append_vectorized_mobject(self, vectorized_mobject: VMobject) -> None:
if self.has_new_path_started():
# Remove last point, which is starting
Expand Down Expand Up @@ -1146,6 +1158,7 @@ def rotate(
super().rotate(angle, axis, about_point, **kwargs)
return self

@internal
def scale_handle_to_anchor_distances(self, factor: float) -> Self:
"""If the distance between a given handle point H and its associated
anchor point A is d, then it changes H to be a distances factor*d
Expand Down Expand Up @@ -1177,10 +1190,11 @@ def scale_handle_to_anchor_distances(self, factor: float) -> Self:
submob.set_anchors_and_handles(a1, new_h1, new_h2, a2)
return self

#
@internal
def consider_points_equals(self, p0: Point3D, p1: Point3D) -> bool:
return np.allclose(p0, p1, atol=self.tolerance_for_point_equality)

@internal
def consider_points_equals_2d(self, p0: Point2D, p1: Point2D) -> bool:
"""Determine if two points are close enough to be considered equal.

Expand All @@ -1207,11 +1221,13 @@ def consider_points_equals_2d(self, p0: Point2D, p1: Point2D) -> bool:
return True

# Information about line
@internal
def get_cubic_bezier_tuples_from_points(
self, points: Point3D_Array
) -> npt.NDArray[Point3D_Array]:
return np.array(self.gen_cubic_bezier_tuples_from_points(points))

@internal
def gen_cubic_bezier_tuples_from_points(
self, points: Point3D_Array
) -> tuple[Point3D_Array]:
Expand All @@ -1238,6 +1254,7 @@ def gen_cubic_bezier_tuples_from_points(
# Basically take every nppcc element.
return tuple(points[i : i + nppcc] for i in range(0, len(points), nppcc))

@internal
def get_cubic_bezier_tuples(self) -> npt.NDArray[Point3D_Array]:
return self.get_cubic_bezier_tuples_from_points(self.points)

Expand Down Expand Up @@ -1275,6 +1292,7 @@ def _gen_subpaths_from_points(
if (i2 - i1) >= nppcc
)

@internal
def get_subpaths_from_points(self, points: Point3D_Array) -> list[Point3D_Array]:
return list(
self._gen_subpaths_from_points(
Expand All @@ -1283,6 +1301,7 @@ def get_subpaths_from_points(self, points: Point3D_Array) -> list[Point3D_Array]
),
)

@internal
def gen_subpaths_from_points_2d(
self, points: Point3D_Array
) -> Generator[Point3D_Array]:
Expand All @@ -1291,6 +1310,7 @@ def gen_subpaths_from_points_2d(
lambda n: not self.consider_points_equals_2d(points[n - 1], points[n]),
)

@internal
def get_subpaths(self) -> list[Point3D_Array]:
"""Returns subpaths formed by the curves of the VMobject.

Expand All @@ -1303,6 +1323,7 @@ def get_subpaths(self) -> list[Point3D_Array]:
"""
return self.get_subpaths_from_points(self.points)

@internal
def get_nth_curve_points(self, n: int) -> Point3D_Array:
"""Returns the points defining the nth curve of the vmobject.

Expand All @@ -1320,6 +1341,7 @@ def get_nth_curve_points(self, n: int) -> Point3D_Array:
nppcc = self.n_points_per_cubic_curve
return self.points[nppcc * n : nppcc * (n + 1)]

@internal
def get_nth_curve_function(self, n: int) -> Callable[[float], Point3D]:
"""Returns the expression of the nth curve.

Expand All @@ -1335,6 +1357,7 @@ def get_nth_curve_function(self, n: int) -> Callable[[float], Point3D]:
"""
return bezier(self.get_nth_curve_points(n))

@internal
def get_nth_curve_length_pieces(
self,
n: int,
Expand Down Expand Up @@ -1363,6 +1386,7 @@ def get_nth_curve_length_pieces(

return norms

@internal
def get_nth_curve_length(
self,
n: int,
Expand All @@ -1387,6 +1411,7 @@ def get_nth_curve_length(

return length

@internal
def get_nth_curve_function_with_length(
self,
n: int,
Expand Down Expand Up @@ -1426,6 +1451,7 @@ def get_num_curves(self) -> int:
nppcc = self.n_points_per_cubic_curve
return len(self.points) // nppcc

@internal
def get_curve_functions(
self,
) -> Generator[Callable[[float], Point3D]]:
Expand All @@ -1442,6 +1468,7 @@ def get_curve_functions(
for n in range(num_curves):
yield self.get_nth_curve_function(n)

@internal
def get_curve_functions_with_lengths(
self, **kwargs
) -> Generator[tuple[Callable[[float], Point3D], float]]:
Expand Down Expand Up @@ -1582,6 +1609,7 @@ def proportion_from_point(

return alpha

@internal
def get_anchors_and_handles(self) -> list[Point3D_Array]:
"""Returns anchors1, handles1, handles2, anchors2,
where (anchors1[i], handles1[i], handles2[i], anchors2[i])
Expand All @@ -1596,6 +1624,7 @@ def get_anchors_and_handles(self) -> list[Point3D_Array]:
nppcc = self.n_points_per_cubic_curve
return [self.points[i::nppcc] for i in range(nppcc)]

@internal
def get_start_anchors(self) -> Point3D_Array:
"""Returns the start anchors of the bezier curves.

Expand All @@ -1606,6 +1635,7 @@ def get_start_anchors(self) -> Point3D_Array:
"""
return self.points[:: self.n_points_per_cubic_curve]

@internal
def get_end_anchors(self) -> Point3D_Array:
"""Return the end anchors of the bezier curves.

Expand All @@ -1617,6 +1647,7 @@ def get_end_anchors(self) -> Point3D_Array:
nppcc = self.n_points_per_cubic_curve
return self.points[nppcc - 1 :: nppcc]

@internal
def get_anchors(self) -> Point3D_Array:
"""Returns the anchors of the curves forming the VMobject.

Expand Down Expand Up @@ -1731,6 +1762,7 @@ def get_nth_subpath(path_list, n):
vmobject.set_points(new_path2)
return self

@internal
def insert_n_curves(self, n: int) -> Self:
"""Inserts n curves to the bezier curves of the vmobject.

Expand All @@ -1755,6 +1787,7 @@ def insert_n_curves(self, n: int) -> Self:
self.append_points([new_path_point])
return self

@internal
def insert_n_curves_to_point_list(
self, n: int, points: Point3D_Array
) -> npt.NDArray[BezierPoints]:
Expand Down Expand Up @@ -1782,6 +1815,7 @@ def insert_n_curves_to_point_list(
new_points = new_bezier_tuples.reshape(-1, 3)
return new_points

@internal
def align_rgbas(self, vmobject: VMobject) -> Self:
attrs = ["fill_rgbas", "stroke_rgbas", "background_stroke_rgbas"]
for attr in attrs:
Expand All @@ -1802,6 +1836,7 @@ def get_point_mobject(self, center: Point3D | None = None) -> VectorizedPoint:
point.match_style(self)
return point

@internal
Copy link
Member

Choose a reason for hiding this comment

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

borderline?

def interpolate_color(
self, mobject1: VMobject, mobject2: VMobject, alpha: float
) -> None:
Expand All @@ -1826,6 +1861,7 @@ def interpolate_color(
val = val.copy()
setattr(self, attr, val)

@internal
Copy link
Member

Choose a reason for hiding this comment

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

borderline?

Copy link
Member Author

Choose a reason for hiding this comment

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

I find it hard to think of a case where a user would need this, and (I can't remember) but there's a chance this changes in experimental.

def pointwise_become_partial(
self,
vmobject: VMobject,
Expand Down Expand Up @@ -1888,6 +1924,7 @@ def pointwise_become_partial(
)
return self

@internal
def get_subcurve(self, a: float, b: float) -> Self:
"""Returns the subcurve of the VMobject between the interval [a, b].
The curve is a VMobject itself.
Expand Down
Loading
Loading