Skip to main content

A library to handle automated deprecations

Project description

deprecation

Documentation Status https://travis-ci.org/briancurtin/deprecation.svg?branch=master https://codecov.io/gh/briancurtin/deprecation/branch/master/graph/badge.svg

The deprecation library provides a deprecated decorator and a fail_if_not_removed decorator for your tests. Together, the two enable the automation of several things:

  1. The docstring of a deprecated method gets the deprecation details appended to the end of it. If you generate your API docs direct from your source, you don’t need to worry about writing your own notification. You also don’t need to worry about forgetting to write it. It’s done for you.

  2. Rather than having code live on forever because you only deprecated it but never actually moved on from it, you can have your tests tell you when it’s time to remove the code. The @deprecated decorator can be told when it’s time to entirely remove the code, which causes @fail_if_not_removed to raise an AssertionError, causing either your unittest or py.test tests to fail.

See http://deprecation.readthedocs.io/ for the full documentation.

Installation

pip install deprecation

Usage

import deprecation

@deprecation.deprecated(deprecated_in="1.0", removed_in="2.0",
                        current_version=__version__,
                        details="Use the bar function instead")
def foo():
    """Do some stuff"""
    return 1

…but doesn’t Python ignore DeprecationWarning?

Yes, by default since 2.7—and for good reason [1] —and this works fine with that.

  1. It often makes sense for you to run your tests with a -W flag or the PYTHONWARNINGS environment variable so you catch warnings in development and handle them appropriately. The warnings raised by this library show up there, as they’re subclasses of the built-in DeprecationWarning. See the Command Line and Environment Variable documentation for more details.

  2. Even if you don’t enable those things, the behavior of this library remains the same. The docstrings will still be updated and the tests will still fail when they need to. You’ll get the benefits regardless of what Python cares about DeprecationWarning.


Project details


Download files

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

Source Distribution

deprecation-2.0.1.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

deprecation-2.0.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file deprecation-2.0.1.tar.gz.

File metadata

  • Download URL: deprecation-2.0.1.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for deprecation-2.0.1.tar.gz
Algorithm Hash digest
SHA256 72111aae0aa4b3706553e83f37111a10a5c83e68649f1d8796db4c894130ba36
MD5 96dea27894584edc601d39e62e82c1c9
BLAKE2b-256 2a2df0ed436a4027c80e919869e9fa6aca164d7cc0d2e98a4a493f03498f477a

See more details on using hashes here.

File details

Details for the file deprecation-2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for deprecation-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bd68dcbe067fece343520c7eb78b4c333304b081472c56cc191b8ad926d1361d
MD5 90d1f1ec10f7f64ae8d21c0bb2f902bd
BLAKE2b-256 bcefb3d75763320122b8b965ece1316d5aab77b099c4d000b512dedc439cfa4f

See more details on using hashes here.

Supported by

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