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

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Julian from gravatar.com Julian

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

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

  • [ ] attributes

    • [ ] of modules

    • [ ] of classes

    • [ ] of instances

  • [ ] descriptors

    • [ ] classmethod

  • [ ] modules

  • [ ] parameters to callables

    • [x] previously required parameters that will be removed

    • [ ] optional parameters that are now required

    • [ ] deprecated values for parameters

    • [ ] type changes for parameters

    • [ ] mutual exclusion

  • [ ] interfaces

    • [ ] PEP 544 protocols

    • [ ] zope.interfaces

  • [x] inheritability of a class

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.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Julian from gravatar.com Julian

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

2024.2.2

2023.7.6

2023.7.5

2023.7.2

2023.7.1

2023.5.1

0.45.2

0.45.1

0.45.0

0.44.2

0.44.1

0.43.2

0.43.1

0.43.0

0.42.1

0.42.0

0.41.4

0.41.3

0.41.2

0.40.0

0.39.0

0.38.1

0.38.0

0.37.1

0.37.0

0.36.1

0.36.0

0.35.0

0.34.0

0.33.2

0.33.1

0.33.0

0.32.0

0.31.0

0.30.0

0.29.0

0.28.1

0.28.0

0.27.2

This version

0.27.1

0.27.0

0.26.1

0.26.0

0.25.0

0.24.5

0.24.4

0.24.3

0.24.2

0.24.1

0.24.0

0.23.2

0.23.1

0.23.0

0.22.1

0.22.0

0.21.2

0.21.1

0.21.0

0.20.5

0.20.4

0.20.3

0.20.2

0.20.1

0.20.0

0.19.1

0.19.0

0.18.1

0.18.0

0.17.2

0.17.1

0.17.0

0.16.1

0.16.0

0.15.0

0.14.3

0.14.2

0.14.1

0.14.0

0.13.1

0.13.0

0.12.0

0.11.0

0.10.1

0.10.0

0.9.0

0.8.0

0.7.0

0.6.0

0.5.0

0.4.0

0.3.1

0.3.0

0.2.0

0.1.0

Download files

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

Source Distribution

regret-0.27.1.tar.gz (23.2 kB view hashes)

Uploaded Source

Built Distribution

regret-0.27.1-py2.py3-none-any.whl (12.8 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page