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-1.1.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

deprecation-1.1-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for deprecation-1.1.tar.gz
Algorithm Hash digest
SHA256 8034ff1de464adc6558ec943cdac108fe661d3b58696f7b5821c678e4fe6106a
MD5 8422b56c6149aa6c078e393155557acc
BLAKE2b-256 6b1f9dab6885bc6599529ec2939dff809b1557c187aa418176720202e0cb3c82

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for deprecation-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6fd592ef85a1d9c49948dcbac28fb602a98eef92363cb33b6309e081cee0b9ae
MD5 f3adea728ca9e2c73ba524c3e4e41538
BLAKE2b-256 fbd76467843d50c78bf9b64aabe86c0fa6c40b53cbe4850bb27d08e0419927df

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