Skip to content
Snippets Groups Projects
Commit 172829d3 authored by Paul McCarthy's avatar Paul McCarthy :mountain_bicyclist:
Browse files

RF: Deprecated decorator allows removed in version to be specified

parent 621042eb
No related branches found
No related tags found
No related merge requests found
......@@ -21,19 +21,28 @@ has already been emitted for the use of a deprecated item.
"""
def deprecated(vin=None, msg=None):
def deprecated(vin=None, rin=None, msg=None):
"""Decorator to mark a function or method as deprecated. A
``DeprecationWarning`` is raised via the standard ``warnings`` module.
:arg vin: Optional version - the warning message will mention that the
function is deprecated from this version.
:arg rin: Optional version - the warning message will mention that the
function will be removed in this version.
:arg msg: Optional message to use in the warning.
"""
if vin is not None:
if vin is not None and rin is not None:
msgfmt = '{{name}} is deprecated from version {vin} and will be ' \
'removed in {rin}.'.format(vin=vin, rin=rin)
elif vin is not None:
msgfmt = '{{name}} is deprecated from version {vin}.'.format(vin=vin)
elif rin is not None:
msgfmt = '{{name}} is deprecated and will be removed in ' \
'{rin}.'.format(rin=rin)
else:
msgfmt = '{{name}} is deprecated.'
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment