3 | 
10 | 
11 | Module gedcom.helpers
21 | Helper methods.
24 |
25 |
81 | 26 | Expand source code 27 |
28 |# -*- coding: utf-8 -*-
29 |
30 | # Python GEDCOM Parser
31 | #
32 | # Copyright (C) 2018 Damon Brodie (damon.brodie at gmail.com)
33 | # Copyright (C) 2018-2019 Nicklas Reincke (contact at reynke.com)
34 | # Copyright (C) 2016 Andreas Oberritter
35 | # Copyright (C) 2012 Madeleine Price Ball
36 | # Copyright (C) 2005 Daniel Zappala (zappala at cs.byu.edu)
37 | # Copyright (C) 2005 Brigham Young University
38 | #
39 | # This program is free software; you can redistribute it and/or modify
40 | # it under the terms of the GNU General Public License as published by
41 | # the Free Software Foundation; either version 2 of the License, or
42 | # (at your option) any later version.
43 | #
44 | # This program is distributed in the hope that it will be useful,
45 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
46 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
47 | # GNU General Public License for more details.
48 | #
49 | # You should have received a copy of the GNU General Public License along
50 | # with this program; if not, write to the Free Software Foundation, Inc.,
51 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
52 | #
53 | # Further information about the license: http://www.gnu.org/licenses/gpl-2.0.html
54 |
55 | """
56 | Helper methods.
57 | """
58 |
59 | import warnings
60 | import functools
61 |
62 |
63 | def deprecated(func):
64 | """This is a decorator which can be used to mark functions
65 | as deprecated. It will result in a warning being emitted
66 | when the function is used.
67 | """
68 | @functools.wraps(func)
69 | def new_func(*args, **kwargs):
70 |
71 | warnings.simplefilter('always', DeprecationWarning) # turn off filter
72 | warnings.warn("Call to deprecated function {}.".format(func.__name__),
73 | category=DeprecationWarning,
74 | stacklevel=2)
75 | warnings.simplefilter('default', DeprecationWarning) # reset filter
76 |
77 | return func(*args, **kwargs)
78 |
79 | return new_funcFunctions
88 |-
89 |
90 | def deprecated(func) 91 |
92 | -
93 |
This is a decorator which can be used to mark functions 94 | as deprecated. It will result in a warning being emitted 95 | when the function is used.
97 |118 |98 | Expand source code 99 |
100 |
117 |def deprecated(func): 101 | """This is a decorator which can be used to mark functions 102 | as deprecated. It will result in a warning being emitted 103 | when the function is used. 104 | """ 105 | @functools.wraps(func) 106 | def new_func(*args, **kwargs): 107 | 108 | warnings.simplefilter('always', DeprecationWarning) # turn off filter 109 | warnings.warn("Call to deprecated function {}.".format(func.__name__), 110 | category=DeprecationWarning, 111 | stacklevel=2) 112 | warnings.simplefilter('default', DeprecationWarning) # reset filter 113 | 114 | return func(*args, **kwargs) 115 | 116 | return new_func
119 |