"You made a thing, but now you wish it'd go away... Deprecations, a love story."
Project description
Regret is a library for deprecating functionality in Python libraries and applications.
Its documentation lives on Read the Docs.
Deprecations
Regret can deprecate:
- [x] callables
[x] functions
- [x] classes
[x] subclassable classes
- [ ] attributes
[ ] of modules
- [ ] of classes
[ ] of old-style classes
[ ] of instances
- [ ] descriptors
[ ] classmethod
[ ] modules
- [ ] arguments to callables
[ ] required arguments that will be removed
[ ] optional arguments that are now required
[ ] deprecated values for arguments
[ ] type changes for argument
[ ] mutual exclusion
- [ ] interfaces
[ ] PEP 544 protocols
[ ] zope.interfaces
Design Goals
Regret is meant to cover all of the deprecations an author may encounter.
It is intended to:
be versioning system agnostic (i.e. SemVer, CalVer, HipsTer, etc.)
be documentation system agnostic, though potentially documentation system aware (i.e. Sphinx, epydoc, Plaintext, etc.)
be itself fully tested
support removal date indication, and likely “policies” which automate choosing default removal dates
make “clean code” trivially easy to deprecate, and make complex code possible to deprecate
minimize the amount of deprecation-related code required for authors
In particular, as a lofty first milestone, it is intended to cover all of the specific deprecations required for these jsonschema issues, and with luck, to subsume all the functionality present in twisted.python.deprecate.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for regret-0.20.4-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3abf398db7877fec72b965bea6fae57aa40be5e75c81a2b35e3398ccfa206613 |
|
| MD5 | 9ddab136ddb3b6a9213b28459eea443b |
|
| BLAKE2b-256 | c918484e0377e7445856b8c52ad2a413e548746c12e09e15ee4da97bdf22f352 |
