Added two deprecation decorators

docs/source/reference.rst

@@ -205,6 +205,7 @@ Utilities
    ~utils.bezier
    ~utils.color
    ~utils.config_ops
+   ~utils.deprecation
    ~utils.hashing
    ~utils.ipython_magic
    ~utils.images

manim/animation/animation.py

@@ -14,6 +14,7 @@
 from ..mobject import mobject, opengl_mobject
 from ..mobject.mobject import Mobject
 from ..mobject.opengl_mobject import OpenGLMobject
+from ..utils.deprecation import deprecated
 from ..utils.rate_functions import smooth
 
 DEFAULT_ANIMATION_RUN_TIME: float = 1.0
@@ -138,15 +139,8 @@ def interpolate(self, alpha: float) -> None:
         alpha = min(max(alpha, 0), 1)
         self.interpolate_mobject(self.rate_func(alpha))
 
+    @deprecated(until="v0.6.0", replacement="interpolate")
     def update(self, alpha: float) -> None:
-        """
-        This method shouldn't exist, but it's here to
-        keep many old scenes from breaking
-        """
-        logger.warning(
-            "animation.update() has been deprecated. "
-            "Please use animation.interpolate() instead."
-        )
         self.interpolate(alpha)
 
     def interpolate_mobject(self, alpha: float) -> None:

manim/animation/creation.py

@@ -76,8 +76,6 @@ def construct(self):
 import numpy as np
 from colour import Color
 
-from .. import logger
-
 if TYPE_CHECKING:
     from manim.mobject.svg.text_mobject import Text
 
@@ -87,6 +85,7 @@ def construct(self):
 from ..mobject.types.opengl_vectorized_mobject import OpenGLVMobject
 from ..mobject.types.vectorized_mobject import VMobject
 from ..utils.bezier import integer_interpolate
+from ..utils.deprecation import deprecated
 from ..utils.rate_functions import double_smooth, linear, smooth
 
 

manim/animation/indication.py

@@ -52,7 +52,6 @@ def construct(self):
 from colour import Color
 
 from .. import config
-from .._config import logger
 from ..animation.animation import Animation
 from ..animation.composition import AnimationGroup, Succession
 from ..animation.creation import Create, ShowPartial, Uncreate
@@ -66,6 +65,7 @@ def construct(self):
 from ..mobject.types.vectorized_mobject import VGroup, VMobject
 from ..utils.bezier import interpolate, inverse_interpolate
 from ..utils.color import GREY, YELLOW
+from ..utils.deprecation import deprecated
 from ..utils.rate_functions import smooth, there_and_back, wiggle
 from ..utils.space_ops import normalize
 
@@ -278,9 +278,8 @@ def create_line_anims(self) -> typing.Iterable["ShowPassingFlash"]:
         ]
 
 
+@deprecated(since="v0.5.0", until="v0.7.0", replacement="Circumscribe")
 class CircleIndicate(Indicate):
-    """Deprecated. Use :class:`~.Circumscribe` instead."""
-
     def __init__(
         self,
         mobject: "Mobject",
@@ -291,9 +290,6 @@ def __init__(
         remover: bool = True,
         **kwargs
     ) -> None:
-        logger.warning(
-            "ShowCreationThenDestructionAround has been deprecated in favor of Circumscribe. Please use Circumscribe instead!"
-        )
         self.circle_config = circle_config
         circle = self.get_circle(mobject)
         super().__init__(circle, rate_func=rate_func, remover=remover, **kwargs)
@@ -383,15 +379,11 @@ def __init__(self, vmobject, n_segments=10, time_width=0.1, remover=True, **kwar
         )
 
 
+@deprecated(since="v0.5.0", until="v0.7.0", replacement="ShowPassingFlash")
 class ShowCreationThenDestruction(ShowPassingFlash):
-    """Deprecated. Use :class:`~.ShowPassingFlash` instead."""
-
     def __init__(
         self, mobject: "Mobject", time_width: float = 2.0, run_time: float = 1, **kwargs
     ) -> None:
-        logger.warning(
-            "ShowCreationThenDestruction has been deprecated in favor of ShowPassingFlash. Please use ShowPassingFlash instead!"
-        )
         super().__init__(mobject, time_width=time_width, run_time=run_time, **kwargs)
 
 
@@ -404,19 +396,15 @@ def __init__(self, mobject: "Mobject", remover: bool = True, **kwargs) -> None:
         super().__init__(Create(mobject), FadeOut(mobject), remover=remover, **kwargs)
 
 
+@deprecated(since="v0.5.0", until="v0.7.0", replacement="Circumscribe")
 class AnimationOnSurroundingRectangle(AnimationGroup):
-    """Deprecated. Use :class:`~.Circumscribe` instead or build an Animation using :class:`~SurroundingRectangle`."""
-
     def __init__(
         self,
         mobject: "Mobject",
         rect_animation: Animation = Animation,
         surrounding_rectangle_config: typing.Dict[str, typing.Any] = {},
         **kwargs
     ) -> None:
-        logger.warning(
-            "AnimationOnSurroundingRectangle has been deprecated in favor of Circumscribe. Please use Circumscribe instead!"
-        )
         # Callable which takes in a rectangle, and spits out some animation.  Could be
         # some animation class, could be something more
         self.rect_animation = rect_animation
@@ -436,45 +424,33 @@ def get_rect(self) -> SurroundingRectangle:
         )
 
 
+@deprecated(since="v0.5.0", until="v0.7.0", replacement="Circumscribe")
 class ShowPassingFlashAround(AnimationOnSurroundingRectangle):
-    """Deprecated. Use :class:`~.Circumscribe` instead."""
-
     def __init__(
         self, mobject: "Mobject", rect_animation: Animation = ShowPassingFlash, **kwargs
     ) -> None:
-        logger.warning(
-            "ShowPassingFlashAround has been deprecated in favor of Circumscribe. Please use Circumscribe instead!"
-        )
         super().__init__(mobject, rect_animation=rect_animation, **kwargs)
 
 
+@deprecated(since="v0.5.0", until="v0.7.0", replacement="Circumscribe")
 class ShowCreationThenDestructionAround(AnimationOnSurroundingRectangle):
-    """Deprecated. Use :class:`~.Circumscribe` instead."""
-
     def __init__(
         self,
         mobject: "Mobject",
         rect_animation: Animation = ShowCreationThenDestruction,
         **kwargs
     ) -> None:
-        logger.warning(
-            "ShowCreationThenDestructionAround has been deprecated in favor of Circumscribe. Please use Circumscribe instead!"
-        )
         super().__init__(mobject, rect_animation=rect_animation, **kwargs)
 
 
+@deprecated(since="v0.5.0", until="v0.7.0", replacement="Circumscribe")
 class ShowCreationThenFadeAround(AnimationOnSurroundingRectangle):
-    """Deprecated. Use :class:`~.Circumscribe` instead."""
-
     def __init__(
         self,
         mobject: "Mobject",
         rect_animation: Animation = ShowCreationThenFadeOut,
         **kwargs
     ) -> None:
-        logger.warning(
-            "ShowCreationThenFadeAround has been deprecated in favor of Circumscribe. Please use Circumscribe instead!"
-        )
         super().__init__(mobject, rect_animation=rect_animation, **kwargs)
 
 
@@ -677,23 +653,19 @@ def interpolate_submobject(
         )
 
 
+@deprecated(since="v0.5.0", until="v0.7.0", replacement="Wiggle")
 class WiggleOutThenIn(Wiggle):
-    """Deprecated. Use :class:`~.Wiggle` instead."""
-
     def __init__(*args, **kwargs):
-        logger.warning(
-            "WiggleOutThenIn has been deprecated in favor of Wiggle. Please use Wiggle instead!"
-        )
-        super().__init__(*args, **kwargs)
+        super().__init(*args, **kwargs)
 
 
+@deprecated(
+    since="v0.5.0",
+    until="v0.7.0",
+    message="Use :code:`mobject.animate.become(mobject.copy().reverse_points())` instead if you have to.",
+)
 class TurnInsideOut(Transform):
-    """Deprecated. Use :code:`mobject.animate.become(mobject.copy().reverse_points())` instead if you have to."""
-
     def __init__(self, mobject: "Mobject", path_arc: float = TAU / 4, **kwargs) -> None:
-        logger.warning(
-            "TurnInsideOut has been deprecated. Please stop using TurnInsideOut!"
-        )
         super().__init__(mobject, path_arc=path_arc, **kwargs)
 
     def create_target(self) -> "Mobject":

manim/animation/numbers.py

@@ -9,9 +9,15 @@
 from ..animation.animation import Animation
 from ..mobject.numbers import DecimalNumber
 from ..utils.bezier import interpolate
+from ..utils.deprecation import deprecated_params
 
 
 class ChangingDecimal(Animation):
+    @deprecated_params(
+        "tracked_mobject position_update_func",
+        until="v0.6.0",
+        message="Use a mobject updater instead.",
+    )
     def __init__(
         self,
         decimal_mob: DecimalNumber,
@@ -20,7 +26,6 @@ def __init__(
         **kwargs,
     ) -> None:
         self.check_validity_of_input(decimal_mob)
-        self.yell_about_deprecated_configuration(**kwargs)
         self.number_update_func = number_update_func
         super().__init__(
             decimal_mob, suspend_mobject_updating=suspend_mobject_updating, **kwargs
@@ -30,20 +35,6 @@ def check_validity_of_input(self, decimal_mob: DecimalNumber) -> None:
         if not isinstance(decimal_mob, DecimalNumber):
             raise TypeError("ChangingDecimal can only take in a DecimalNumber")
 
-    def yell_about_deprecated_configuration(self, **kwargs) -> None:
-        # Obviously this would optimally be removed at
-        # some point.
-        for attr in ["tracked_mobject", "position_update_func"]:
-            if attr in kwargs:
-                warnings.warn(
-                    f"""
-                    Don't use {attr} for ChangingDecimal,
-                        that functionality has been deprecated
-                    and you should use a mobject updater
-                    instead
-                """
-                )
-
     def interpolate_mobject(self, alpha: float) -> None:
         self.mobject.set_value(self.number_update_func(alpha))
 

manim/mobject/opengl_geometry.py

@@ -9,6 +9,7 @@
     OpenGLVMobject,
 )
 from ..utils.color import *
+from ..utils.deprecation import deprecated
 from ..utils.iterables import adjacent_n_tuples, adjacent_pairs
 from ..utils.simple_functions import clip, fdiv
 from ..utils.space_ops import (
@@ -340,14 +341,10 @@ def __init__(
         )
 
 
+@deprecated(until="v0.6.0", replacement="OpenGLDot")
 class OpenGLSmallDot(OpenGLDot):
-    """Deprecated"""
-
     def __init__(self, radius=DEFAULT_SMALL_DOT_RADIUS, **kwargs):
-        logger.warning(
-            "OpenGLSmallDot has been deprecated and will be removed in a future release."
-            "Use OpenGLDot instead."
-        )
+
         super().__init__(radius=radius, **kwargs)
 
 

manim/mobject/svg/opengl_tex_mobject.py

@@ -171,16 +171,18 @@ def construct(self):
 import operator as op
 from functools import reduce
 
-from ... import config, logger
+from ... import config
 from ...constants import *
 from ...mobject.opengl_geometry import OpenGLLine
 from ...mobject.svg.opengl_svg_mobject import OpenGLSVGMobject
 from ...mobject.svg.opengl_svg_path import OpenGLSVGPathMobject
+from ...mobject.svg.tex_mobject import MathTex, Tex
 from ...mobject.types.opengl_vectorized_mobject import (
     OpenGLVectorizedPoint,
     OpenGLVGroup,
 )
 from ...utils.color import BLACK
+from ...utils.deprecation import deprecated
 from ...utils.strings import split_string_list_to_isolate_substrings
 from ...utils.tex_file_writing import tex_to_svg_file
 from .style_utils import parse_style
@@ -597,19 +599,13 @@ def __init__(
             self.underline = underline
 
 
+@deprecated(until="v0.7.0", replacement="MathTex")
 class OpenGLTexMobject(OpenGLMathTex):
     def __init__(self, *tex_strings, **kwargs):
-        logger.warning(
-            "TexMobject has been deprecated (due to its confusing name) "
-            "in favour of MathTex. Please use MathTex instead!"
-        )
         MathTex.__init__(self, *tex_strings, **kwargs)
 
 
+@deprecated(until="v0.7.0", replacement="Tex")
 class OpenGLTextMobject(OpenGLTex):
     def __init__(self, *text_parts, **kwargs):
-        logger.warning(
-            "TextMobject has been deprecated (due to its confusing name) "
-            "in favour of Tex. Please use Tex instead!"
-        )
         Tex.__init__(self, *text_parts, **kwargs)

manim/mobject/svg/svg_path.py

@@ -10,11 +10,10 @@
 
 import numpy as np
 
-from manim import logger
-
 from ... import config
 from ...constants import *
 from ...mobject.types.vectorized_mobject import VMobject
+from ...utils.deprecation import deprecated
 
 
 def correct_out_of_range_radii(rx, ry, x1p, y1p):
@@ -444,12 +443,7 @@ def start_new_path(self, point):
         return self
 
 
+@deprecated(until="v0.7.0", replacement="SVGPathMobject")
 class VMobjectFromSVGPathstring(SVGPathMobject):
-    """Pure alias of SVGPathMobject, retained for backwards compatibility"""
-
     def __init__(self, *args, **kwargs):
-        logger.warning(
-            "VMobjectFromSVGPathstring has been deprecated in favour "
-            "of SVGPathMobject. Please use SVGPathMobject instead."
-        )
-        SVGPathMobject.__init__(self, *args, **kwargs)
+        super().__init__(self, *args, **kwargs)

manim/utils/debug.py

@@ -4,11 +4,12 @@
 __all__ = ["print_family", "index_labels", "get_submobject_index_labels"]
 
 
-import logging
+from os import replace
 
 from ..mobject.numbers import Integer
 from ..mobject.types.vectorized_mobject import VGroup
 from .color import BLACK
+from .deprecation import deprecated
 
 
 def print_family(mobject, n_tabs=0):
@@ -29,9 +30,6 @@ def index_labels(mobject, label_height=0.15):
     return labels
 
 
+@deprecated(until="v0.6.0", replacement="index_labels")
 def get_submobject_index_labels(mobject, label_height=0.15):
-    logging.getLogger("manim").warning(
-        "get_submobject_index_labels has been deprecated and has been replaced by index_labels, which does the same thing, and will thus be removed in a future release."
-    )
-
     return index_labels(mobject, label_height)