Repository: ManimCommunity/manim
File: manim/animation/animation.py (Python)

Code before:
    Tuple,
    Type,
    Union,
)

if TYPE_CHECKING:
    from manim.scene.scene import Scene

from .. import logger
from ..mobject import mobject, opengl_mobject
from ..mobject.mobject import Mobject
from ..mobject.opengl_mobject import OpenGLMobject
from ..utils.rate_functions import smooth

DEFAULT_ANIMATION_RUN_TIME: float = 1.0
DEFAULT_ANIMATION_LAG_RATIO: float = 0.0


class Animation:
    def __new__(
        cls,
        mobject: Optional[Mobject] = None,
        *args,
        use_default: bool = False,
        **kwargs,
    ):
        overrides = Mobject.animation_overrides
        if not use_default and cls in overrides and type(mobject) in overrides[cls]:
            func = overrides[cls][type(mobject)]
            anim = func(mobject, *args, **kwargs)
            return anim
        return super().__new__(cls)

    def __init__(
        self,
        mobject: Optional[Mobject],
        # If lag_ratio is 0, the animation is applied to all submobjects
        # at the same time
        # If 1, it is applied to each successively.
        # If 0 < lag_ratio < 1, its applied to each
        # with lagged start times
        lag_ratio: float = DEFAULT_ANIMATION_LAG_RATIO,
        run_time: float = DEFAULT_ANIMATION_RUN_TIME,
        rate_func: Callable[[float], float] = smooth,
        name: str = None,
        remover: bool = False,  # remove a mobject from the screen?
        suspend_mobject_updating: bool = True,
        **kwargs,
    ) -> None:
        self._typecheck_input(mobject)
        self.run_time: float = run_time

Review comment (suggestion):
Nonblocking, but this signature poses problems for the docs. If you look, you'll see the constructor signature for `Animation` gets rendered as the `__new__` signature, which isn't that descriptive. A solution *could* be to fiddle with `inspect.signature` and setting the `__signature__` attribute of `__new__` to match `__init__` accordingly, but not sure it's worth it, or if it would even be correct because the signature would only be correct for `Animation` and not its subclasses.

Though I'd prefer the `use_default` argument to be renamed to `use_override` (and the logic using `use_default` to be inverted)

Code after:
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
DEFAULT_ANIMATION_LAG_RATIO: float = 0.0


class Animation:
    def __new__(
        cls,
        mobject: Optional[Mobject] = None,
        *args,
        use_override: bool = True,
        **kwargs,
    ):
        if isinstance(mobject, Mobject) and use_override:
            func = mobject.animation_override_for(cls)
            if func is not None:
                anim = func(mobject, *args, **kwargs)
                logger.debug(
                    (
                        f"The {cls.__name__} animation has been is overridden for "
                        f"{type(mobject).__name__} mobjects. use_override = False can "
                        f" be used as keyword argument to prevent animation overriding."
                    )
                )
                return anim
        return super().__new__(cls)

    def __init__(
        self,
        mobject: Optional[Mobject],
        # If lag_ratio is 0, the animation is applied to all submobjects
        # at the same time
        # If 1, it is applied to each successively.
        # If 0 < lag_ratio < 1, its applied to each
        # with lagged start times
        lag_ratio: float = DEFAULT_ANIMATION_LAG_RATIO,
        run_time: float = DEFAULT_ANIMATION_RUN_TIME,
        rate_func: Callable[[float], float] = smooth,
        name: str = None,
        remover: bool = False,  # remove a mobject from the screen?
        suspend_mobject_updating: bool = True,
        **kwargs,
    ) -> None:
        self._typecheck_input(mobject)
        self.run_time: float = run_time
        self.rate_func: Callable[[float], float] = rate_func
        self.name: Optional[str] = name