data/tests/module/animation/test_override_animation.py

from __future__ import annotations

import pytest

from manim import Animation, Mobject, override_animation
from manim.utils.exceptions import MultiAnimationOverrideException


class AnimationA1(Animation):
    pass


class AnimationA2(Animation):
    pass


class AnimationA3(Animation):
    pass


class AnimationB1(AnimationA1):
    pass


class AnimationC1(AnimationB1):
    pass


class AnimationX(Animation):
    pass


class MobjectA(Mobject):
    @override_animation(AnimationA1)
    def anim_a1(self):
        return AnimationA2(self)

    @override_animation(AnimationX)
    def anim_x(self, *args, **kwargs):
        return args, kwargs


class MobjectB(MobjectA):
    pass


class MobjectC(MobjectB):
    @override_animation(AnimationA1)
    def anim_a1(self):
        return AnimationA3(self)


class MobjectX(Mobject):
    @override_animation(AnimationB1)
    def animation(self):
        return "Overridden"


def test_mobject_inheritance():
    mob = Mobject()
    a = MobjectA()
    b = MobjectB()
    c = MobjectC()

    assert type(AnimationA1(mob)) is AnimationA1
    assert type(AnimationA1(a)) is AnimationA2
    assert type(AnimationA1(b)) is AnimationA2
    assert type(AnimationA1(c)) is AnimationA3


def test_arguments():
    a = MobjectA()
    args = (1, "two", {"three": 3}, ["f", "o", "u", "r"])
    kwargs = {"test": "manim", "keyword": 42, "arguments": []}
    animA = AnimationX(a, *args, **kwargs)

    assert animA[0] == args
    assert animA[1] == kwargs


def test_multi_animation_override_exception():
    with pytest.raises(MultiAnimationOverrideException):

        class MobjectB2(MobjectA):
            @override_animation(AnimationA1)
            def anim_a1_different_name(self):
                pass


def test_animation_inheritance():
    x = MobjectX()

    assert type(AnimationA1(x)) is AnimationA1
    assert AnimationB1(x) == "Overridden"
    assert type(AnimationC1(x)) is AnimationC1