src/pyams_utils/decorator.py
changeset 380 c062ab4db6cd
parent 292 b338586588ad
child 408 cf2304af0fab
equal deleted inserted replaced
379:07fe5bb08599 380:c062ab4db6cd
     8 # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     8 # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     9 # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
     9 # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
    10 # FOR A PARTICULAR PURPOSE.
    10 # FOR A PARTICULAR PURPOSE.
    11 #
    11 #
    12 
    12 
       
    13 """PyAMS_utils.decorator module
       
    14 
       
    15 This module only provides a single decorator, which can be used to mark a function as
       
    16 deprecated.
       
    17 """
       
    18 
    13 __docformat__ = 'restructuredtext'
    19 __docformat__ = 'restructuredtext'
    14 
    20 
    15 
       
    16 # import standard library
       
    17 import functools
    21 import functools
    18 import warnings
    22 import warnings
    19 
       
    20 # import interfaces
       
    21 
       
    22 # import packages
       
    23 
    23 
    24 
    24 
    25 def deprecated(*msg):
    25 def deprecated(*msg):
    26     """This is a decorator which can be used to mark functions as deprecated.
    26     """This is a decorator which can be used to mark functions as deprecated.
    27 
    27