Deprecated

Deprecated is Easy to Use

If you need to mark a function or a method as deprecated, you can use the @deprecated decorator:

Save in a hello.py:

from deprecated import deprecated


@deprecated(version='1.2.1', reason="You should use another function")
def some_old_function(x, y):
    return x + y


class SomeClass(object):
    @deprecated(version='1.3.0', reason="This method is deprecated")
    def some_old_method(self, x, y):
        return x + y


some_old_function(12, 34)
obj = SomeClass()
obj.some_old_method(5, 8)

And Easy to Setup

And run it:

$ pip install Deprecated
$ python hello.py
hello.py:15: DeprecationWarning: Call to deprecated function (or staticmethod) some_old_function.
(You should use another function) -- Deprecated since version 1.2.0.
  some_old_function(12, 34)
hello.py:17: DeprecationWarning: Call to deprecated method some_old_method.
(This method is deprecated) -- Deprecated since version 1.3.0.
  obj.some_old_method(5, 8)

You can document your code

Have you ever wonder how to document that some functions, classes, methods, etc. are deprecated? This is now possible with the integrated Sphinx directives:

For instance, in hello_sphinx.py:

from deprecated.sphinx import deprecated
from deprecated.sphinx import versionadded
from deprecated.sphinx import versionchanged


@versionadded(version='1.0', reason="This function is new")
def function_one():
    '''This is the function one'''


@versionchanged(version='1.0', reason="This function is modified")
def function_two():
    '''This is the function two'''


@deprecated(version='1.0', reason="This function will be removed soon")
def function_three():
    '''This is the function three'''


function_one()
function_two()
function_three()  # warns

help(function_one)
help(function_two)
help(function_three)

The result it immediate

Run it:

$ python hello_sphinx.py

hello_sphinx.py:23: DeprecationWarning: Call to deprecated function (or staticmethod) function_three.
(This function will be removed soon) -- Deprecated since version 1.0.
  function_three()  # warns

Help on function function_one in module __main__:

function_one()
    This is the function one

    .. versionadded:: 1.0
       This function is new

Help on function function_two in module __main__:

function_two()
    This is the function two

    .. versionchanged:: 1.0
       This function is modified

Help on function function_three in module __main__:

function_three()
    This is the function three

    .. deprecated:: 1.0
       This function will be removed soon

Metadata

Release files for Deprecated 1.2.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Deprecated 1.2.8
File	Size	Uploaded
Deprecated-1.2.8.tar.gz	5.3 MB	Apr 5, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for Deprecated 1.2.8
File	Interpreter	ABI	Platform	Reset
Deprecated-1.2.8-py2.py3-none-any.whl 8.6 kB Apr 5, 2020	Python 2, Python 3	none	any	Details

Total release size: 5.3 MB

Release files / Deprecated-1.2.8.tar.gz

Download URL	Deprecated-1.2.8.tar.gz
Size	5.3 MB
Tags	Source
SHA-256 checksum How to use checksums	`9caec5374c4b63e12d2ef8c9e01df1c55859db707b384d63f800aac7cbc93509`
BLAKE2b-256 checksum How to use checksums	`bf2bfcb50d3bfe50417bb8514086090f81b4f0099fbebf1db79ea061a5b04dd4`
Upload date	Apr 5, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.2`

Release files / Deprecated-1.2.8-py2.py3-none-any.whl

Download URL	Deprecated-1.2.8-py2.py3-none-any.whl
Size	8.6 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`cd98397157a1046784c9ff155730b745f46bb4dfd0175522c5bf348ab10037a5`
BLAKE2b-256 checksum How to use checksums	`46d1ac3a649a24542850e281cfefb9024ba4ba174157713015b6489a593806fe`
Upload date	Apr 5, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.2`