python-Deprecated
Port variant v11
Summary Implements @deprecated decorator (3.11)
Package version 1.2.14
Homepage https://github.com/tantale/deprecated
Keywords python
Maintainer Python Automaton
License Not yet specified
Other variants v12
Ravenports Buildsheet | History
Ravensource Port Directory | History
Last modified 09 OCT 2023, 04:40:21 UTC
Port created 20 NOV 2021, 04:14:38 UTC
Subpackage Descriptions
single Deprecated Library ------------------ 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: .. code:: python 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: .. code:: bash $ 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: .. code:: python 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: .. code:: bash $ 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
Configuration Switches (platform-specific settings discarded)
PY311 ON Build using Python 3.11 PY312 OFF Build using Python 3.12
Package Dependencies by Type
Build (only) python-pip:single:v11
autoselect-python:single:standard
Build and Runtime python311:single:standard
Runtime (only) python-wrapt:single:v11
Download groups
main mirror://PYPIWHL/20/8d/778b7d51b981a96554f29136cd59ca7880bf58094338085bcf2a979a0e6a
Distribution File Information
6fac8b097794a90302bdbb17b9b815e732d3c4720583ff1b198499d78470466c 9561 Deprecated-1.2.14-py2.py3-none-any.whl
Ports that require python-Deprecated:v11
No other ports depend on this one.