peffect 0.1.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
peffect/latch.py ADDED
@@ -0,0 +1,120 @@
1
+ """A reusable gate: waiters park while it is closed and resume once it opens or is released.
2
+
3
+ Pinned Effect v4 Latch.ts and the Latch class in internal/effect.ts:5928-6017. `open()` and
4
+ `release()` resume waiters on the calling fiber's dispatcher; `open_unsafe()` resumes them
5
+ before it returns. Upstream's Effect-valued fields (`open`, `await`, ...) are methods here.
6
+ """
7
+
8
+ from __future__ import annotations
9
+
10
+ from collections.abc import Callable
11
+ from typing import Never, final
12
+
13
+ from .core import Effect, async_, succeed, sync
14
+ from .fiber import SchedulerDispatcher, with_dispatcher
15
+
16
+ type _Resume = Callable[[Effect[None, Never, Never]], None]
17
+
18
+
19
+ @final
20
+ class Latch:
21
+ """Waiters still parked when the latch opens sit in ``waiters``; once a wake-up is queued on
22
+ a dispatcher they move to ``scheduled`` until it runs. Both are visible, like upstream."""
23
+
24
+ __slots__ = ("_is_open", "scheduled", "waiters")
25
+
26
+ def __init__(self, is_open: bool) -> None:
27
+ self.waiters: list[_Resume] = []
28
+ self.scheduled: list[_Resume] | None = None
29
+ self._is_open = is_open
30
+
31
+ @classmethod
32
+ def make_unsafe(cls, open: bool = False) -> Latch:
33
+ """A latch, closed unless ``open`` (internal/effect.ts:6014)."""
34
+ return cls(open)
35
+
36
+ @classmethod
37
+ def make(cls, open: bool = False) -> Effect[Latch, Never, Never]:
38
+ """A fresh latch each time this effect runs (:6017)."""
39
+ return sync(lambda: cls(open))
40
+
41
+ def _schedule(self, dispatcher: SchedulerDispatcher) -> Effect[bool, Never, Never]:
42
+ """scheduleUnsafe, :5937-5951: one flush per batch; later wakes join the pending one."""
43
+ if self.waiters:
44
+ if self.scheduled is None:
45
+ self.scheduled = self.waiters
46
+ dispatcher.schedule_task(self._flush_scheduled, 0)
47
+ else:
48
+ self.scheduled.extend(self.waiters)
49
+ self.waiters = []
50
+ return succeed(True)
51
+
52
+ def _flush_scheduled(self) -> None:
53
+ """:5952-5959."""
54
+ waiters, self.scheduled = self.scheduled, None
55
+ for resume in waiters or ():
56
+ resume(succeed(None))
57
+
58
+ def open(self) -> Effect[bool, Never, Never]:
59
+ """Open and wake every waiter on the dispatcher; False if already open (:5972-5976)."""
60
+
61
+ def go(dispatcher: SchedulerDispatcher) -> Effect[bool, Never, Never]:
62
+ if self._is_open:
63
+ return succeed(False)
64
+ self._is_open = True
65
+ return self._schedule(dispatcher)
66
+
67
+ return with_dispatcher(go)
68
+
69
+ def release(self) -> Effect[bool, Never, Never]:
70
+ """Wake current waiters and stay closed; False if open (:5977)."""
71
+ return with_dispatcher(lambda d: succeed(False) if self._is_open else self._schedule(d))
72
+
73
+ def open_unsafe(self) -> bool:
74
+ """Open and resume every waiter before returning (:5978-5983, :5960-5971). Both lists are
75
+ swapped out first: a resumed waiter that closes the latch and waits again stays parked."""
76
+ if self._is_open:
77
+ return False
78
+ self._is_open = True
79
+ waiters, self.waiters = self.waiters, []
80
+ self._flush_scheduled()
81
+ for resume in waiters:
82
+ resume(succeed(None))
83
+ return True
84
+
85
+ def await_(self) -> Effect[None, Never, Never]:
86
+ """Wait until open; an interrupted waiter leaves either list (:5984-6000)."""
87
+
88
+ def register(resume: _Resume) -> Effect[None, Never, Never] | None:
89
+ if self._is_open:
90
+ resume(succeed(None))
91
+ return None
92
+ self.waiters.append(resume)
93
+
94
+ def cancel() -> None:
95
+ if resume in self.waiters:
96
+ self.waiters.remove(resume)
97
+ elif self.scheduled is not None and resume in self.scheduled:
98
+ self.scheduled.remove(resume)
99
+
100
+ return sync(cancel)
101
+
102
+ return async_(register)
103
+
104
+ def close_unsafe(self) -> bool:
105
+ """Close; False if already closed (:6001-6005)."""
106
+ if not self._is_open:
107
+ return False
108
+ self._is_open = False
109
+ return True
110
+
111
+ def close(self) -> Effect[bool, Never, Never]:
112
+ """:6006."""
113
+ return sync(self.close_unsafe)
114
+
115
+ def when_open[A, E, R](self, eff: Effect[A, E, R]) -> Effect[A, E, R]:
116
+ """Run ``eff`` once the latch is open (:6007)."""
117
+ return self.await_().flat_map(lambda _: eff)
118
+
119
+ def is_open(self) -> bool:
120
+ return self._is_open