plum-dispatch

• Support union aliases in Python 3.14 and later (@nstarman).

Starting this release, Plum will be available on PyPI as both plum-dispatch and plum.

• Add faithful keyword to ModuleType.

Note: All imports should now go through plum directly! That is, not plum.signature.Signature, but plum.Signature. Please do open an issue if this release breaks something that shouldn't break.

Changes:

• Significantly improve typing of the internals (#179 and #242 by @nstarman).
• Switch to uv (#218 by @nstarman).
• Make modules private for public/private separation (#241 by @nstarman).
• Switch to src layout (#249 by @nstarman).
• Improve config (#248 by @nstarman).
• Enable mypyc builds for better performance (#247 by @nstarman)!

This release features numerous very helpful contributions and improvements by @nstarman!

• Use dependency groups (#195).
• Treat typing_extensions as standard library and make more use of it (#226 and #232).
• Complete deprecation cycles (#230 and #236).
• Turn various arguments into positional-only (#229).
• Remove unnecessary path manipulation (#233).
• Rework tests with a dispatch fixture (#234).
• Avoid using a deprecated NumPy module (#231).
• Drops support for Python 3.9 (#228).
• Import exports from methods.py (#237).
• Fixes an incorrect overload (#238).
• Use nox for testing (#235 and #240).

#228 also fixes an important bug to do with the handling of unions (CC @davidwyld).

• Add keyword argument condition to ModuleType.

• Fix precedence keyword argument (thanks @nstarman!).
• Fix complex method override.
• Drop support for Python 8 and use e.g. list instead of typing.List (thanks @nstarman!).

• Allow type_to in add_promotion_rule to be an object.

• Add more types to various functions and classes (thanks again @nstarman!!).

• Add types for convert (thanks @nstarman!).

• Expose the attribute dispatch for bound functions (thanks @nstarman!).

• Expose methods to bound functions. (Thanks @nstarman!)

• Make typing_extensions a runtime requirement for all Python versions.

What's Changed

• Require typing-extensions>=4.9.0 for python older than 3.11 by @francesco-ballarin in https://github.com/beartype/plum/pull/182

New Contributors

• @francesco-ballarin made their first contribution in https://github.com/beartype/plum/pull/182

Full Changelog: https://github.com/beartype/plum/compare/v2.5.1...v2.5.1.post1

• Make redefinition warnings opt-in by setting warn_redefinition=True in Dispatcher, Function, or Resolver.
• Fix bug where default arguments where handled incorrectly, generating additional erroneous methods.

• Fix failing import of typing_extensions (@PhilipVinc).
• Deprecate Val (@nstarman).

• Deprecate multihash (thanks @nstarman!).
• Add type hints in various places. (also @nstarman :)).

• Do not unnecessarily redefine a method when a self-promotion rule is defined. (#170 by @nstarman)

• refactor: small cleanup by @nstarman in https://github.com/beartype/plum/pull/157
• Raise warning when a method is overwritten by @wesselb in https://github.com/beartype/plum/pull/161

Full Changelog: https://github.com/beartype/plum/compare/v2.4.1...v2.4.2

• Better handle C-defined classes (#152) (thanks @PhilipVinc!).

• Improvement to the dispatch algorithm by avoiding unnecessary ambiguities. See #117 and #151. The algorithm is still not optimal, but this is a clear step in the right direction. Thanks to @PhilipVinc!

• Add type_nonparametric (thanks @nstarman!).

• Add allow_fail to ModuleType.

• Add type_unparametrized. (Thanks @nstarman! :) )

• Let conversion_method return the function. (Thanks @nstarman!)

• Improve rendering of function calls in exceptions.
• Don't print a @ if the source cannot be resolved.

• Fix support for Annotated, thanks to @hodgespodge!

This update brings very pretty method printing! Yay. A massive thanks to @PhilipVinc, who contributed quite many PRs to implement this.

Consider

from numbers import Number

from plum import dispatch


@dispatch
def add(x: int, y: Number):
    return x + y


@dispatch
def add(x: Number, y: int):
    return x + y

Now methods print nicely:

<img width="647" alt="image" src="https://github.com/beartype/plum/assets/1444448/de736ccf-1b9a-4d04-82f8-3e3b4cb0f434">

In case of a mismatch, the exception shows which methods you could've meant:

<img width="895" alt="image" src="https://github.com/beartype/plum/assets/1444448/c92f6e5c-6ca5-4bca-a046-0fc13e276761">

And in the case of an ambiguity, the exception nicely shows which methods cannot be disambiguated:

<img width="737" alt="image" src="https://github.com/beartype/plum/assets/1444448/d1b062a5-c94c-4de7-9a0f-2c8bef6364f6">

• Update Beartype to 0.16.2.
• Fix #105 (thanks @PhilipVinc!).
• Add PLUM_SIMPLE_DOC environment variable.

• Temporarily remove deprecation warning for Val. (Thanks, @PhilipVinc!)

• Support mypy-compliant pattern suggested by @gabrieldemarmiesse, @wch, and @machow.
• Integrate mypy and pyright tests into CI.

• Fixes #83.
• Generate docstrings play nice with sphinx (#75).

At last, Plum 2!

See #73 and #68.

• Also exclude subdirectories of tests.

• Remove directory tests from release.

• Add support for A | B syntax (thanks @PhilipVinc!).

• Add experimental support for IPython's autoreload extension, by @PhilipVinc. See also #44.

• Fix bug in extract_signature (fixes #41).
• Add support for operator.attrgetter and operator.itemgetter (fixes #43).

• Safely handle C-defined functions in Function.dispatch.

• Fix inspection whenever function.py is compiled with Cython.

• Let Function.dispatch support future annotations.

• Add full support for from __future__ import annotations.

• Automatically unquote forward reference strings. This adds compatibility for from __future__ import annotations.

• Improve error message when dispatching on __call__.

• Release a version for registration on Zenodo.

• Also build wheels for macOS M1.

• Fix building wheels for all platforms. (@PhilipVinc)

• Build wheels for all platforms. (@PhilipVinc)

• Add support for typing.Iterable and typing.Sequence. The implementation of is involves some duplicate code and might miss a few features, but it should suffice for the most common use cases. Cleaning this up is left as a future TODO, along with other refactoring.

• Fix/improve behaviour for default arguments (@PhilipVinc).

• Fix inheritance for @parametric.
• Allow promises to be delivered twice.

• Fix bug surrounding runtime_type_of (@PhilipVinc).

• Add support for typing.Dict.