← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Frank Aspell
  • Date: 2009-02-17 11:40:05 UTC
  • mto: (4054.1.1 doc)
  • mto: This revision was merged to the branch mainline in revision 4056.
  • Revision ID: frankaspell@googlemail.com-20090217114005-ojufrp6rqht664um
Fixed typos.

Fixed some typos in bzr doc's using "aspell -l en -c FILENAME".

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, 2008 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
 
27
28
           'deprecated_passed',
28
29
           'set_warning_method',
29
30
           'warn',
 
31
           'zero_seven',
 
32
           'zero_eight',
 
33
           'zero_nine',
 
34
           'zero_ten',
 
35
           'zero_eleven',
 
36
           'zero_twelve',
 
37
           'zero_thirteen',
 
38
           'zero_fourteen',
 
39
           'zero_fifteen',
 
40
           'zero_sixteen',
 
41
           'zero_seventeen',
 
42
           'zero_eighteen',
 
43
           'zero_ninety',
 
44
           'zero_ninetyone',
 
45
           'zero_ninetytwo',
 
46
           'zero_ninetythree',
 
47
           'one_zero',
 
48
           'one_one',
 
49
           'one_two',
 
50
           'one_three',
 
51
           'one_four',
 
52
           'one_five',
 
53
           'one_six',
30
54
           ]
31
55
 
32
 
 
33
 
import warnings
34
 
# Import the 'warn' symbol so bzrlib can call it even if we redefine it
35
56
from warnings import warn
36
57
 
37
58
import bzrlib
38
59
 
39
60
 
40
61
DEPRECATED_PARAMETER = "A deprecated parameter marker."
 
62
zero_seven = "%s was deprecated in version 0.7."
 
63
zero_eight = "%s was deprecated in version 0.8."
 
64
zero_nine = "%s was deprecated in version 0.9."
 
65
zero_ten = "%s was deprecated in version 0.10."
 
66
zero_eleven = "%s was deprecated in version 0.11."
 
67
zero_twelve = "%s was deprecated in version 0.12."
 
68
zero_thirteen = "%s was deprecated in version 0.13."
 
69
zero_fourteen = "%s was deprecated in version 0.14."
 
70
zero_fifteen = "%s was deprecated in version 0.15."
 
71
zero_sixteen = "%s was deprecated in version 0.16."
 
72
zero_seventeen = "%s was deprecated in version 0.17."
 
73
zero_eighteen = "%s was deprecated in version 0.18."
 
74
zero_ninety = "%s was deprecated in version 0.90."
 
75
zero_ninetyone = "%s was deprecated in version 0.91."
 
76
zero_ninetytwo = "%s was deprecated in version 0.92."
 
77
one_zero = "%s was deprecated in version 1.0."
 
78
zero_ninetythree = one_zero # Maintained for backwards compatibility
 
79
one_one = "%s was deprecated in version 1.1."
 
80
one_two = "%s was deprecated in version 1.2."
 
81
one_three = "%s was deprecated in version 1.3."
 
82
one_four = "%s was deprecated in version 1.4."
 
83
one_five = "%s was deprecated in version 1.5."
 
84
one_six = "%s was deprecated in version 1.6."
41
85
 
42
86
 
43
87
def deprecated_in(version_tuple):
44
88
    """Generate a message that something was deprecated in a release.
45
89
 
46
90
    >>> deprecated_in((1, 4, 0))
47
 
    '%s was deprecated in version 1.4.0.'
 
91
    '%s was deprecated in version 1.4.'
48
92
    """
49
93
    return ("%%s was deprecated in version %s."
50
94
            % bzrlib._format_version_tuple(version_tuple))
91
135
 
92
136
    def function_decorator(callable):
93
137
        """This is the function python calls to perform the decoration."""
94
 
 
 
138
        
95
139
        def decorated_function(*args, **kwargs):
96
140
            """This is the decorated function."""
97
141
            from bzrlib import trace
108
152
def deprecated_method(deprecation_version):
109
153
    """Decorate a method so that use of it will trigger a warning.
110
154
 
111
 
    To deprecate a static or class method, use
 
155
    To deprecate a static or class method, use 
112
156
 
113
157
        @staticmethod
114
158
        @deprecated_function
115
159
        def ...
116
 
 
 
160
    
117
161
    To deprecate an entire class, decorate __init__.
118
162
    """
119
163
 
120
164
    def method_decorator(callable):
121
165
        """This is the function python calls to perform the decoration."""
122
 
 
 
166
        
123
167
        def decorated_method(self, *args, **kwargs):
124
168
            """This is the decorated method."""
125
169
            from bzrlib import trace
143
187
 
144
188
def deprecated_passed(parameter_value):
145
189
    """Return True if parameter_value was used."""
146
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
190
    # FIXME: it might be nice to have a parameter deprecation decorator. 
147
191
    # it would need to handle positional and *args and **kwargs parameters,
148
192
    # which means some mechanism to describe how the parameter was being
149
193
    # passed before deprecation, and some way to deprecate parameters that
169
213
    if len(docstring_lines) == 0:
170
214
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
171
215
    elif len(docstring_lines) == 1:
172
 
        decorated_callable.__doc__ = (callable.__doc__
 
216
        decorated_callable.__doc__ = (callable.__doc__ 
173
217
                                    + "\n"
174
218
                                    + "\n"
175
219
                                    + deprecation_version % ("This " + label)
223
267
            typically from deprecated_in()
224
268
        :param initial_value: The contents of the dict
225
269
        :param variable_name: This allows better warnings to be printed
226
 
        :param advice: String of advice on what callers should do instead
 
270
        :param advice: String of advice on what callers should do instead 
227
271
            of using this variable.
228
272
        """
229
273
        self._deprecation_version = deprecation_version
265
309
        def _warn_deprecated(self, func, *args, **kwargs):
266
310
            warn(msg, DeprecationWarning, stacklevel=3)
267
311
            return func(self, *args, **kwargs)
268
 
 
 
312
            
269
313
        def append(self, obj):
270
314
            """appending to %s is deprecated""" % (variable_name,)
271
315
            return self._warn_deprecated(list.append, obj)
283
327
            return self._warn_deprecated(list.remove, value)
284
328
 
285
329
        def pop(self, index=None):
286
 
            """pop'ing from %s is deprecated""" % (variable_name,)
 
330
            """pop'ing from from %s is deprecated""" % (variable_name,)
287
331
            if index:
288
332
                return self._warn_deprecated(list.pop, index)
289
333
            else:
295
339
 
296
340
def _check_for_filter(error_only):
297
341
    """Check if there is already a filter for deprecation warnings.
298
 
 
 
342
    
299
343
    :param error_only: Only match an 'error' filter
300
344
    :return: True if a filter is found, False otherwise
301
345
    """
 
346
    import warnings
302
347
    for filter in warnings.filters:
303
348
        if issubclass(DeprecationWarning, filter[2]):
304
349
            # This filter will effect DeprecationWarning
307
352
    return False
308
353
 
309
354
 
310
 
def _remove_filter_callable(filter):
311
 
    """Build and returns a callable removing filter from the warnings.
312
 
 
313
 
    :param filter: The filter to remove (can be None).
314
 
 
315
 
    :return: A callable that will remove filter from warnings.filters.
316
 
    """
317
 
    def cleanup():
318
 
        if filter:
319
 
            warnings.filters.remove(filter)
320
 
    return cleanup
321
 
 
322
 
 
323
355
def suppress_deprecation_warnings(override=True):
324
356
    """Call this function to suppress all deprecation warnings.
325
357
 
329
361
 
330
362
    :param override: If True, always set the ignore, if False, only set the
331
363
        ignore if there isn't already a filter.
332
 
 
333
 
    :return: A callable to remove the new warnings this added.
334
364
    """
 
365
    import warnings
335
366
    if not override and _check_for_filter(error_only=False):
336
367
        # If there is already a filter effecting suppress_deprecation_warnings,
337
368
        # then skip it.
338
 
        filter = None
339
 
    else:
340
 
        warnings.filterwarnings('ignore', category=DeprecationWarning)
341
 
        filter = warnings.filters[0]
342
 
    return _remove_filter_callable(filter)
 
369
        return
 
370
    warnings.filterwarnings('ignore', category=DeprecationWarning)
343
371
 
344
372
 
345
373
def activate_deprecation_warnings(override=True):
356
384
    :param override: If False, only add a filter if there isn't an error filter
357
385
        already. (This slightly differs from suppress_deprecation_warnings, in
358
386
        because it always overrides everything but -Werror).
359
 
 
360
 
    :return: A callable to remove the new warnings this added.
361
387
    """
 
388
    import warnings
362
389
    if not override and _check_for_filter(error_only=True):
363
390
        # DeprecationWarnings are already turned into errors, don't downgrade
364
391
        # them to 'default'.
365
 
        filter = None
366
 
    else:
367
 
        warnings.filterwarnings('default', category=DeprecationWarning)
368
 
        filter = warnings.filters[0]
369
 
    return _remove_filter_callable(filter)
 
392
        return
 
393
    warnings.filterwarnings('default', category=DeprecationWarning)