diff options
Diffstat (limited to 'netmodel/util/deprecated.py')
-rw-r--r-- | netmodel/util/deprecated.py | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/netmodel/util/deprecated.py b/netmodel/util/deprecated.py new file mode 100644 index 00000000..faa80ac2 --- /dev/null +++ b/netmodel/util/deprecated.py @@ -0,0 +1,35 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Copyright (c) 2017 Cisco and/or its affiliates. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import warnings +import functools + +def deprecated(func): + """This is a decorator which can be used to mark functions + as deprecated. It will result in a warning being emmitted + when the function is used.""" + + @functools.wraps(func) + def new_func(*args, **kwargs): + #warnings.simplefilter('always', DeprecationWarning) + warnings.warn("Call to deprecated function {}.".format(func.__name__),\ + category=DeprecationWarning, stacklevel=2) + #warnings.simplefilter('default', DeprecationWarning) + return func(*args, **kwargs) + + return new_func |