/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

Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
26
26
           'deprecated_method',
27
27
           'DEPRECATED_PARAMETER',
28
28
           'deprecated_passed',
29
 
           'warn', 'set_warning_method', 'zero_seven',
 
29
           'set_warning_method',
 
30
           'warn',
 
31
           'zero_seven',
30
32
           'zero_eight',
31
33
           'zero_nine',
32
34
           'zero_ten',
48
50
           'one_three',
49
51
           'one_four',
50
52
           'one_five',
 
53
           'one_six',
51
54
           ]
52
55
 
53
56
from warnings import warn
78
81
one_three = "%s was deprecated in version 1.3."
79
82
one_four = "%s was deprecated in version 1.4."
80
83
one_five = "%s was deprecated in version 1.5."
 
84
one_six = "%s was deprecated in version 1.6."
81
85
 
82
86
 
83
87
def deprecated_in(version_tuple):
89
93
    return ("%s was deprecated in version "
90
94
            + bzrlib._format_version_tuple(version_tuple))
91
95
 
 
96
 
92
97
def set_warning_method(method):
93
98
    """Set the warning method to be used by this module.
94
99
 
186
191
    # we cannot just forward to a new method name.I.e. in the following
187
192
    # examples we would want to have callers that pass any value to 'bad' be
188
193
    # given a warning - because we have applied:
189
 
    # @deprecated_parameter('bad', zero_seven)
 
194
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
190
195
    #
191
196
    # def __init__(self, bad=None)
192
197
    # def __init__(self, bad, other)
254
259
        ):
255
260
        """Create a dict that warns when read or modified.
256
261
 
257
 
        :param deprecation_version: something like zero_nine
 
262
        :param deprecation_version: string for the warning format to raise,
 
263
            typically from deprecated_in()
258
264
        :param initial_value: The contents of the dict
259
265
        :param variable_name: This allows better warnings to be printed
260
266
        :param advice: String of advice on what callers should do instead 
279
285
                    initial_value, extra=None):
280
286
    """Create a list that warns when modified
281
287
 
282
 
    :param deprecation_version: something like zero_nine
 
288
    :param deprecation_version: string for the warning format to raise,
 
289
        typically from deprecated_in()
283
290
    :param initial_value: The contents of the list
284
291
    :param variable_name: This allows better warnings to be printed
285
292
    :param extra: Extra info to print when printing a warning