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

History

796 lines (598 loc) · 20.1 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

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

"""Unit tests for function components and hooks."""

from typing import Any

from fake_backend import FakeBackend as MockBackend

from pythonnative.element import Element

from pythonnative.hooks import (

HookState,

NavigationHandle,

Provider,

_NavigationContext,

_set_hook_state,

batch_updates,

component,

create_context,

memo,

use_callback,

use_context,

use_effect,

use_memo,

use_navigation,

use_reducer,

use_ref,

use_state,

)

from pythonnative.reconciler import Reconciler

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

# use_state

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

def test_use_state_returns_initial_value() -> None:

ctx = HookState()

_set_hook_state(ctx)

try:

val, setter = use_state(42)

assert val == 42

finally:

_set_hook_state(None)

def test_use_state_lazy_initialiser() -> None:

ctx = HookState()

_set_hook_state(ctx)

try:

val, _ = use_state(lambda: 99)

assert val == 99

finally:

_set_hook_state(None)

def test_use_state_setter_triggers_render() -> None:

renders = []

ctx = HookState()

ctx._trigger_render = lambda: renders.append(1)

_set_hook_state(ctx)

try:

val, setter = use_state(0)

setter(1)

assert len(renders) == 1

assert ctx.states[0] == 1

finally:

_set_hook_state(None)

def test_use_state_setter_functional_update() -> None:

ctx = HookState()

_set_hook_state(ctx)

try:

_, setter = use_state(10)

_set_hook_state(None)

setter(lambda prev: prev + 5)

assert ctx.states[0] == 15

finally:

_set_hook_state(None)

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

# use_reducer

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

def test_use_reducer_returns_initial_state() -> None:

def reducer(state: int, action: str) -> int:

return state

ctx = HookState()

_set_hook_state(ctx)

try:

state, dispatch = use_reducer(reducer, 42)

assert state == 42

finally:

_set_hook_state(None)

def test_use_reducer_lazy_initial_state() -> None:

def reducer(state: int, action: str) -> int:

return state

ctx = HookState()

_set_hook_state(ctx)

try:

state, _ = use_reducer(reducer, lambda: 99)

assert state == 99

finally:

_set_hook_state(None)

def test_use_reducer_dispatch_triggers_render() -> None:

renders: list = []

def reducer(state: int, action: str) -> int:

if action == "increment":

return state + 1

if action == "reset":

return 0

return state

ctx = HookState()

ctx._trigger_render = lambda: renders.append(1)

_set_hook_state(ctx)

try:

state, dispatch = use_reducer(reducer, 0)

dispatch("increment")

assert ctx.states[0] == 1

assert len(renders) == 1

dispatch("increment")

assert ctx.states[0] == 2

assert len(renders) == 2

dispatch("reset")

assert ctx.states[0] == 0

assert len(renders) == 3

finally:

_set_hook_state(None)

def test_use_reducer_no_render_on_same_state() -> None:

renders: list = []

def reducer(state: int, action: str) -> int:

return state

ctx = HookState()

ctx._trigger_render = lambda: renders.append(1)

_set_hook_state(ctx)

try:

_, dispatch = use_reducer(reducer, 5)

dispatch("noop")

assert len(renders) == 0

finally:

_set_hook_state(None)

def test_use_reducer_in_reconciler() -> None:

captured_dispatch: list = [None]

def reducer(state: int, action: str) -> int:

if action == "increment":

return state + 1

return state

@component

def counter() -> Element:

count, dispatch = use_reducer(reducer, 0)

captured_dispatch[0] = dispatch

return Element("Text", {"text": str(count)}, [])

backend = MockBackend()

rec = Reconciler(backend)

re_rendered: list = []

rec._screen_re_render = lambda: re_rendered.append(1)

root = rec.mount(counter())

assert root.props["text"] == "0"

dispatch_fn = captured_dispatch[0]

assert dispatch_fn is not None

dispatch_fn("increment")

assert len(re_rendered) == 1

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

# use_effect (deferred execution)

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

def test_use_effect_is_deferred() -> None:

"""Effects are queued during render, not run immediately."""

calls: list = []

ctx = HookState()

_set_hook_state(ctx)

try:

use_effect(lambda: calls.append("mounted"), [])

assert calls == [], "Effect should NOT run during render"

finally:

_set_hook_state(None)

ctx.flush_pending_effects()

assert calls == ["mounted"], "Effect should run after flush"

def test_use_effect_cleanup_on_rerun() -> None:

cleanups: list = []

def make_effect(label: str): # type: ignore[no-untyped-def]

def effect() -> Any:

return lambda: cleanups.append(label)

return effect

ctx = HookState()

_set_hook_state(ctx)

try:

use_effect(make_effect("first"), None)

finally:

_set_hook_state(None)

ctx.flush_pending_effects()

ctx.begin_render()

_set_hook_state(ctx)

try:

use_effect(make_effect("second"), None)

finally:

_set_hook_state(None)

ctx.flush_pending_effects()

assert "first" in cleanups

def test_use_effect_skips_with_same_deps() -> None:

calls: list = []

ctx = HookState()

_set_hook_state(ctx)

try:

use_effect(lambda: calls.append("run"), [1, 2])

finally:

_set_hook_state(None)

ctx.flush_pending_effects()

ctx.begin_render()

_set_hook_state(ctx)

try:

use_effect(lambda: calls.append("run"), [1, 2])

finally:

_set_hook_state(None)

ctx.flush_pending_effects()

assert calls == ["run"]

def test_use_effect_runs_after_reconciler_mount() -> None:

"""Effects run automatically after Reconciler.mount() completes."""

calls: list = []

@component

def my_comp() -> Element:

use_effect(lambda: calls.append("effect"), [])

return Element("Text", {"text": "hi"}, [])

backend = MockBackend()

rec = Reconciler(backend)

rec.mount(my_comp())

assert calls == ["effect"]

def test_use_effect_runs_after_reconciler_reconcile() -> None:

"""Effects run automatically after Reconciler.reconcile() completes."""

calls: list = []

@component

def my_comp(dep: int = 0) -> Element:

use_effect(lambda: calls.append(f"effect-{dep}"), [dep])

return Element("Text", {"text": str(dep)}, [])

backend = MockBackend()

rec = Reconciler(backend)

rec.mount(my_comp(dep=0))

assert calls == ["effect-0"]

rec.reconcile(my_comp(dep=1))

assert calls == ["effect-0", "effect-1"]

def test_use_effect_cleanup_on_unmount() -> None:

"""Cleanup functions run when component is destroyed."""

cleanups: list = []

ctx = HookState()

_set_hook_state(ctx)

try:

use_effect(lambda: (lambda: cleanups.append("cleaned")), [])

finally:

_set_hook_state(None)

ctx.flush_pending_effects()

assert cleanups == []

ctx.cleanup_all_effects()

assert cleanups == ["cleaned"]

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

# batch_updates

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

def test_batch_updates_defers_render() -> None:

renders: list = []

ctx = HookState()

ctx._trigger_render = lambda: renders.append(1)

_set_hook_state(ctx)

try:

_, set_a = use_state(0)

_, set_b = use_state(0)

finally:

_set_hook_state(None)

with batch_updates():

set_a(1)

set_b(2)

assert len(renders) == 0, "Render should be deferred inside batch"

assert len(renders) == 1, "Exactly one render after batch exits"

def test_batch_updates_nested() -> None:

renders: list = []

ctx = HookState()

ctx._trigger_render = lambda: renders.append(1)

_set_hook_state(ctx)

try:

_, set_a = use_state(0)

_, set_b = use_state(0)

finally:

_set_hook_state(None)

with batch_updates():

set_a(1)

with batch_updates():

set_b(2)

assert len(renders) == 0

assert len(renders) == 0, "Nested batch should not trigger render"

assert len(renders) == 1

def test_batch_updates_no_render_when_unchanged() -> None:

renders: list = []

ctx = HookState()

ctx._trigger_render = lambda: renders.append(1)

_set_hook_state(ctx)

try:

_, set_a = use_state(5)

finally:

_set_hook_state(None)

with batch_updates():

set_a(5)

assert len(renders) == 0

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

# use_memo / use_callback

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

def test_use_memo_caches() -> None:

calls: list = []

ctx = HookState()

def factory_a() -> int:

calls.append(1)

return 42

def factory_b() -> int:

calls.append(1)

return 99

_set_hook_state(ctx)

try:

val1 = use_memo(factory_a, [1])

finally:

_set_hook_state(None)

ctx.begin_render()

_set_hook_state(ctx)

try:

val2 = use_memo(factory_b, [1])

finally:

_set_hook_state(None)

assert val1 == 42

assert val2 == 42

assert len(calls) == 1

def test_use_memo_recomputes_on_dep_change() -> None:

ctx = HookState()

_set_hook_state(ctx)

try:

val1 = use_memo(lambda: "first", ["a"])

finally:

_set_hook_state(None)

ctx.begin_render()

_set_hook_state(ctx)

try:

val2 = use_memo(lambda: "second", ["b"])

finally:

_set_hook_state(None)

assert val1 == "first"

assert val2 == "second"

def test_use_callback_returns_stable_reference() -> None:

ctx = HookState()

fn = lambda: None # noqa: E731

_set_hook_state(ctx)

try:

cb1 = use_callback(fn, [1])

finally:

_set_hook_state(None)

ctx.begin_render()

_set_hook_state(ctx)

try:

cb2 = use_callback(lambda: None, [1])

finally:

_set_hook_state(None)

assert cb1 is fn

assert cb2 is fn

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

# use_ref

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

def test_use_ref_persists() -> None:

ctx = HookState()

_set_hook_state(ctx)

try:

ref = use_ref(0)

assert ref.current == 0

ref.current = 5

finally:

_set_hook_state(None)

ctx.begin_render()

_set_hook_state(ctx)

try:

ref2 = use_ref(0)

assert ref2.current == 5

assert ref2 is ref

finally:

_set_hook_state(None)

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

# Context

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

def test_create_context_default() -> None:

ctx = create_context("default_val")

assert ctx._current() == "default_val"

def test_context_stack() -> None:

ctx = create_context("default")

ctx._stack.append("override")

assert ctx._current() == "override"

ctx._stack.pop()

assert ctx._current() == "default"

def test_use_context_reads_current() -> None:

my_ctx = create_context("fallback")

my_ctx._stack.append("active")

hook_state = HookState()

_set_hook_state(hook_state)

try:

val = use_context(my_ctx)

assert val == "active"

finally:

_set_hook_state(None)

my_ctx._stack.pop()

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

# @component decorator

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

def test_component_decorator_creates_element() -> None:

@component

def my_comp(label: str = "hello") -> Element:

return Element("Text", {"text": label}, [])

el = my_comp(label="world")

assert isinstance(el, Element)

assert el.type is getattr(my_comp, "__wrapped__")

assert el.props == {"label": "world"}

def test_component_with_positional_args() -> None:

@component

def greeting(name: str, age: int = 0) -> Element:

return Element("Text", {"text": f"{name}, {age}"}, [])

el = greeting("Alice", age=30)

assert el.props == {"name": "Alice", "age": 30}

def test_component_key_extraction() -> None:

@component

def widget(text: str = "") -> Element:

return Element("Text", {"text": text}, [])

el = widget(text="hi", key="k1")

assert el.key == "k1"

assert "key" not in el.props

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

# Function components in reconciler

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

def test_reconciler_mounts_function_component() -> None:

@component

def greeting(name: str = "World") -> Element:

return Element("Text", {"text": f"Hello {name}"}, [])

backend = MockBackend()

rec = Reconciler(backend)

root = rec.mount(greeting(name="Python"))

assert root.type_name == "Text"

assert root.props["text"] == "Hello Python"

def test_reconciler_reconciles_function_component() -> None:

@component

def display(value: int = 0) -> Element:

return Element("Text", {"text": str(value)}, [])

backend = MockBackend()

rec = Reconciler(backend)

rec.mount(display(value=1))

backend.ops.clear()

rec.reconcile(display(value=2))

update_ops = [op for op in backend.ops if op[0] == "update"]

assert len(update_ops) == 1

assert "text" in update_ops[0][3]

def test_function_component_use_state() -> None:

render_count = [0]

captured_setter: list = [None]

@component

def counter() -> Element:

count, set_count = use_state(0)

render_count[0] += 1

captured_setter[0] = set_count

return Element("Text", {"text": str(count)}, [])

backend = MockBackend()

rec = Reconciler(backend)

re_rendered: list = []

rec._screen_re_render = lambda: re_rendered.append(1)

root = rec.mount(counter())

assert root.props["text"] == "0"

assert render_count[0] == 1

setter_fn = captured_setter[0]

assert setter_fn is not None

setter_fn(5)

assert len(re_rendered) == 1

def test_function_component_preserves_state_across_reconcile() -> None:

@component

def stateful(label: str = "") -> Element:

count, set_count = use_state(0)

return Element("Text", {"text": f"{label}:{count}"}, [])

backend = MockBackend()

rec = Reconciler(backend)

rec.mount(stateful(label="A"))

tree_node = rec._tree

assert tree_node is not None

assert tree_node.hook_state is not None

tree_node.hook_state.states[0] = 42

rec.reconcile(stateful(label="B"))

assert rec._tree is not None

assert rec._tree.hook_state is not None

assert rec._tree.hook_state.states[0] == 42

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

# Provider in reconciler

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

def test_provider_in_reconciler() -> None:

theme = create_context("light")

@component

def themed() -> Element:

t = use_context(theme)

return Element("Text", {"text": t}, [])

backend = MockBackend()

rec = Reconciler(backend)

el = Provider(theme, "dark", themed())

root = rec.mount(el)

assert root.props["text"] == "dark"

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

# use_navigation

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

def test_use_navigation_reads_context() -> None:

class FakeHost:

def _get_nav_args(self) -> dict:

return {"id": 42}

def _push(self, page: Any, args: Any = None) -> None:

pass

def _pop(self) -> None:

pass

handle = NavigationHandle(FakeHost())

_NavigationContext._stack.append(handle)

hook_state = HookState()

_set_hook_state(hook_state)

try:

nav = use_navigation()

assert nav is handle

assert nav.get_params() == {"id": 42}

finally:

_set_hook_state(None)

_NavigationContext._stack.pop()

def test_navigation_handle_methods() -> None:

pushed: list = []

popped: list = []

class FakeHost:

def _push(self, page: Any, args: Any = None) -> None:

pushed.append((page, args))

def _pop(self) -> None:

popped.append(1)

def _get_nav_args(self) -> dict:

return {"key": "value"}

handle = NavigationHandle(FakeHost())

handle.navigate("SomePage", params={"x": 1})

assert pushed == [("SomePage", {"x": 1})]

handle.go_back()

assert len(popped) == 1

assert handle.get_params() == {"key": "value"}

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

# Provider with *children

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

def test_provider_with_multiple_children_kept_flat() -> None:

"""Multi-child providers rely on the reconciler's multi-child support."""

theme = create_context("light")

child_a = Element("Text", {"text": "a"}, [])

child_b = Element("Text", {"text": "b"}, [])

el = Provider(theme, "dark", child_a, child_b)

assert el.type == "__Provider__"

assert el.children == [child_a, child_b]

def test_provider_with_single_child_no_fragment_wrap() -> None:

theme = create_context("light")

child = Element("Text", {"text": "single"}, [])

el = Provider(theme, "dark", child)

assert el.type == "__Provider__"

assert el.children == [child]

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

# @memo

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

def test_memo_marks_component() -> None:

@memo

@component

def my_comp(label: str = "x") -> Element:

return Element("Text", {"text": label}, [])

assert getattr(my_comp, "_pn_memo", False) is True

def test_memo_skips_rerender_with_same_props() -> None:

render_count = [0]

@memo

@component

def my_comp(label: str = "x") -> Element:

render_count[0] += 1

return Element("Text", {"text": label}, [])

backend = MockBackend()

rec = Reconciler(backend)

rec.mount(my_comp(label="A"))

assert render_count[0] == 1

rec.reconcile(my_comp(label="A"))

assert render_count[0] == 1, "memoized component should not re-render when props are unchanged"

def test_memo_rerenders_when_props_change() -> None:

render_count = [0]

@memo

@component

def my_comp(label: str = "x") -> Element:

render_count[0] += 1

return Element("Text", {"text": label}, [])

backend = MockBackend()

rec = Reconciler(backend)

rec.mount(my_comp(label="A"))

rec.reconcile(my_comp(label="B"))

assert render_count[0] == 2

def test_memo_rerenders_when_internal_state_changes() -> None:

render_count = [0]

captured_setter: list = [None]

@memo

@component

def stateful() -> Element:

render_count[0] += 1

value, set_value = use_state(0)

captured_setter[0] = set_value

return Element("Text", {"text": str(value)}, [])

backend = MockBackend()

rec = Reconciler(backend)

rec.mount(stateful())

assert render_count[0] == 1

setter_fn = captured_setter[0]

assert setter_fn is not None

setter_fn(5)

rec.reconcile(stateful())

assert render_count[0] == 2, "memo should still re-render when internal state changed"

def test_memo_can_be_called_with_explicit_argument() -> None:

"""``memo`` works as a plain function as well as a decorator."""

@component

def my_comp(label: str = "x") -> Element:

return Element("Text", {"text": label}, [])

wrapped = memo(my_comp)

assert getattr(wrapped, "_pn_memo", False) is True

el = wrapped(label="hi")

assert isinstance(el, Element)

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

Expand file tree

Breadcrumbs

test_hooks.py

Latest commit

History

Breadcrumbs

test_hooks.py

File metadata and controls