/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: Martin Pool
  • Date: 2008-05-08 04:33:38 UTC
  • mfrom: (3414 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3415.
  • Revision ID: mbp@sourcefrog.net-20080508043338-ru3vflx8z641a76k
Merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
21
21
"""
22
22
 
23
23
__all__ = ['deprecated_function',
 
24
           'deprecated_in',
24
25
           'deprecated_list',
25
26
           'deprecated_method',
26
27
           'DEPRECATED_PARAMETER',
27
28
           'deprecated_passed',
28
 
           'warn', 'set_warning_method', 'zero_seven',
 
29
           'set_warning_method',
 
30
           'warn',
 
31
           'zero_seven',
29
32
           'zero_eight',
30
33
           'zero_nine',
31
34
           'zero_ten',
46
49
           'one_two',
47
50
           'one_three',
48
51
           'one_four',
 
52
           'one_five',
49
53
           ]
50
54
 
51
55
from warnings import warn
52
56
 
 
57
import bzrlib
 
58
 
53
59
 
54
60
DEPRECATED_PARAMETER = "A deprecated parameter marker."
55
61
zero_seven = "%s was deprecated in version 0.7."
73
79
one_two = "%s was deprecated in version 1.2."
74
80
one_three = "%s was deprecated in version 1.3."
75
81
one_four = "%s was deprecated in version 1.4."
 
82
one_five = "%s was deprecated in version 1.5."
 
83
 
 
84
 
 
85
def deprecated_in(version_tuple):
 
86
    """Generate a message that something was deprecated in a release.
 
87
 
 
88
    >>> deprecated_in((1, 4, 0))
 
89
    '%s was deprecated in version 1.4'
 
90
    """
 
91
    return ("%s was deprecated in version "
 
92
            + bzrlib._format_version_tuple(version_tuple))
76
93
 
77
94
def set_warning_method(method):
78
95
    """Set the warning method to be used by this module.
171
188
    # we cannot just forward to a new method name.I.e. in the following
172
189
    # examples we would want to have callers that pass any value to 'bad' be
173
190
    # given a warning - because we have applied:
174
 
    # @deprecated_parameter('bad', zero_seven)
 
191
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
175
192
    #
176
193
    # def __init__(self, bad=None)
177
194
    # def __init__(self, bad, other)
239
256
        ):
240
257
        """Create a dict that warns when read or modified.
241
258
 
242
 
        :param deprecation_version: something like zero_nine
 
259
        :param deprecation_version: string for the warning format to raise,
 
260
            typically from deprecated_in()
243
261
        :param initial_value: The contents of the dict
244
262
        :param variable_name: This allows better warnings to be printed
245
263
        :param advice: String of advice on what callers should do instead 
264
282
                    initial_value, extra=None):
265
283
    """Create a list that warns when modified
266
284
 
267
 
    :param deprecation_version: something like zero_nine
 
285
    :param deprecation_version: string for the warning format to raise,
 
286
        typically from deprecated_in()
268
287
    :param initial_value: The contents of the list
269
288
    :param variable_name: This allows better warnings to be printed
270
289
    :param extra: Extra info to print when printing a warning