Skip to main content

"You made a thing, but now you wish it'd go away... Deprecations, a love story."

Project description

PyPI version Supported Python versions Build status Codecov Code coverage ReadTheDocs status

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
      • [ ] subclassable classes
      • [ ] old-style classes
  • [ ] attributes
  • [ ] descriptors
    • [ ] classmethod
  • [ ] modules
  • [ ] arguments to callables
    • [ ] mutual exclusion
  • [ ] 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 itself fully tested
  • support removal date indication, and likely “policies” which automate choosing default removal dates
  • 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for regret, version 0.12.0
Filename, size File type Python version Upload date Hashes
Filename, size regret-0.12.0-py2.py3-none-any.whl (8.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size regret-0.12.0.tar.gz (12.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page