/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 breezy/symbol_versioning.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/symbol_versioning.py
 
1
# Copyright (C) 2006-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# 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
 
 
17
"""Symbol versioning
 
18
 
 
19
The methods here allow for api symbol versioning.
 
20
"""
 
21
 
 
22
__all__ = ['deprecated_function',
 
23
           'deprecated_in',
 
24
           'deprecated_list',
 
25
           'deprecated_method',
 
26
           'DEPRECATED_PARAMETER',
 
27
           'deprecated_passed',
 
28
           'set_warning_method',
 
29
           'warn',
 
30
           ]
 
31
 
 
32
 
 
33
import warnings
 
34
# Import the 'warn' symbol so breezy can call it even if we redefine it
 
35
from warnings import warn
 
36
 
 
37
import breezy
 
38
 
 
39
 
 
40
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))
 
51
 
 
52
 
 
53
def set_warning_method(method):
 
54
    """Set the warning method to be used by this module.
 
55
 
 
56
    It should take a message and a warning category as warnings.warn does.
 
57
    """
 
58
    global warn
 
59
    warn = method
 
60
 
 
61
 
 
62
# TODO - maybe this would be easier to use as one 'smart' method that
 
63
# guess if it is a method or a class or an attribute ? If so, we can
 
64
# add that on top of the primitives, once we have all three written
 
65
# - RBC 20050105
 
66
 
 
67
 
 
68
def deprecation_string(a_callable, deprecation_version):
 
69
    """Generate an automatic deprecation string for a_callable.
 
70
 
 
71
    :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
    """
 
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:
 
84
        symbol = "%s.%s" % (a_callable.__module__,
 
85
                            a_callable.__name__)
 
86
    return deprecation_version % symbol
 
87
 
 
88
 
 
89
def deprecated_function(deprecation_version):
 
90
    """Decorate a function so that use of it will trigger a warning."""
 
91
 
 
92
    def function_decorator(callable):
 
93
        """This is the function python calls to perform the decoration."""
 
94
 
 
95
        def decorated_function(*args, **kwargs):
 
96
            """This is the decorated function."""
 
97
            from . import trace
 
98
            trace.mutter_callsite(4, "Deprecated function called")
 
99
            warn(deprecation_string(callable, deprecation_version),
 
100
                 DeprecationWarning, stacklevel=2)
 
101
            return callable(*args, **kwargs)
 
102
        _populate_decorated(callable, deprecation_version, "function",
 
103
                            decorated_function)
 
104
        return decorated_function
 
105
    return function_decorator
 
106
 
 
107
 
 
108
def deprecated_method(deprecation_version):
 
109
    """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
 
 
117
    To deprecate an entire class, decorate __init__.
 
118
    """
 
119
 
 
120
    def method_decorator(callable):
 
121
        """This is the function python calls to perform the decoration."""
 
122
 
 
123
        def decorated_method(self, *args, **kwargs):
 
124
            """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)
 
138
            return callable(self, *args, **kwargs)
 
139
        _populate_decorated(callable, deprecation_version, "method",
 
140
                            decorated_method)
 
141
        return decorated_method
 
142
    return method_decorator
 
143
 
 
144
 
 
145
def deprecated_passed(parameter_value):
 
146
    """Return True if parameter_value was used."""
 
147
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
148
    # it would need to handle positional and *args and **kwargs parameters,
 
149
    # which means some mechanism to describe how the parameter was being
 
150
    # passed before deprecation, and some way to deprecate parameters that
 
151
    # were not at the end of the arg list. Thats needed for __init__ where
 
152
    # we cannot just forward to a new method name.I.e. in the following
 
153
    # examples we would want to have callers that pass any value to 'bad' be
 
154
    # given a warning - because we have applied:
 
155
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
 
156
    #
 
157
    # def __init__(self, bad=None)
 
158
    # def __init__(self, bad, other)
 
159
    # def __init__(self, **kwargs)
 
160
    # RBC 20060116
 
161
    return parameter_value is not DEPRECATED_PARAMETER
 
162
 
 
163
 
 
164
def _decorate_docstring(callable, deprecation_version, label,
 
165
                        decorated_callable):
 
166
    if callable.__doc__:
 
167
        docstring_lines = callable.__doc__.split('\n')
 
168
    else:
 
169
        docstring_lines = []
 
170
    if len(docstring_lines) == 0:
 
171
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
 
172
    elif len(docstring_lines) == 1:
 
173
        decorated_callable.__doc__ = (
 
174
            callable.__doc__ + "\n" + "\n" +
 
175
            deprecation_version % ("This " + label) + "\n")
 
176
    else:
 
177
        spaces = len(docstring_lines[-1])
 
178
        new_doc = callable.__doc__
 
179
        new_doc += "\n" + " " * spaces
 
180
        new_doc += deprecation_version % ("This " + label)
 
181
        new_doc += "\n" + " " * spaces
 
182
        decorated_callable.__doc__ = new_doc
 
183
 
 
184
 
 
185
def _populate_decorated(callable, deprecation_version, label,
 
186
                        decorated_callable):
 
187
    """Populate attributes like __name__ and __doc__ on the decorated callable.
 
188
    """
 
189
    _decorate_docstring(callable, deprecation_version, label,
 
190
                        decorated_callable)
 
191
    decorated_callable.__module__ = callable.__module__
 
192
    decorated_callable.__name__ = callable.__name__
 
193
    decorated_callable.is_deprecated = True
 
194
 
 
195
 
 
196
def _dict_deprecation_wrapper(wrapped_method):
 
197
    """Returns a closure that emits a warning and calls the superclass"""
 
198
    def cb(dep_dict, *args, **kwargs):
 
199
        msg = 'access to %s' % (dep_dict._variable_name, )
 
200
        msg = dep_dict._deprecation_version % (msg,)
 
201
        if dep_dict._advice:
 
202
            msg += ' ' + dep_dict._advice
 
203
        warn(msg, DeprecationWarning, stacklevel=2)
 
204
        return wrapped_method(dep_dict, *args, **kwargs)
 
205
    return cb
 
206
 
 
207
 
 
208
class DeprecatedDict(dict):
 
209
    """A dictionary that complains when read or written."""
 
210
 
 
211
    is_deprecated = True
 
212
 
 
213
    def __init__(self,
 
214
                 deprecation_version,
 
215
                 variable_name,
 
216
                 initial_value,
 
217
                 advice,
 
218
                 ):
 
219
        """Create a dict that warns when read or modified.
 
220
 
 
221
        :param deprecation_version: string for the warning format to raise,
 
222
            typically from deprecated_in()
 
223
        :param initial_value: The contents of the dict
 
224
        :param variable_name: This allows better warnings to be printed
 
225
        :param advice: String of advice on what callers should do instead
 
226
            of using this variable.
 
227
        """
 
228
        self._deprecation_version = deprecation_version
 
229
        self._variable_name = variable_name
 
230
        self._advice = advice
 
231
        dict.__init__(self, initial_value)
 
232
 
 
233
    # This isn't every possible method but it should trap anyone using the
 
234
    # dict -- add more if desired
 
235
    __len__ = _dict_deprecation_wrapper(dict.__len__)
 
236
    __getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
 
237
    __setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
 
238
    __delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
 
239
    keys = _dict_deprecation_wrapper(dict.keys)
 
240
    __contains__ = _dict_deprecation_wrapper(dict.__contains__)
 
241
 
 
242
 
 
243
def deprecated_list(deprecation_version, variable_name,
 
244
                    initial_value, extra=None):
 
245
    """Create a list that warns when modified
 
246
 
 
247
    :param deprecation_version: string for the warning format to raise,
 
248
        typically from deprecated_in()
 
249
    :param initial_value: The contents of the list
 
250
    :param variable_name: This allows better warnings to be printed
 
251
    :param extra: Extra info to print when printing a warning
 
252
    """
 
253
 
 
254
    subst_text = 'Modifying %s' % (variable_name,)
 
255
    msg = deprecation_version % (subst_text,)
 
256
    if extra:
 
257
        msg += ' ' + extra
 
258
 
 
259
    class _DeprecatedList(list):
 
260
        __doc__ = list.__doc__ + msg
 
261
 
 
262
        is_deprecated = True
 
263
 
 
264
        def _warn_deprecated(self, func, *args, **kwargs):
 
265
            warn(msg, DeprecationWarning, stacklevel=3)
 
266
            return func(self, *args, **kwargs)
 
267
 
 
268
        def append(self, obj):
 
269
            """appending to %s is deprecated""" % (variable_name,)
 
270
            return self._warn_deprecated(list.append, obj)
 
271
 
 
272
        def insert(self, index, obj):
 
273
            """inserting to %s is deprecated""" % (variable_name,)
 
274
            return self._warn_deprecated(list.insert, index, obj)
 
275
 
 
276
        def extend(self, iterable):
 
277
            """extending %s is deprecated""" % (variable_name,)
 
278
            return self._warn_deprecated(list.extend, iterable)
 
279
 
 
280
        def remove(self, value):
 
281
            """removing from %s is deprecated""" % (variable_name,)
 
282
            return self._warn_deprecated(list.remove, value)
 
283
 
 
284
        def pop(self, index=None):
 
285
            """pop'ing from %s is deprecated""" % (variable_name,)
 
286
            if index:
 
287
                return self._warn_deprecated(list.pop, index)
 
288
            else:
 
289
                # Can't pass None
 
290
                return self._warn_deprecated(list.pop)
 
291
 
 
292
    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)