typed-event 1.0.0__tar.gz

typed_event-1.0.0/.gitignore

@@ -0,0 +1,13 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.coverage
+uv.lock
+.vscode/settings.json

typed_event-1.0.0/.python-version

@@ -0,0 +1 @@
+3.13

typed_event-1.0.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 J. Löhnert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

typed_event-1.0.0/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: typed-event
+Version: 1.0.0
+Summary: Strongly-typed event decorator
+Project-URL: Homepage, http://github.com/loehnertj/typed_event
+Project-URL: Repository, http://github.com/loehnertj/typed_event
+Author-email: Johannes Loehnert <loehnert.kde@gmx.de>
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# typed-event
+
+Strongly-typed events for Python via an `@event` decorator.
+
+`typed-event` lets you define an event from a function/method prototype, then
+subscribe listeners with `+=` and unsubscribe with `-=`.
+
+## Installation
+
+```bash
+pip install typed-event
+```
+
+## Quick start
+
+### Module-level event
+
+```python
+from typed_event import event
+
+
+@event
+def counter_changed(new_value: int, /):
+	"""Fired whenever the counter changes."""
+
+
+def print_value(new_value: int):
+	print("new value:", new_value)
+
+
+counter_changed += print_value
+counter_changed(42)
+counter_changed -= print_value
+```
+
+Note that by default, `@event` requires you to make it explicit whether values
+are passed positionally or as keyword.
+
+### Class events
+
+```python
+from typed_event import event
+
+
+class Counter:
+	def __init__(self):
+		self._value = 0
+
+	@event
+	def changed(value: int, /):
+		"""Fired when value changes."""
+
+	def set_value(self, value: int):
+		self._value = value
+		self.changed(value)  # fire the event
+
+
+c1 = Counter()
+c2 = Counter()
+
+def on_c1(value: int):
+	print("c1:", value)
+
+def on_c2(value: int):
+	print("c2:", value)
+
+c1.changed += on_c1
+c2.changed += on_c2
+
+c1.set_value(1)  # prints "c1: 1"
+c2.set_value(2)  # prints "c2: 2"
+```
+
+Each instance gets its own bound event with its own listener list.
+
+## Defining event prototypes
+
+Prototype restrictions:
+
+- No default argument values.
+- No `*args` / `**kwargs` in the event prototype.
+- Strict mode (enabled by default) requires parameters to be explicitly positional-only (`/`) or keyword-only (`*`). Opt-out by using `@event(strict=False)`.
+
+Example with explicit keyword-only parameters:
+
+```python
+from typed_event import event
+
+
+@event
+def changed(*, a: int, b: int):
+	pass
+
+
+changed(a=1, b=2)      # ok
+# changed(1, 2)         # TypeError
+```
+
+**Notes:**
+
+- Listener signatures are not validated at subscription time; a mismatch only fails when invoked.
+- Type annotations are **not** runtime-enforced — the name refers to static typing support, not runtime checks.
+
+## Cancellation
+
+Raise `CancelEvent` in a listener to stop processing remaining listeners:
+
+```python
+from typed_event import event, CancelEvent
+
+
+@event
+def changed(value: int, /):
+	pass
+
+
+def first(value: int):
+	raise CancelEvent()
+
+
+def second(value: int):
+	print("never called")
+
+
+changed += first
+changed += second
+changed(1)
+```
+
+## Exception handling policy
+
+Set via `@event(exceptions=...)`:
+
+- `"default"` (default): passes exceptions to `sys.excepthook`.
+- `"log"`: logs exceptions via `logging.exception`.
+- `"raise"`: re-raises immediately and stops further listeners. I.e. no "handling" at all.
+- `"group"`: runs all listeners, then raises `ExceptionGroup` if any failed.
+
+`CancelEvent` is handled separately and is never treated as an error.
+
+## Return values
+
+At most one non-`None` return value is allowed across prototype + listeners.
+If multiple handlers return a value, a `RuntimeError` is raised.
+
+## Changing event settings on module / project level
+
+To define many events with changed settings (e.g. different default for `exception`), make an alias decorator like so:
+
+```
+from typed_event import event
+my_event = event(strict=False, exceptions="log")
+
+@my_event
+def event1(): ...
+
+@my_event
+def event2(): ...
+```
+
+To apply project-wide, define the alias in a helper module and import from there.
+
+## Changelog
+
+### Version 1.0 (23.03.2026)
+
+First release of the library as standalone project. Previously it was part of [ASCII
+Designer](https://github.com/loehnertj/ascii_designer).
+
+Minor changes happened (strict mode as default, using sys.excepthook instead of
+print). Besides that, comprehensive testing and documentation was added.
+
+## License
+
+Provided under [MIT license](LICENSE).

typed_event-1.0.0/README.md

@@ -0,0 +1,175 @@
+# typed-event
+
+Strongly-typed events for Python via an `@event` decorator.
+
+`typed-event` lets you define an event from a function/method prototype, then
+subscribe listeners with `+=` and unsubscribe with `-=`.
+
+## Installation
+
+```bash
+pip install typed-event
+```
+
+## Quick start
+
+### Module-level event
+
+```python
+from typed_event import event
+
+
+@event
+def counter_changed(new_value: int, /):
+	"""Fired whenever the counter changes."""
+
+
+def print_value(new_value: int):
+	print("new value:", new_value)
+
+
+counter_changed += print_value
+counter_changed(42)
+counter_changed -= print_value
+```
+
+Note that by default, `@event` requires you to make it explicit whether values
+are passed positionally or as keyword.
+
+### Class events
+
+```python
+from typed_event import event
+
+
+class Counter:
+	def __init__(self):
+		self._value = 0
+
+	@event
+	def changed(value: int, /):
+		"""Fired when value changes."""
+
+	def set_value(self, value: int):
+		self._value = value
+		self.changed(value)  # fire the event
+
+
+c1 = Counter()
+c2 = Counter()
+
+def on_c1(value: int):
+	print("c1:", value)
+
+def on_c2(value: int):
+	print("c2:", value)
+
+c1.changed += on_c1
+c2.changed += on_c2
+
+c1.set_value(1)  # prints "c1: 1"
+c2.set_value(2)  # prints "c2: 2"
+```
+
+Each instance gets its own bound event with its own listener list.
+
+## Defining event prototypes
+
+Prototype restrictions:
+
+- No default argument values.
+- No `*args` / `**kwargs` in the event prototype.
+- Strict mode (enabled by default) requires parameters to be explicitly positional-only (`/`) or keyword-only (`*`). Opt-out by using `@event(strict=False)`.
+
+Example with explicit keyword-only parameters:
+
+```python
+from typed_event import event
+
+
+@event
+def changed(*, a: int, b: int):
+	pass
+
+
+changed(a=1, b=2)      # ok
+# changed(1, 2)         # TypeError
+```
+
+**Notes:**
+
+- Listener signatures are not validated at subscription time; a mismatch only fails when invoked.
+- Type annotations are **not** runtime-enforced — the name refers to static typing support, not runtime checks.
+
+## Cancellation
+
+Raise `CancelEvent` in a listener to stop processing remaining listeners:
+
+```python
+from typed_event import event, CancelEvent
+
+
+@event
+def changed(value: int, /):
+	pass
+
+
+def first(value: int):
+	raise CancelEvent()
+
+
+def second(value: int):
+	print("never called")
+
+
+changed += first
+changed += second
+changed(1)
+```
+
+## Exception handling policy
+
+Set via `@event(exceptions=...)`:
+
+- `"default"` (default): passes exceptions to `sys.excepthook`.
+- `"log"`: logs exceptions via `logging.exception`.
+- `"raise"`: re-raises immediately and stops further listeners. I.e. no "handling" at all.
+- `"group"`: runs all listeners, then raises `ExceptionGroup` if any failed.
+
+`CancelEvent` is handled separately and is never treated as an error.
+
+## Return values
+
+At most one non-`None` return value is allowed across prototype + listeners.
+If multiple handlers return a value, a `RuntimeError` is raised.
+
+## Changing event settings on module / project level
+
+To define many events with changed settings (e.g. different default for `exception`), make an alias decorator like so:
+
+```
+from typed_event import event
+my_event = event(strict=False, exceptions="log")
+
+@my_event
+def event1(): ...
+
+@my_event
+def event2(): ...
+```
+
+To apply project-wide, define the alias in a helper module and import from there.
+
+## Changelog
+
+### Version 1.0 (23.03.2026)
+
+First release of the library as standalone project. Previously it was part of [ASCII
+Designer](https://github.com/loehnertj/ascii_designer).
+
+Minor changes happened (strict mode as default, using sys.excepthook instead of
+print). Besides that, comprehensive testing and documentation was added.
+
+## License
+
+Provided under [MIT license](LICENSE).

typed_event-1.0.0/htmlcov/.gitignore

@@ -0,0 +1,2 @@
+# Created by coverage.py
+*

typed_event-1.0.0/htmlcov/class_index.html

@@ -0,0 +1,141 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Coverage report</title>
+    <link rel="icon" sizes="32x32" href="favicon_32_cb_c827f16f.png">
+    <link rel="stylesheet" href="style_cb_9ff733b0.css" type="text/css">
+    <script src="coverage_html_cb_dd2e7eb5.js" defer></script>
+</head>
+<body class="indexfile">
+<header>
+    <div class="content">
+        <h1>Coverage report:
+            <span class="pc_cov">100%</span>
+        </h1>
+        <aside id="help_panel_wrapper">
+            <input id="help_panel_state" type="checkbox">
+            <label for="help_panel_state">
+                <img id="keyboard_icon" src="keybd_closed_cb_900cfef5.png" alt="Show/hide keyboard shortcuts">
+            </label>
+            <div id="help_panel">
+                <p class="legend">Shortcuts on this page</p>
+                <div class="keyhelp">
+                    <p>
+                        <kbd>f</kbd>
+                        <kbd>n</kbd>
+                        <kbd>s</kbd>
+                        <kbd>m</kbd>
+                        <kbd>x</kbd>
+                        <kbd>c</kbd>
+                        &nbsp; change column sorting
+                    </p>
+                    <p>
+                        <kbd>[</kbd>
+                        <kbd>]</kbd>
+                        &nbsp; prev/next file
+                    </p>
+                    <p>
+                        <kbd>?</kbd> &nbsp; show/hide this help
+                    </p>
+                </div>
+            </div>
+        </aside>
+        <form id="filter_container">
+            <input id="filter" type="text" value="" placeholder="filter...">
+            <div>
+                <input id="hide100" type="checkbox" >
+                <label for="hide100">hide covered</label>
+            </div>
+        </form>
+        <h2>
+                <a class="button" href="index.html">Files</a>
+                <a class="button" href="function_index.html">Functions</a>
+                <a class="button current">Classes</a>
+        </h2>
+        <p class="text">
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.13.5">coverage.py v7.13.5</a>,
+            created at 2026-03-20 21:27 +0100
+        </p>
+    </div>
+</header>
+<main id="index">
+    <table class="index" data-sortable>
+        <thead>
+            <tr class="tablehead" title="Click to sort">
+                <th id="file" class="name" aria-sort="none" data-shortcut="f">File<span class="arrows"></span></th>
+                <th id="region" class="name" aria-sort="none" data-default-sort-order="ascending" data-shortcut="n">class<span class="arrows"></span></th>
+                <th class="spacer">&nbsp;</th>
+                <th id="statements" aria-sort="none" data-default-sort-order="descending" data-shortcut="s">statements<span class="arrows"></span></th>
+                <th id="missing" aria-sort="none" data-default-sort-order="descending" data-shortcut="m">missing<span class="arrows"></span></th>
+                <th id="excluded" aria-sort="none" data-default-sort-order="descending" data-shortcut="x">excluded<span class="arrows"></span></th>
+                <th class="spacer">&nbsp;</th>
+                <th id="coverage" aria-sort="none" data-shortcut="c">coverage<span class="arrows"></span></th>
+            </tr>
+        </thead>
+        <tbody>
+            <tr class="region">
+                <td class="name"><a href="z_145eef247bfb46b6_typed_event_py.html#t43">src&#8201;/&#8201;typed_event.py</a></td>
+                <td class="name"><a href="z_145eef247bfb46b6_typed_event_py.html#t43"><data value='CancelEvent'>CancelEvent</data></a></td>
+                <td class="spacer">&nbsp;</td>
+                <td>0</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="spacer">&nbsp;</td>
+                <td data-ratio="0 0">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name"><a href="z_145eef247bfb46b6_typed_event_py.html#t47">src&#8201;/&#8201;typed_event.py</a></td>
+                <td class="name"><a href="z_145eef247bfb46b6_typed_event_py.html#t47"><data value='Event'>Event</data></a></td>
+                <td class="spacer">&nbsp;</td>
+                <td>62</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="spacer">&nbsp;</td>
+                <td data-ratio="62 62">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name"><a href="z_145eef247bfb46b6_typed_event_py.html">src&#8201;/&#8201;typed_event.py</a></td>
+                <td class="name"><a href="z_145eef247bfb46b6_typed_event_py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
+                <td class="spacer">&nbsp;</td>
+                <td>26</td>
+                <td>0</td>
+                <td>20</td>
+                <td class="spacer">&nbsp;</td>
+                <td data-ratio="26 26">100%</td>
+            </tr>
+        </tbody>
+        <tfoot>
+            <tr class="total">
+                <td class="name">Total</td>
+                <td class="name">&nbsp;</td>
+                <td class="spacer">&nbsp;</td>
+                <td>88</td>
+                <td>0</td>
+                <td>20</td>
+                <td class="spacer">&nbsp;</td>
+                <td data-ratio="88 88">100%</td>
+            </tr>
+        </tfoot>
+    </table>
+    <p id="no_rows">
+        No items found using the specified filter.
+    </p>
+</main>
+<footer>
+    <div class="content">
+        <p>
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.13.5">coverage.py v7.13.5</a>,
+            created at 2026-03-20 21:27 +0100
+        </p>
+    </div>
+    <aside class="hidden">
+        <a id="prevFileLink" class="nav" href=""></a>
+        <a id="nextFileLink" class="nav" href=""></a>
+        <button type="button" class="button_prev_file" data-shortcut="["></button>
+        <button type="button" class="button_next_file" data-shortcut="]"></button>
+        <button type="button" class="button_show_hide_help" data-shortcut="?"></button>
+    </aside>
+</footer>
+</body>
+</html>