1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
|
from __future__ import annotations
from dataclasses import dataclass
from unittest.mock import Mock
import pytest
from textual._animator import Animator, SimpleAnimation
from textual._easing import DEFAULT_EASING, EASING
class Animatable:
"""An animatable object."""
def __init__(self, value):
self.value = value
def blend(self, destination: Animatable, factor: float) -> Animatable:
return Animatable(self.value + (destination.value - self.value) * factor)
@dataclass
class AnimateTest:
"""An object with animatable properties."""
foo: float | None = 0.0 # Plain float that may be set to None on final_value
bar: Animatable = Animatable(0) # A mock object supporting the animatable protocol
def test_simple_animation():
"""Test an animation from one float to another."""
# Thing that may be animated
animate_test = AnimateTest()
# Fake wall-clock time
time = 100.0
# Object that does the animation
animation = SimpleAnimation(
animate_test,
"foo",
time,
3.0,
start_value=20.0,
end_value=50.0,
final_value=None,
easing=lambda x: x,
)
assert animate_test.foo == 0.0
assert animation(time) is False
assert animate_test.foo == 20.0
assert animation(time + 1.0) is False
assert animate_test.foo == 30.0
assert animation(time + 2.0) is False
assert animate_test.foo == 40.0
assert animation(time + 2.9) is False # Not quite final value
assert animate_test.foo == pytest.approx(49.0)
assert animation(time + 3.0) is True # True to indicate animation is complete
assert animate_test.foo is None # This is final_value
assert animation(time + 3.0) is True
assert animate_test.foo is None
def test_simple_animation_duration_zero():
"""Test animation handles duration of 0."""
# Thing that may be animated
animatable = AnimateTest()
# Fake wall-clock time
time = 100.0
# Object that does the animation
animation = SimpleAnimation(
animatable,
"foo",
time,
0.0,
start_value=20.0,
end_value=50.0,
final_value=50.0,
easing=lambda x: x,
)
assert animation(time) is True # Duration is 0, so this is last value
assert animatable.foo == 50.0
assert animation(time + 1.0) is True
assert animatable.foo == 50.0
def test_simple_animation_reverse():
"""Test an animation from one float to another, where the end value is less than the start."""
# Thing that may be animated
animate_Test = AnimateTest()
# Fake wall-clock time
time = 100.0
# Object that does the animation
animation = SimpleAnimation(
animate_Test,
"foo",
time,
3.0,
start_value=50.0,
end_value=20.0,
final_value=20.0,
easing=lambda x: x,
)
assert animation(time) is False
assert animate_Test.foo == 50.0
assert animation(time + 1.0) is False
assert animate_Test.foo == 40.0
assert animation(time + 2.0) is False
assert animate_Test.foo == 30.0
assert animation(time + 3.0) is True
assert animate_Test.foo == 20.0
def test_animatable():
"""Test SimpleAnimation works with the Animatable protocol"""
animate_test = AnimateTest()
# Fake wall-clock time
time = 100.0
# Object that does the animation
animation = SimpleAnimation(
animate_test,
"bar",
time,
3.0,
start_value=Animatable(20.0),
end_value=Animatable(50.0),
final_value=Animatable(50.0),
easing=lambda x: x,
)
assert animation(time) is False
assert animate_test.bar.value == 20.0
assert animation(time + 1.0) is False
assert animate_test.bar.value == 30.0
assert animation(time + 2.0) is False
assert animate_test.bar.value == 40.0
assert animation(time + 2.9) is False
assert animate_test.bar.value == pytest.approx(49.0)
assert animation(time + 3.0) is True # True to indicate animation is complete
assert animate_test.bar.value == 50.0
class MockAnimator(Animator):
"""A mock animator."""
def __init__(self, *args) -> None:
super().__init__(*args)
self._time = 0.0
self._on_animation_frame_called = False
def on_animation_frame(self):
self._on_animation_frame_called = True
def _get_time(self):
return self._time
async def test_animator():
target = Mock()
animator = MockAnimator(target)
animate_test = AnimateTest()
# Animate attribute "foo" on animate_test to 100.0 in 10 seconds
animator.animate(animate_test, "foo", 100.0, duration=10.0)
expected = SimpleAnimation(
animate_test,
"foo",
0.0,
duration=10.0,
start_value=0.0,
end_value=100.0,
final_value=100.0,
easing=EASING[DEFAULT_EASING],
)
assert animator._animations[(id(animate_test), "foo")] == expected
assert not animator._on_animation_frame_called
animator()
assert animate_test.foo == 0
animator._time = 5
animator()
assert animate_test.foo == 50
# New animation in the middle of an existing one
animator.animate(animate_test, "foo", 200, duration=1)
assert animate_test.foo == 50
animator._time = 6
animator()
assert animate_test.foo == 200
def test_bound_animator():
target = Mock()
animator = MockAnimator(target)
animate_test = AnimateTest()
# Bind an animator so it animates attributes on the given object
bound_animator = animator.bind(animate_test)
# Animate attribute "foo" on animate_test to 100.0 in 10 seconds
bound_animator("foo", 100.0, duration=10)
expected = SimpleAnimation(
animate_test,
"foo",
0,
duration=10,
start_value=0,
end_value=100,
final_value=100,
easing=EASING[DEFAULT_EASING],
)
assert animator._animations[(id(animate_test), "foo")] == expected
async def test_animator_on_complete_callback_not_fired_before_duration_ends():
callback = Mock()
animate_test = AnimateTest()
animator = MockAnimator(Mock())
animator.animate(animate_test, "foo", 200, duration=10, on_complete=callback)
animator._time = 9
animator()
assert not callback.called
async def test_animator_on_complete_callback_fired_at_duration():
callback = Mock()
animate_test = AnimateTest()
mock_app = Mock()
animator = MockAnimator(mock_app)
animator.animate(animate_test, "foo", 200, duration=10, on_complete=callback)
animator._time = 10
animator()
# Ensure that the callback is scheduled to run after the duration is up.
mock_app.call_later.assert_called_once_with(callback)
def test_force_stop_animation():
callback = Mock()
animate_test = AnimateTest()
mock_app = Mock()
animator = MockAnimator(mock_app)
animator.animate(animate_test, "foo", 200, duration=10, on_complete=callback)
assert animator.is_being_animated(animate_test, "foo")
assert animate_test.foo != 200
animator.force_stop_animation(animate_test, "foo")
# The animation of the attribute was force cancelled.
assert not animator.is_being_animated(animate_test, "foo")
assert animate_test.foo == 200
# The on_complete callback was scheduled.
mock_app.call_later.assert_called_once_with(callback)
|
