Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bswck/class_singledispatch
A singledispatch() for arguments that are classes annotated as specific types.
https://github.com/bswck/class_singledispatch
python singledispatch
Last synced: 23 days ago
JSON representation
A singledispatch() for arguments that are classes annotated as specific types.
- Host: GitHub
- URL: https://github.com/bswck/class_singledispatch
- Owner: bswck
- License: mit
- Created: 2023-08-27T10:17:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-21T23:08:36.000Z (7 months ago)
- Last Synced: 2024-06-22T17:25:56.445Z (5 months ago)
- Topics: python, singledispatch
- Language: Python
- Homepage: https://class-singledispatch.readthedocs.io
- Size: 215 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
#
class_singledispatch
[](https://github.com/skeleton-ci/skeleton-python/tree/0.0.2rc-224-ge16504a) [](https://pypi.org/project/class-singledispatch/) [](https://pypi.org/project/class-singledispatch/)
[](https://github.com/bswck/class_singledispatch/actions/workflows/test.yml)
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/class_singledispatch)
[](https://class-singledispatch.readthedocs.io/en/latest/?badge=latest)
A [``singledispatch()``](https://docs.python.org/3/library/functools.html#functools.singledispatch) for arguments that are classes annotated as specific types.
Inspired by https://github.com/python/cpython/issues/100623.
# A Simple Example
While `functools.singledispatch` examines the class of the first user argument,
`class_singledispatch` uses the first argument as the class itself and performs
the same task with it as `functools.singledispatch`.
```python
from class_singledispatch import class_singledispatch
class T:
pass
class OtherT:
pass
@class_singledispatch
def on_class(cls: type[T], /) -> None:
print("T!")
@on_class.register
def on_other_class(cls: type[OtherT], /) -> None:
print("OtherT!")
# Useful for <3.10 without eval_type_backport -- pass the class to the decorator
# not to use the annotation from the function for the targeted class resolution
@on_class.register(SomeOtherT)
def on_some_other_class(cls: type[SomeOtherT], /) -> None:
print("SomeOtherT!")
on_class(T) # T!
on_class(OtherT) # OtherT!
on_class(SomeOtherT) # SomeOtherT!
```
# Installation
You might simply install it with pip:
```shell
pip install class-singledispatch
```
> [!Note]
> `class-singledispatch` supports modern type hinting.
> To use [PEP 585](https://peps.python.org/pep-0585/)
> or [PEP 604](https://peps.python.org/pep-0604/) annotations on Python <3.10, install
> `class-singledispatch[modern-type-hints]`.
If you use [Poetry](https://python-poetry.org/), then you might want to run:
```shell
poetry add class-singledispatch
```
## For Contributors
[](https://python-poetry.org/)
[](https://github.com/astral-sh/ruff)
[](https://github.com/pre-commit/pre-commit)
> [!Note]
> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
1. Fork the [class_singledispatch repository](https://github.com/bswck/class_singledispatch) on GitHub.
1. [Install Poetry](https://python-poetry.org/docs/#installation).
Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):
```shell
pipx install poetry
```
If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.
Be sure to have Python 3.8 installed—if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:
```shell
pyenv install 3.8
```
1. Clone your fork locally and install dependencies.
```shell
git clone https://github.com/your-username/class_singledispatch path/to/class_singledispatch
cd path/to/class_singledispatch
poetry env use $(cat .python-version)
poetry install
```
Next up, simply activate the virtual environment and install pre-commit hooks:
```shell
poetry shell
pre-commit install
```
For more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/class_singledispatch/blob/HEAD/CONTRIBUTING.md).
Always happy to accept contributions! ❤️
# Legal Info
© Copyright by Bartosz Sławecki ([@bswck](https://github.com/bswck)).
This software is licensed under the terms of [MIT License](https://github.com/bswck/class_singledispatch/blob/HEAD/LICENSE).