Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
F
fslpy
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Analyze
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
FSL
fslpy
Commits
172829d3
Commit
172829d3
authored
6 years ago
by
Paul McCarthy
Browse files
Options
Downloads
Patches
Plain Diff
RF: Deprecated decorator allows removed in version to be specified
parent
621042eb
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
fsl/utils/deprecated.py
+11
-2
11 additions, 2 deletions
fsl/utils/deprecated.py
with
11 additions
and
2 deletions
fsl/utils/deprecated.py
+
11
−
2
View file @
172829d3
...
@@ -21,19 +21,28 @@ has already been emitted for the use of a deprecated item.
...
@@ -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
"""
Decorator to mark a function or method as deprecated. A
``DeprecationWarning`` is raised via the standard ``warnings`` module.
``DeprecationWarning`` is raised via the standard ``warnings`` module.
:arg vin: Optional version - the warning message will mention that the
:arg vin: Optional version - the warning message will mention that the
function is deprecated from this version.
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.
: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
)
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
:
else
:
msgfmt
=
'
{{name}} is deprecated.
'
msgfmt
=
'
{{name}} is deprecated.
'
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment