Add helpers for deprecating classes.
Review Request #13013 — Created May 4, 2023 and submitted
This introduces
ClassDeprecatedMixin
andClassMovedMixin
.
ClassDeprecatedMixin
marks a class as deprecated, emitting a warning
when directly instantiated or subclassed. Warnings are not emitted when
instantiating or subclassing any subclasses of the class, though.
ClassMovedMixin
is similar, but it communicates that a class has moved
elsewhere. It can either take the new class to point to as parameter, or
it can be mixxed into a class that subclasses the new class (useful when
a legacy base class needs to subclass a newer base class).These make use of
__init_subclass__
and keyword arguments in the
subclass list to handle storing state and notifying on subclass. This
gives us metaclass-like functionality without the subclass having to
define state in the class body.
Unit tests pass on all supported versions of Python.
Summary | ID |
---|---|
b3a19cf160e3d83aae78905f870297ca536b2884 |
- Change Summary:
-
Fixed an alphabetical import issue.
- Commits:
-
Summary ID ad6d75742a42620afc415f42ee99e5f6979d9b14 39cd53e2456e56e0b009c1d8d60624f3ba85518a
Checks run (2 succeeded)
- Change Summary:
-
Put the examples in the README into the class docstrings.
- Commits:
-
Summary ID 39cd53e2456e56e0b009c1d8d60624f3ba85518a b9aec00f167178df9199f0200bc06c0d9917f455