multiarg-dispatch 0.1.0__tar.gz

multiarg_dispatch-0.1.0/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Lines starting with # are comments
+* @gblokker

multiarg_dispatch-0.1.0/.github/workflows/cd.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: uv publish --token $UV_PUBLISH_TOKEN

multiarg_dispatch-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.14
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+
+      - name: Install dependencies
+        run: uv sync --frozen --dev
+
+      - name: Run ruff
+        run: uv run ruff check multiarg_dispatch/
+
+      - name: Run mypy
+        run: uv run mypy multiarg_dispatch/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --frozen --dev
+
+      - name: Run pytest
+        run: uv run pytest tests/ -v

multiarg_dispatch-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

multiarg_dispatch-0.1.0/.vscode/settings.json

@@ -0,0 +1,27 @@
+{
+    "editor.formatOnPaste": false,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": false,
+    "files.trimTrailingWhitespace": true,
+    "editor.codeActionsOnSave": {
+        "source.fixAll": "explicit"
+    },
+    "[python]": {
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "explicit"
+        }
+    },
+    "ruff.lineLength": 88,
+    "ruff.lint.select": [
+        "E",
+        "F",
+        "I"
+    ],
+    "ruff.lint.ignore": [
+        "F401"
+    ],
+    "isort.args": [
+        "--profile",
+        "black"
+    ]
+}

multiarg_dispatch-0.1.0/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-03-03
+
+### Added
+- Initial release
+- Multi-argument dispatch functionality based on type hints for all arguments
+- Support for union types in type hints
+- Type checking enforced at registration
+- Warning system for arguments with default values
+- Fully compatible with Python 3.11+
+
+[0.1.0]: https://github.com/gblokker/multiarg-dispatch/releases/tag/v0.1.0

multiarg_dispatch-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Goof Blokker
+
+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.

multiarg_dispatch-0.1.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: multiarg-dispatch
+Version: 0.1.0
+Summary: A replacement function for single dispatch that allows dispatching based on type hints for all arguments.
+Project-URL: Homepage, https://github.com/gblokker/multiarg-dispatch
+Project-URL: Repository, https://github.com/gblokker/multiarg-dispatch
+Project-URL: Issues, https://github.com/gblokker/multiarg-dispatch/issues
+Author-email: Goof Blokker <goofb@live.nl>
+License: MIT
+License-File: LICENSE
+Keywords: dispatch,functools,generic functions,multidispatch,type hints
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# multiarg-dispatch
+
+`multiarg-dispatch` is a Python package that extends the functionality of `functools.singledispatch` to allow dispatching based on **type hints for all arguments**, not just the first one. It provides a simple decorator to define generic functions with multiple implementations depending on argument types.
+
+## Features
+
+- Dispatch functions based on the types of **all arguments**, including keyword arguments.
+- Supports **union types** in type hints.
+- Raises a warning if arguments have default values (since defaults are not considered during dispatch).
+- Type checking enforced at registration: all parameters must have type hints.
+- Fully compatible with Python >3.11.
+- **Note** that the registry uses strong references, so for garbage collection do not forget to delete the function that uses multidispatch.
+- **Note** that local classes cannot be used as type hints, since these are accessible globally to retrieve as type hint.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install multiarg-dispatch
+```
+
+Or with uv:
+
+```bash
+uv add multiarg-dispatch
+```
+
+## Usage
+
+```python
+from multiarg_dispatch import multidispatch, DispatchWarning
+
+@multidispatch
+def test_func(a, b=None):
+    return "default"
+
+@test_func.register
+def _(a: int, b: str = "default") -> str:
+    return f"int:{a},str:{b}"
+
+@test_func.register
+def _(a: str, b: list = []) -> str:
+    if b is None:
+        b = []
+    return f"str:{a},list:{b}"
+
+@test_func.register
+def _(a: float, b: str | list = "default") -> str:
+    return f"float:{a},union:{b}"
+
+print(test_func(10))            # int:10,str:default
+print(test_func("hello", []))   # str:hello,list:[]
+print(test_func(3.14, "extra")) # float:3.14,union:extra
+```
+
+## API
+
+### `multidispatch(func)`
+
+Decorator to make a function multi-dispatch capable.
+
+* `register(func)`: Register a new implementation based on type hints.
+* `dispatch(cls)`: Retrieve the implementation for given types.
+* `registry`: Read-only view of all registered implementations.
+
+### `DispatchWarning`
+
+Warning raised when dispatching might be affected by defaults.
+
+## Contributing
+
+Contributions are welcome! Please follow these guidelines:
+
+1. Fork the repository.
+2. Create a feature branch (`git checkout -b feature/my-feature`).
+3. Make your changes.
+4. Ensure all tests pass (`pytest` recommended).
+5. Open a Pull Request with a clear description of your changes.
+
+Please follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guidelines and include type hints where appropriate.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

multiarg_dispatch-0.1.0/README.md

@@ -0,0 +1,85 @@
+# multiarg-dispatch
+
+`multiarg-dispatch` is a Python package that extends the functionality of `functools.singledispatch` to allow dispatching based on **type hints for all arguments**, not just the first one. It provides a simple decorator to define generic functions with multiple implementations depending on argument types.
+
+## Features
+
+- Dispatch functions based on the types of **all arguments**, including keyword arguments.
+- Supports **union types** in type hints.
+- Raises a warning if arguments have default values (since defaults are not considered during dispatch).
+- Type checking enforced at registration: all parameters must have type hints.
+- Fully compatible with Python >3.11.
+- **Note** that the registry uses strong references, so for garbage collection do not forget to delete the function that uses multidispatch.
+- **Note** that local classes cannot be used as type hints, since these are accessible globally to retrieve as type hint.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install multiarg-dispatch
+```
+
+Or with uv:
+
+```bash
+uv add multiarg-dispatch
+```
+
+## Usage
+
+```python
+from multiarg_dispatch import multidispatch, DispatchWarning
+
+@multidispatch
+def test_func(a, b=None):
+    return "default"
+
+@test_func.register
+def _(a: int, b: str = "default") -> str:
+    return f"int:{a},str:{b}"
+
+@test_func.register
+def _(a: str, b: list = []) -> str:
+    if b is None:
+        b = []
+    return f"str:{a},list:{b}"
+
+@test_func.register
+def _(a: float, b: str | list = "default") -> str:
+    return f"float:{a},union:{b}"
+
+print(test_func(10))            # int:10,str:default
+print(test_func("hello", []))   # str:hello,list:[]
+print(test_func(3.14, "extra")) # float:3.14,union:extra
+```
+
+## API
+
+### `multidispatch(func)`
+
+Decorator to make a function multi-dispatch capable.
+
+* `register(func)`: Register a new implementation based on type hints.
+* `dispatch(cls)`: Retrieve the implementation for given types.
+* `registry`: Read-only view of all registered implementations.
+
+### `DispatchWarning`
+
+Warning raised when dispatching might be affected by defaults.
+
+## Contributing
+
+Contributions are welcome! Please follow these guidelines:
+
+1. Fork the repository.
+2. Create a feature branch (`git checkout -b feature/my-feature`).
+3. Make your changes.
+4. Ensure all tests pass (`pytest` recommended).
+5. Open a Pull Request with a clear description of your changes.
+
+Please follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guidelines and include type hints where appropriate.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

multiarg_dispatch-0.1.0/multiarg_dispatch/__init__.py

@@ -0,0 +1,18 @@
+from .exceptions import (
+    InvalidTypeAnnotationError,
+    MissingTypeAnnotationError,
+    MultiArgDispatchError,
+    RegistrationError,
+)
+from .main import DispatchWarning, multidispatch
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "multidispatch",
+    "DispatchWarning",
+    "MultiArgDispatchError",
+    "MissingTypeAnnotationError",
+    "InvalidTypeAnnotationError",
+    "RegistrationError",
+]

multiarg_dispatch-0.1.0/multiarg_dispatch/exceptions.py

@@ -0,0 +1,34 @@
+"""Custom exceptions for multiarg-dispatch."""
+
+
+class MultiArgDispatchError(Exception):
+    """Base exception for all multiarg-dispatch errors."""
+
+    pass
+
+
+class MissingTypeAnnotationError(MultiArgDispatchError, TypeError):
+    """Raised when a function parameter lacks a required type annotation."""
+
+    pass
+
+
+class InvalidTypeAnnotationError(MultiArgDispatchError, TypeError):
+    """Raised when a type annotation is not valid for dispatch.
+
+    Valid dispatch types are:
+    - Regular classes (type objects)
+    - Union types where all members are classes
+    """
+
+    pass
+
+
+class RegistrationError(MultiArgDispatchError, TypeError):
+    """Raised when function registration fails.
+
+    This typically occurs when registering a function with a different
+    number of parameters than the base function.
+    """
+
+    pass