/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com> and others
2
3
#
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
12
13
#
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
18
"""Symbol versioning
18
19
 
20
21
"""
21
22
 
22
23
__all__ = ['deprecated_function',
23
 
           'deprecated_in',
24
24
           'deprecated_list',
25
25
           'deprecated_method',
26
26
           'DEPRECATED_PARAMETER',
27
27
           'deprecated_passed',
28
 
           'set_warning_method',
29
 
           'warn',
 
28
           'warn', 'set_warning_method', 'zero_seven',
 
29
           'zero_eight',
 
30
           'zero_nine',
 
31
           'zero_ten',
 
32
           'zero_eleven',
 
33
           'zero_twelve',
 
34
           'zero_thirteen',
 
35
           'zero_fourteen',
 
36
           'zero_fifteen',
 
37
           'zero_sixteen',
30
38
           ]
31
39
 
32
 
 
33
 
import warnings
34
 
# Import the 'warn' symbol so breezy can call it even if we redefine it
35
40
from warnings import warn
36
41
 
37
 
import breezy
38
 
 
39
42
 
40
43
DEPRECATED_PARAMETER = "A deprecated parameter marker."
41
 
 
42
 
 
43
 
def deprecated_in(version_tuple):
44
 
    """Generate a message that something was deprecated in a release.
45
 
 
46
 
    >>> deprecated_in((1, 4, 0))
47
 
    '%s was deprecated in version 1.4.0.'
48
 
    """
49
 
    return ("%%s was deprecated in version %s."
50
 
            % breezy._format_version_tuple(version_tuple))
 
44
zero_seven = "%s was deprecated in version 0.7."
 
45
zero_eight = "%s was deprecated in version 0.8."
 
46
zero_nine = "%s was deprecated in version 0.9."
 
47
zero_ten = "%s was deprecated in version 0.10."
 
48
zero_eleven = "%s was deprecated in version 0.11."
 
49
zero_twelve = "%s was deprecated in version 0.12."
 
50
zero_thirteen = "%s was deprecated in version 0.13."
 
51
zero_fourteen = "%s was deprecated in version 0.14."
 
52
zero_fifteen = "%s was deprecated in version 0.15."
 
53
zero_sixteen = "%s was deprecated in version 0.16."
51
54
 
52
55
 
53
56
def set_warning_method(method):
69
72
    """Generate an automatic deprecation string for a_callable.
70
73
 
71
74
    :param a_callable: The callable to substitute into deprecation_version.
72
 
    :param deprecation_version: A deprecation format warning string. This
73
 
        should have a single %s operator in it. a_callable will be turned into
74
 
        a nice python symbol and then substituted into deprecation_version.
 
75
    :param deprecation_version: A deprecation format warning string. This should
 
76
        have a single %s operator in it. a_callable will be turned into a nice
 
77
        python symbol and then substituted into deprecation_version.
75
78
    """
76
 
    if getattr(a_callable, '__self__', None) is not None:
77
 
        symbol = "%s.%s.%s" % (a_callable.__self__.__class__.__module__,
78
 
                               a_callable.__self__.__class__.__name__,
79
 
                               a_callable.__name__)
80
 
    elif getattr(a_callable, '__qualname__', None) is not None and '<' not in a_callable.__qualname__:
81
 
        symbol = "%s.%s" % (a_callable.__module__,
82
 
                            a_callable.__qualname__)
83
 
    else:
 
79
    if getattr(a_callable, 'im_class', None) is None:
84
80
        symbol = "%s.%s" % (a_callable.__module__,
85
81
                            a_callable.__name__)
 
82
    else:
 
83
        symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
 
84
                               a_callable.im_class.__name__,
 
85
                               a_callable.__name__
 
86
                               )
86
87
    return deprecation_version % symbol
87
88
 
88
89
 
91
92
 
92
93
    def function_decorator(callable):
93
94
        """This is the function python calls to perform the decoration."""
94
 
 
 
95
        
95
96
        def decorated_function(*args, **kwargs):
96
97
            """This is the decorated function."""
97
 
            from . import trace
98
 
            trace.mutter_callsite(4, "Deprecated function called")
99
98
            warn(deprecation_string(callable, deprecation_version),
100
 
                 DeprecationWarning, stacklevel=2)
 
99
                DeprecationWarning, stacklevel=2)
101
100
            return callable(*args, **kwargs)
102
101
        _populate_decorated(callable, deprecation_version, "function",
103
102
                            decorated_function)
107
106
 
108
107
def deprecated_method(deprecation_version):
109
108
    """Decorate a method so that use of it will trigger a warning.
110
 
 
111
 
    To deprecate a static or class method, use
112
 
 
113
 
        @staticmethod
114
 
        @deprecated_function
115
 
        def ...
116
 
 
 
109
    
117
110
    To deprecate an entire class, decorate __init__.
118
111
    """
119
112
 
120
113
    def method_decorator(callable):
121
114
        """This is the function python calls to perform the decoration."""
122
 
 
 
115
        
123
116
        def decorated_method(self, *args, **kwargs):
124
117
            """This is the decorated method."""
125
 
            from . import trace
126
 
            if callable.__name__ == '__init__':
127
 
                symbol = "%s.%s" % (self.__class__.__module__,
128
 
                                    self.__class__.__name__,
129
 
                                    )
130
 
            else:
131
 
                symbol = "%s.%s.%s" % (self.__class__.__module__,
132
 
                                       self.__class__.__name__,
133
 
                                       callable.__name__
134
 
                                       )
135
 
            trace.mutter_callsite(4, "Deprecated method called")
136
 
            warn(deprecation_version %
137
 
                 symbol, DeprecationWarning, stacklevel=2)
 
118
            symbol = "%s.%s.%s" % (self.__class__.__module__,
 
119
                                   self.__class__.__name__,
 
120
                                   callable.__name__
 
121
                                   )
 
122
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
138
123
            return callable(self, *args, **kwargs)
139
124
        _populate_decorated(callable, deprecation_version, "method",
140
125
                            decorated_method)
144
129
 
145
130
def deprecated_passed(parameter_value):
146
131
    """Return True if parameter_value was used."""
147
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
132
    # FIXME: it might be nice to have a parameter deprecation decorator. 
148
133
    # it would need to handle positional and *args and **kwargs parameters,
149
134
    # which means some mechanism to describe how the parameter was being
150
135
    # passed before deprecation, and some way to deprecate parameters that
152
137
    # we cannot just forward to a new method name.I.e. in the following
153
138
    # examples we would want to have callers that pass any value to 'bad' be
154
139
    # given a warning - because we have applied:
155
 
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
 
140
    # @deprecated_parameter('bad', zero_seven)
156
141
    #
157
142
    # def __init__(self, bad=None)
158
143
    # def __init__(self, bad, other)
159
144
    # def __init__(self, **kwargs)
160
145
    # RBC 20060116
161
 
    return parameter_value is not DEPRECATED_PARAMETER
 
146
    return not parameter_value is DEPRECATED_PARAMETER
162
147
 
163
148
 
164
149
def _decorate_docstring(callable, deprecation_version, label,
170
155
    if len(docstring_lines) == 0:
171
156
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
172
157
    elif len(docstring_lines) == 1:
173
 
        decorated_callable.__doc__ = (
174
 
            callable.__doc__ + "\n" + "\n" +
175
 
            deprecation_version % ("This " + label) + "\n")
 
158
        decorated_callable.__doc__ = (callable.__doc__ 
 
159
                                    + "\n"
 
160
                                    + "\n"
 
161
                                    + deprecation_version % ("This " + label)
 
162
                                    + "\n")
176
163
    else:
177
164
        spaces = len(docstring_lines[-1])
178
165
        new_doc = callable.__doc__
211
198
    is_deprecated = True
212
199
 
213
200
    def __init__(self,
214
 
                 deprecation_version,
215
 
                 variable_name,
216
 
                 initial_value,
217
 
                 advice,
218
 
                 ):
 
201
        deprecation_version,
 
202
        variable_name,
 
203
        initial_value,
 
204
        advice,
 
205
        ):
219
206
        """Create a dict that warns when read or modified.
220
207
 
221
 
        :param deprecation_version: string for the warning format to raise,
222
 
            typically from deprecated_in()
 
208
        :param deprecation_version: something like zero_nine
223
209
        :param initial_value: The contents of the dict
224
210
        :param variable_name: This allows better warnings to be printed
225
 
        :param advice: String of advice on what callers should do instead
 
211
        :param advice: String of advice on what callers should do instead 
226
212
            of using this variable.
227
213
        """
228
214
        self._deprecation_version = deprecation_version
244
230
                    initial_value, extra=None):
245
231
    """Create a list that warns when modified
246
232
 
247
 
    :param deprecation_version: string for the warning format to raise,
248
 
        typically from deprecated_in()
 
233
    :param deprecation_version: something like zero_nine
249
234
    :param initial_value: The contents of the list
250
235
    :param variable_name: This allows better warnings to be printed
251
236
    :param extra: Extra info to print when printing a warning
264
249
        def _warn_deprecated(self, func, *args, **kwargs):
265
250
            warn(msg, DeprecationWarning, stacklevel=3)
266
251
            return func(self, *args, **kwargs)
267
 
 
 
252
            
268
253
        def append(self, obj):
269
254
            """appending to %s is deprecated""" % (variable_name,)
270
255
            return self._warn_deprecated(list.append, obj)
282
267
            return self._warn_deprecated(list.remove, value)
283
268
 
284
269
        def pop(self, index=None):
285
 
            """pop'ing from %s is deprecated""" % (variable_name,)
 
270
            """pop'ing from from %s is deprecated""" % (variable_name,)
286
271
            if index:
287
272
                return self._warn_deprecated(list.pop, index)
288
273
            else:
290
275
                return self._warn_deprecated(list.pop)
291
276
 
292
277
    return _DeprecatedList(initial_value)
293
 
 
294
 
 
295
 
def _check_for_filter(error_only):
296
 
    """Check if there is already a filter for deprecation warnings.
297
 
 
298
 
    :param error_only: Only match an 'error' filter
299
 
    :return: True if a filter is found, False otherwise
300
 
    """
301
 
    for filter in warnings.filters:
302
 
        if issubclass(DeprecationWarning, filter[2]):
303
 
            # This filter will effect DeprecationWarning
304
 
            if not error_only or filter[0] == 'error':
305
 
                return True
306
 
    return False
307
 
 
308
 
 
309
 
def _remove_filter_callable(filter):
310
 
    """Build and returns a callable removing filter from the warnings.
311
 
 
312
 
    :param filter: The filter to remove (can be None).
313
 
 
314
 
    :return: A callable that will remove filter from warnings.filters.
315
 
    """
316
 
    def cleanup():
317
 
        if filter:
318
 
            try:
319
 
                warnings.filters.remove(filter)
320
 
            except (ValueError, IndexError):
321
 
                pass
322
 
    return cleanup
323
 
 
324
 
 
325
 
def suppress_deprecation_warnings(override=True):
326
 
    """Call this function to suppress all deprecation warnings.
327
 
 
328
 
    When this is a final release version, we don't want to annoy users with
329
 
    lots of deprecation warnings. We only want the deprecation warnings when
330
 
    running a dev or release candidate.
331
 
 
332
 
    :param override: If True, always set the ignore, if False, only set the
333
 
        ignore if there isn't already a filter.
334
 
 
335
 
    :return: A callable to remove the new warnings this added.
336
 
    """
337
 
    if not override and _check_for_filter(error_only=False):
338
 
        # If there is already a filter effecting suppress_deprecation_warnings,
339
 
        # then skip it.
340
 
        filter = None
341
 
    else:
342
 
        warnings.filterwarnings('ignore', category=DeprecationWarning)
343
 
        filter = warnings.filters[0]
344
 
    return _remove_filter_callable(filter)
345
 
 
346
 
 
347
 
def activate_deprecation_warnings(override=True):
348
 
    """Call this function to activate deprecation warnings.
349
 
 
350
 
    When running in a 'final' release we suppress deprecation warnings.
351
 
    However, the test suite wants to see them. So when running selftest, we
352
 
    re-enable the deprecation warnings.
353
 
 
354
 
    Note: warnings that have already been issued under 'ignore' will not be
355
 
    reported after this point. The 'warnings' module has already marked them as
356
 
    handled, so they don't get issued again.
357
 
 
358
 
    :param override: If False, only add a filter if there isn't an error filter
359
 
        already. (This slightly differs from suppress_deprecation_warnings, in
360
 
        because it always overrides everything but -Werror).
361
 
 
362
 
    :return: A callable to remove the new warnings this added.
363
 
    """
364
 
    if not override and _check_for_filter(error_only=True):
365
 
        # DeprecationWarnings are already turned into errors, don't downgrade
366
 
        # them to 'default'.
367
 
        filter = None
368
 
    else:
369
 
        warnings.filterwarnings('default', category=DeprecationWarning)
370
 
        filter = warnings.filters[0]
371
 
    return _remove_filter_callable(filter)