pythonnative/tests/test_animated.py at preview-api-reference-fix · andevsr/pythonnative · GitHub

History

469 lines (353 loc) · 15 KB

Raw

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

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

"""Unit tests for the Animated API (AnimatedValue, timing, sequence, etc.)."""

from __future__ import annotations

import asyncio

import time

from typing import Any

import pytest

from fake_backend import FakeBackend as _StubBackend

from pythonnative.animated import Animated, AnimatedValue, use_animated_value

from pythonnative.element import Element

from pythonnative.hooks import component

from pythonnative.reconciler import Reconciler

# ======================================================================

# AnimatedValue

# ======================================================================

def test_animated_value_initial() -> None:

v = AnimatedValue(3.14)

assert v.value == 3.14

assert float(v) == 3.14

def test_animated_value_set_value_fires_subscribers() -> None:

v = AnimatedValue(0.0)

received: list = []

unsub = v.add_listener("opacity", lambda new_val: received.append(new_val))

v.set_value(0.5)

v.set_value(1.0)

assert received == [0.5, 1.0]

unsub()

v.set_value(0.0)

assert received == [0.5, 1.0]

def test_animated_value_subscriber_exception_isolated() -> None:

v = AnimatedValue(0.0)

def boom(_: float) -> None:

raise RuntimeError("oops")

received: list = []

v.add_listener("a", boom)

v.add_listener("b", lambda x: received.append(x))

v.set_value(1.0)

assert received == [1.0]

# ======================================================================

# Timing animation

# ======================================================================

@pytest.mark.asyncio

async def test_timing_completes_at_target() -> None:

v = AnimatedValue(0.0)

await Animated.timing(v, to=10.0, duration=80, easing="linear")

assert abs(v.value - 10.0) < 0.05

@pytest.mark.asyncio

async def test_timing_progress_fires_listener() -> None:

v = AnimatedValue(0.0)

received: list = []

v.add_listener("opacity", lambda x: received.append(x))

await Animated.timing(v, to=1.0, duration=120, easing="linear")

# Should have received intermediate values, not just the final.

assert len(received) >= 3

assert received[0] > 0.0

assert received[-1] == 1.0

@pytest.mark.asyncio

@pytest.mark.parametrize("easing", ["linear", "ease_in", "ease_out", "ease_in_out", "bounce"])

async def test_timing_easing_curves(easing: str) -> None:

v = AnimatedValue(0.0)

await Animated.timing(v, to=1.0, duration=40, easing=easing)

assert abs(v.value - 1.0) < 0.05

def test_start_is_fire_and_forget() -> None:

"""``handle.start()`` returns immediately and runs in the background."""

v = AnimatedValue(0.0)

handle = Animated.timing(v, to=10.0, duration=80, easing="linear")

started = time.monotonic()

handle.start()

# The call returns well before the animation completes.

assert (time.monotonic() - started) < 0.02

# Wait for completion by polling.

deadline = time.monotonic() + 2.0

while time.monotonic() < deadline and v.value < 9.9:

time.sleep(0.02)

assert abs(v.value - 10.0) < 0.1

# ======================================================================

# Spring animation

# ======================================================================

@pytest.mark.asyncio

async def test_spring_settles() -> None:

v = AnimatedValue(0.0)

await Animated.spring(v, to=5.0, stiffness=200, damping=20, mass=1.0)

assert abs(v.value - 5.0) < 0.1

# ======================================================================

# Composition: sequence and parallel

# ======================================================================

@pytest.mark.asyncio

async def test_sequence_runs_in_order() -> None:

v1 = AnimatedValue(0.0)

v2 = AnimatedValue(0.0)

await Animated.sequence(

[

Animated.timing(v1, to=1.0, duration=40, easing="linear"),

Animated.timing(v2, to=2.0, duration=40, easing="linear"),

]

)

assert abs(v1.value - 1.0) < 0.1

assert abs(v2.value - 2.0) < 0.1

@pytest.mark.asyncio

async def test_parallel_runs_concurrently() -> None:

v1 = AnimatedValue(0.0)

v2 = AnimatedValue(0.0)

started = time.monotonic()

await Animated.parallel(

[

Animated.timing(v1, to=1.0, duration=120, easing="linear"),

Animated.timing(v2, to=2.0, duration=120, easing="linear"),

]

)

elapsed = time.monotonic() - started

# Two parallel 120ms animations should take ~120ms, not 240ms.

assert elapsed < 0.5

assert abs(v1.value - 1.0) < 0.1

assert abs(v2.value - 2.0) < 0.1

@pytest.mark.asyncio

async def test_delay_waits_then_completes() -> None:

started = time.monotonic()

await Animated.delay(80)

assert (time.monotonic() - started) >= 0.05

# ======================================================================

# Stop

# ======================================================================

def test_stop_freezes_value() -> None:

v = AnimatedValue(0.0)

handle = Animated.timing(v, to=10.0, duration=400, easing="linear")

handle.start()

time.sleep(0.05)

handle.stop()

snapshot = v.value

time.sleep(0.2)

# After stop, value should not advance further toward 10.

assert abs(v.value - snapshot) < 0.1

assert v.value < 9.0

@pytest.mark.asyncio

async def test_cancelling_await_stops_animation() -> None:

"""Cancelling the awaiting task should freeze the in-flight animation."""

v = AnimatedValue(0.0)

handle = Animated.timing(v, to=10.0, duration=400, easing="linear")

async def run() -> None:

await handle

task = asyncio.create_task(run())

await asyncio.sleep(0.05)

task.cancel()

with pytest.raises(asyncio.CancelledError):

await task

snapshot = v.value

await asyncio.sleep(0.2)

assert abs(v.value - snapshot) < 0.1

assert v.value < 9.0

# ======================================================================

# use_animated_value

# ======================================================================

def test_use_animated_value_returns_animated_value() -> None:

captured: list = []

@component

def view() -> Element:

v = use_animated_value(0.5)

captured.append(v)

return Element("View", {"opacity": v}, [])

rec = Reconciler(_StubBackend())

rec.mount(view())

assert isinstance(captured[0], AnimatedValue)

assert captured[0].value == 0.5

def test_use_animated_value_stable_across_renders() -> None:

captured: list = []

@component

def view() -> Element:

v = use_animated_value(0.0)

captured.append(v)

return Element("View", {"opacity": v}, [])

rec = Reconciler(_StubBackend())

rec.mount(view())

rec.reconcile(view())

assert captured[0] is captured[1] is captured[2]

def test_use_animated_value_default_initial_zero() -> None:

captured: list = []

@component

def view() -> Element:

v = use_animated_value()

captured.append(v)

return Element("View", {"opacity": v}, [])

rec = Reconciler(_StubBackend())

rec.mount(view())

assert captured[0].value == 0.0

def test_animated_components_mount_through_reconciler() -> None:

"""Regression: ``@component`` packs positional children into the

``children`` prop; the Animated wrappers must unpack it instead of

forwarding it to ``View()`` (pre-fix this raised ``TypeError:

View() got an unexpected keyword argument 'children'``)."""

from pythonnative.components import Column, Text

from pythonnative.native_views import set_registry

backend = _StubBackend()

set_registry(backend) # type: ignore[arg-type]

try:

@component

def app() -> Element:

v = use_animated_value(0.25)

return Column(

Animated.View(Text("boxed"), style={"opacity": v, "padding": 4}),

Animated.Text("fading", style={"opacity": v}),

Animated.Image("https://example.com/i.png", style={"opacity": v}),

)

rec = Reconciler(backend)

rec.mount(app())

texts = {view.props.get("text") for view in backend.views.values()}

assert {"boxed", "fading"} <= texts

# Each wrapper attached its binding and pushed the initial value.

opacity_pushes = [(tag, val) for tag, prop, val in backend.animated if prop == "opacity"]

assert len(opacity_pushes) == 3

assert all(val == 0.25 for _tag, val in opacity_pushes)

finally:

set_registry(None)

# ======================================================================

# Native driver

# ======================================================================

class _NativeBackend(_StubBackend):

"""FakeBackend that accepts native animations for chosen tags."""

def __init__(self, accept_tags: Any = None) -> None:

super().__init__()

self.accept_tags = accept_tags # None => accept everything

self.native_started: list = [] # (tag, anim_id, prop, spec)

self.native_cancelled: list = [] # (tag, anim_id)

self.presentation_value: Any = None

def start_animation(self, tag: int, anim_id: int, prop_name: str, spec: dict) -> bool:

if self.accept_tags is not None and tag not in self.accept_tags:

return False

self.native_started.append((tag, anim_id, prop_name, dict(spec)))

return True

def cancel_animation(self, tag: int, anim_id: int) -> Any:

self.native_cancelled.append((tag, anim_id))

return self.presentation_value

@pytest.fixture

def native_backend(): # type: ignore[no-untyped-def]

from pythonnative.native_views import set_registry

backend = _NativeBackend()

set_registry(backend)

try:

yield backend

finally:

set_registry(None)

def test_attach_pushes_current_value_natively(native_backend: _NativeBackend) -> None:

v = AnimatedValue(0.25)

v.attach(7, "opacity")

assert native_backend.animated[-1] == (7, "opacity", 0.25)

v.set_value(0.75)

assert native_backend.animated[-1] == (7, "opacity", 0.75)

def test_native_driver_offloads_attached_animation(native_backend: _NativeBackend) -> None:

from pythonnative.animated import native_animation_completed

v = AnimatedValue(0.0)

v.attach(7, "opacity")

Animated.timing(v, to=1.0, duration=5000, easing="linear").start()

assert len(native_backend.native_started) == 1

tag, anim_id, prop, spec = native_backend.native_started[0]

assert (tag, prop) == (7, "opacity")

assert spec["kind"] == "timing" and spec["to"] == 1.0 and spec["from"] == 0.0

# No Python ticker is driving the value while the platform animates.

time.sleep(0.05)

assert v.value == 0.0

# The platform's completion callback settles the Python cell.

native_animation_completed(anim_id, finished=True)

assert v.value == 1.0

def test_native_driver_fans_out_to_every_binding(native_backend: _NativeBackend) -> None:

from pythonnative.animated import native_animation_completed

v = AnimatedValue(0.0)

v.attach(1, "opacity")

v.attach(2, "opacity")

Animated.timing(v, to=1.0, duration=5000).start()

assert len(native_backend.native_started) == 2

ids = [entry[1] for entry in native_backend.native_started]

# The group settles only after *all* targets complete.

native_animation_completed(ids[0])

assert v.value == 0.0

native_animation_completed(ids[1])

assert v.value == 1.0

def test_python_listeners_force_python_driver(native_backend: _NativeBackend) -> None:

v = AnimatedValue(0.0)

v.attach(7, "opacity")

v.add_listener("opacity", lambda _x: None)

handle = Animated.timing(v, to=1.0, duration=30, easing="linear")

handle.start()

assert native_backend.native_started == []

deadline = time.monotonic() + 2.0

while time.monotonic() < deadline and v.value < 0.99:

time.sleep(0.01)

assert abs(v.value - 1.0) < 0.05

def test_unattached_value_uses_python_driver(native_backend: _NativeBackend) -> None:

v = AnimatedValue(0.0)

handle = Animated.timing(v, to=1.0, duration=30, easing="linear")

handle.start()

assert native_backend.native_started == []

deadline = time.monotonic() + 2.0

while time.monotonic() < deadline and v.value < 0.99:

time.sleep(0.01)

assert abs(v.value - 1.0) < 0.05

def test_partial_native_acceptance_rolls_back_and_falls_back() -> None:

from pythonnative.native_views import set_registry

backend = _NativeBackend(accept_tags={1})

set_registry(backend) # type: ignore[arg-type]

try:

v = AnimatedValue(0.0)

v.attach(1, "opacity")

v.attach(2, "opacity") # the backend rejects tag 2

Animated.timing(v, to=1.0, duration=30, easing="linear").start()

# The accepted target was cancelled so views can't drift apart.

assert len(backend.native_started) == 1

assert backend.native_cancelled == [(1, backend.native_started[0][1])]

# And the Python ticker still finishes the job.

deadline = time.monotonic() + 2.0

while time.monotonic() < deadline and v.value < 0.99:

time.sleep(0.01)

assert abs(v.value - 1.0) < 0.05

finally:

set_registry(None)

def test_native_stop_syncs_to_presentation_value(native_backend: _NativeBackend) -> None:

native_backend.presentation_value = 0.42

v = AnimatedValue(0.0)

v.attach(7, "opacity")

handle = Animated.timing(v, to=1.0, duration=5000).start()

assert len(native_backend.native_started) == 1

handle.stop()

assert len(native_backend.native_cancelled) == 1

# The value lands wherever the view visually was mid-flight.

assert v.value == 0.42

def test_set_value_cancels_inflight_native_animation(native_backend: _NativeBackend) -> None:

v = AnimatedValue(0.0)

v.attach(7, "opacity")

Animated.timing(v, to=1.0, duration=5000).start()

assert len(native_backend.native_started) == 1

v.stop_animation()

assert len(native_backend.native_cancelled) == 1

def test_decay_settles_at_projected_final_value(native_backend: _NativeBackend) -> None:

from pythonnative.animated import native_animation_completed

v = AnimatedValue(10.0)

v.attach(7, "translate_x")

Animated.decay(v, velocity=500.0, deceleration=0.997).start()

assert len(native_backend.native_started) == 1

_tag, anim_id, _prop, spec = native_backend.native_started[0]

assert spec["kind"] == "decay"

native_animation_completed(anim_id)

# x_final = from + v0 / (k * 1000)

assert abs(v.value - (10.0 + 500.0 / (0.997 * 1000.0))) < 1e-6

def test_unfinished_native_completion_keeps_python_value(native_backend: _NativeBackend) -> None:

from pythonnative.animated import native_animation_completed

v = AnimatedValue(0.0)

v.attach(7, "opacity")

Animated.timing(v, to=1.0, duration=5000).start()

_tag, anim_id, _prop, _spec = native_backend.native_started[0]

# finished=False means the platform interrupted the animation; the

# value must not jump to the target.

native_animation_completed(anim_id, finished=False)

assert v.value == 0.0

# Suppress unused-import lint for the typing helper.

_ = Any

pythonnative/tests/test_animated.py at preview-api-reference-fix · andevsr/pythonnative · GitHub

Expand file tree

Breadcrumbs

test_animated.py

Latest commit

History

Breadcrumbs

test_animated.py

File metadata and controls