tagged-enum 1.0.0__tar.gz

tagged_enum-1.0.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

tagged_enum-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robert Barker
+
+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.

tagged_enum-1.0.0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: tagged-enum
+Version: 1.0.0
+Summary: Tagged enums for Python
+Project-URL: Homepage, https://github.com/rob-barker/tagged-enum
+Project-URL: Repository, https://github.com/rob-barker/tagged-enum
+Project-URL: Issues, https://github.com/rob-barker/tagged-enum/issues
+Author-email: Rob Barker <rob.barker.official@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: discriminated-union,enum,pattern-matching,tagged-enum,tagged-union
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# tagged-enum
+
+Tagged enums for Python 🐍. 
+
+Tagged enums (a.k.a. discriminated unions, enums with associated values, etc.)
+are enums where each case carries a typed **payload**. 
+
+```python
+from tagged_enum import TaggedEnum
+
+# Declare a tagged enum
+class Shape(TaggedEnum):
+    CIRCLE = float                   # radius
+    RECTANGLE = tuple[float, float]  # width, height
+    TRIANGLE = tuple[float, float]   # base, height
+
+def area(shape: Shape) -> float:
+    # match over enum cases
+    match shape:
+        case Shape(kind=Shape.CIRCLE, payload=radius):
+            return 3.14159 * radius ** 2
+        case Shape(kind=Shape.RECTANGLE, payload=(w, h)):
+            return w * h
+        case Shape(kind=Shape.TRIANGLE, payload=(b, h)):
+            return 0.5 * b * h
+
+shapes = [Shape.CIRCLE(2.0), 
+          Shape.RECTANGLE((3.0, 4.0)), 
+          Shape.TRIANGLE((6.0, 2.0))]
+
+[area(s) for s in shapes] # [12.57, 12.0, 6.0]
+```
+
+This is one of my favorite features from [Swift](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/enumerations/#Associated-Values) and [Rust](https://doc.rust-lang.org/rust-by-example/custom_types/enum.html) so I brought it to Python 😈.
+
+## ⬇ Installation
+
+```bash
+pip install tagged-enum
+```
+
+Requires Python 3.11+
+
+## 🤔 How to use
+
+Each uppercase attribute on a `TaggedEnum` subclass declares a *case*. The
+value assigned to it is the *type* of payload that case carries. `None`
+means the case carries nothing.
+
+```python
+class GameEvent(TaggedEnum):
+    PLAYER_JOINED = str             # player name
+    DAMAGE_DEALT = tuple[str, int]  # target, amount
+    GAME_OVER = None                # void
+```
+
+Calling a case constructs an **instance**, and the payload is checked against
+the declared type on instantiation.
+
+```python
+GameEvent.PLAYER_JOINED("Ada")            # 👍
+GameEvent.DAMAGE_DEALT(("Jeff", 42))      # 👍
+GameEvent.GAME_OVER()                     # 👍
+GameEvent.PLAYER_JOINED(-1)               # 👎 - TypeError
+```
+
+### 🧩 Typing
+
+Payload declarations may be plain types, generic containers, unions, custom types, or forward references to the enclosing class for recursive structures:
+
+```python
+class Json(TaggedEnum):
+    NULL = None
+    NUMBER = float
+    STRING = str
+    ARRAY = list["Json"]
+    OBJECT = dict[str, "Json"]
+    CUSTOM = MyDataclass
+
+Json.OBJECT({
+    "name": Json.STRING("Ada"),
+    "tags": Json.ARRAY([Json.STRING("math"), Json.NUMBER(1815.0)]),
+    "other": Json.CUSTOM(MyDataclass())
+})
+```
+
+`Union[...]` or `X | Y` and `Optional[...]` payloads are also valid types. Construction succeeds if the value matches any member of the union:
+
+```python
+class ID(TaggedEnum):
+    VALUE = int | str
+
+ID.VALUE(42)     # 👍
+ID.VALUE("abc")  # 👍
+ID.VALUE(4.2)    # 👎 - TypeError
+```
+
+Type checking validates the outer container (e.g. `list`, `dict`, which
+member of a `Union`) but does not recurse into generic type parameters, and
+skips validation entirely for unresolved forward references like `"Json"`
+above.
+
+### ✨ Pattern Matching
+
+Tagged enums are unpacked with Python's native [match statement](https://docs.python.org/3/tutorial/controlflow.html#match-statements) using the `kind`/`payload` attributes:
+
+```python
+def handle(event: GameEvent) -> str:
+    match event:
+        case GameEvent(kind=GameEvent.PLAYER_JOINED, payload=name):
+            return f"{name} joined the game"
+        case GameEvent(kind=GameEvent.DAMAGE_DEALT, payload=(target, amount)):
+            return f"{target} took {amount} damage"
+        case GameEvent(kind=GameEvent.GAME_OVER):
+            return "Game over"
+
+handle(GameEvent.DAMAGE_DEALT(("Grendel", 42)))
+# 'Grendel took 42 damage'
+```
+
+When you only care about which case you're looking at and not the payload, use `.kind` to return the tag itself (also called the **member**):
+
+```python
+if event.kind is GameEvent.Kind.PLAYER_JOINED:
+    print("player joined")
+
+match event.kind:
+    case GameEvent.Kind.PLAYER_JOINED:
+        ...
+    case GameEvent.Kind.GAME_OVER:
+        ...
+```
+
+`GameEvent.PLAYER_JOINED` (the **member**) and
+`GameEvent.PLAYER_JOINED(...)` (an **instance**) are different objects and ideas. The member is a singleton tag you compare with `is`, while the instance carries the actual data payload. Members and instances are not equal (by `==`). Instances of the same kind/case are equal if and only if their payload values are equal. 
+
+The `Kind` type attribute is a type-level alias for annotating variables that should hold a case rather than an instance.
+
+```python
+def describe(kind: GameEvent.Kind) -> str:
+    if kind is GameEvent.Kind.PLAYER_JOINED:
+        do_something()
+
+describe(event.kind) # 'damage was dealt'
+```
+
+## 🤓 Development
+
+This project uses [`uv`](https://docs.astral.sh/uv/) for dependency management.
+
+```bash
+uv sync
+uv run pytest
+```
+
+### Building
+
+Build the sdist/wheel into `dist/`:
+
+```bash
+uv build
+```
+
+To try the library locally without installing it anywhere:
+
+```bash
+# drop into a REPL
+uv run python
+# OR run a script inside the project's environment
+uv run python my_script.py
+```
+
+### 🧪 Testing 
+
+Tests live in `tests/`, split by topic (construction, equality/hashing,
+pattern matching, generic payloads, etc.) so a single area can be run in
+isolation, e.g.:
+
+```bash
+uv run pytest tests/test_generic_payloads.py
+```
+
+Without `uv`, the equivalent is:
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+## 🛠️ Contribution Guidelines
+
+This repository is open source, though maintenance is infrequent. Please be
+patient 🥺.
+
+- **File an issue first:** Anything beyond a small fix should be discussed in an issue
+  before you put work into a PR.
+- **Keep PRs focused:** One change or feature per PR, branched off `Development`
+  and rebased/updated before you submit.
+- **Branch naming:** `issues/<issue-number>`, optionally with a short
+  description, e.g. `issues/123-fix-a-bug`.
+- **Include a description and test coverage:** Explain what changed and
+  why, add or update tests under `tests/`, and reference the issue it
+  closes.
+
+Thanks for helping keep this repo clean and organized! 😁

tagged_enum-1.0.0/README.md

@@ -0,0 +1,205 @@
+# tagged-enum
+
+Tagged enums for Python 🐍. 
+
+Tagged enums (a.k.a. discriminated unions, enums with associated values, etc.)
+are enums where each case carries a typed **payload**. 
+
+```python
+from tagged_enum import TaggedEnum
+
+# Declare a tagged enum
+class Shape(TaggedEnum):
+    CIRCLE = float                   # radius
+    RECTANGLE = tuple[float, float]  # width, height
+    TRIANGLE = tuple[float, float]   # base, height
+
+def area(shape: Shape) -> float:
+    # match over enum cases
+    match shape:
+        case Shape(kind=Shape.CIRCLE, payload=radius):
+            return 3.14159 * radius ** 2
+        case Shape(kind=Shape.RECTANGLE, payload=(w, h)):
+            return w * h
+        case Shape(kind=Shape.TRIANGLE, payload=(b, h)):
+            return 0.5 * b * h
+
+shapes = [Shape.CIRCLE(2.0), 
+          Shape.RECTANGLE((3.0, 4.0)), 
+          Shape.TRIANGLE((6.0, 2.0))]
+
+[area(s) for s in shapes] # [12.57, 12.0, 6.0]
+```
+
+This is one of my favorite features from [Swift](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/enumerations/#Associated-Values) and [Rust](https://doc.rust-lang.org/rust-by-example/custom_types/enum.html) so I brought it to Python 😈.
+
+## ⬇ Installation
+
+```bash
+pip install tagged-enum
+```
+
+Requires Python 3.11+
+
+## 🤔 How to use
+
+Each uppercase attribute on a `TaggedEnum` subclass declares a *case*. The
+value assigned to it is the *type* of payload that case carries. `None`
+means the case carries nothing.
+
+```python
+class GameEvent(TaggedEnum):
+    PLAYER_JOINED = str             # player name
+    DAMAGE_DEALT = tuple[str, int]  # target, amount
+    GAME_OVER = None                # void
+```
+
+Calling a case constructs an **instance**, and the payload is checked against
+the declared type on instantiation.
+
+```python
+GameEvent.PLAYER_JOINED("Ada")            # 👍
+GameEvent.DAMAGE_DEALT(("Jeff", 42))      # 👍
+GameEvent.GAME_OVER()                     # 👍
+GameEvent.PLAYER_JOINED(-1)               # 👎 - TypeError
+```
+
+### 🧩 Typing
+
+Payload declarations may be plain types, generic containers, unions, custom types, or forward references to the enclosing class for recursive structures:
+
+```python
+class Json(TaggedEnum):
+    NULL = None
+    NUMBER = float
+    STRING = str
+    ARRAY = list["Json"]
+    OBJECT = dict[str, "Json"]
+    CUSTOM = MyDataclass
+
+Json.OBJECT({
+    "name": Json.STRING("Ada"),
+    "tags": Json.ARRAY([Json.STRING("math"), Json.NUMBER(1815.0)]),
+    "other": Json.CUSTOM(MyDataclass())
+})
+```
+
+`Union[...]` or `X | Y` and `Optional[...]` payloads are also valid types. Construction succeeds if the value matches any member of the union:
+
+```python
+class ID(TaggedEnum):
+    VALUE = int | str
+
+ID.VALUE(42)     # 👍
+ID.VALUE("abc")  # 👍
+ID.VALUE(4.2)    # 👎 - TypeError
+```
+
+Type checking validates the outer container (e.g. `list`, `dict`, which
+member of a `Union`) but does not recurse into generic type parameters, and
+skips validation entirely for unresolved forward references like `"Json"`
+above.
+
+### ✨ Pattern Matching
+
+Tagged enums are unpacked with Python's native [match statement](https://docs.python.org/3/tutorial/controlflow.html#match-statements) using the `kind`/`payload` attributes:
+
+```python
+def handle(event: GameEvent) -> str:
+    match event:
+        case GameEvent(kind=GameEvent.PLAYER_JOINED, payload=name):
+            return f"{name} joined the game"
+        case GameEvent(kind=GameEvent.DAMAGE_DEALT, payload=(target, amount)):
+            return f"{target} took {amount} damage"
+        case GameEvent(kind=GameEvent.GAME_OVER):
+            return "Game over"
+
+handle(GameEvent.DAMAGE_DEALT(("Grendel", 42)))
+# 'Grendel took 42 damage'
+```
+
+When you only care about which case you're looking at and not the payload, use `.kind` to return the tag itself (also called the **member**):
+
+```python
+if event.kind is GameEvent.Kind.PLAYER_JOINED:
+    print("player joined")
+
+match event.kind:
+    case GameEvent.Kind.PLAYER_JOINED:
+        ...
+    case GameEvent.Kind.GAME_OVER:
+        ...
+```
+
+`GameEvent.PLAYER_JOINED` (the **member**) and
+`GameEvent.PLAYER_JOINED(...)` (an **instance**) are different objects and ideas. The member is a singleton tag you compare with `is`, while the instance carries the actual data payload. Members and instances are not equal (by `==`). Instances of the same kind/case are equal if and only if their payload values are equal. 
+
+The `Kind` type attribute is a type-level alias for annotating variables that should hold a case rather than an instance.
+
+```python
+def describe(kind: GameEvent.Kind) -> str:
+    if kind is GameEvent.Kind.PLAYER_JOINED:
+        do_something()
+
+describe(event.kind) # 'damage was dealt'
+```
+
+## 🤓 Development
+
+This project uses [`uv`](https://docs.astral.sh/uv/) for dependency management.
+
+```bash
+uv sync
+uv run pytest
+```
+
+### Building
+
+Build the sdist/wheel into `dist/`:
+
+```bash
+uv build
+```
+
+To try the library locally without installing it anywhere:
+
+```bash
+# drop into a REPL
+uv run python
+# OR run a script inside the project's environment
+uv run python my_script.py
+```
+
+### 🧪 Testing 
+
+Tests live in `tests/`, split by topic (construction, equality/hashing,
+pattern matching, generic payloads, etc.) so a single area can be run in
+isolation, e.g.:
+
+```bash
+uv run pytest tests/test_generic_payloads.py
+```
+
+Without `uv`, the equivalent is:
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+## 🛠️ Contribution Guidelines
+
+This repository is open source, though maintenance is infrequent. Please be
+patient 🥺.
+
+- **File an issue first:** Anything beyond a small fix should be discussed in an issue
+  before you put work into a PR.
+- **Keep PRs focused:** One change or feature per PR, branched off `Development`
+  and rebased/updated before you submit.
+- **Branch naming:** `issues/<issue-number>`, optionally with a short
+  description, e.g. `issues/123-fix-a-bug`.
+- **Include a description and test coverage:** Explain what changed and
+  why, add or update tests under `tests/`, and reference the issue it
+  closes.
+
+Thanks for helping keep this repo clean and organized! 😁