← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_symbol_versioning.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-01-13 05:14:24 UTC
  • mfrom: (3936.1.3 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090113051424-nrk3zkfe09h46i9y
(mbp) merge 1.11 and advance to 1.12

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_symbol_versioning.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com>
 
3
#   and others
2
4
#
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
12
14
#
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
"""Symbol versioning tests."""
18
20
 
19
21
import warnings
20
22
 
21
23
from bzrlib import symbol_versioning
22
 
from bzrlib.symbol_versioning import (
23
 
    deprecated_function,
24
 
    deprecated_in,
25
 
    deprecated_method,
26
 
    )
27
24
from bzrlib.tests import TestCase
28
25
 
29
26
 
30
 
@deprecated_function(deprecated_in((0, 7, 0)))
31
 
def sample_deprecated_function():
 
27
@symbol_versioning.deprecated_function(symbol_versioning.zero_seven)
 
28
def deprecated_function():
32
29
    """Deprecated function docstring."""
33
30
    return 1
34
31
 
35
32
 
36
 
a_deprecated_list = symbol_versioning.deprecated_list(deprecated_in((0, 9, 0)),
 
33
a_deprecated_list = symbol_versioning.deprecated_list(symbol_versioning.zero_nine,
37
34
    'a_deprecated_list', ['one'], extra="Don't use me")
38
35
 
39
36
 
40
37
a_deprecated_dict = symbol_versioning.DeprecatedDict(
41
 
    deprecated_in((0, 14, 0)),
 
38
    symbol_versioning.zero_fourteen,
42
39
    'a_deprecated_dict',
43
40
    dict(a=42),
44
41
    advice='Pull the other one!',
54
51
        super(TestDeprecationWarnings, self).setUp()
55
52
        self._warnings = []
56
53
    
57
 
    @deprecated_method(deprecated_in((0, 7, 0)))
 
54
    @symbol_versioning.deprecated_method(symbol_versioning.zero_seven)
58
55
    def deprecated_method(self):
59
56
        """Deprecated method docstring.
60
 
 
 
57
        
61
58
        This might explain stuff.
62
59
        """
63
60
        return 1
64
61
 
65
62
    @staticmethod
66
 
    @deprecated_function(deprecated_in((0, 7, 0)))
 
63
    @symbol_versioning.deprecated_function(symbol_versioning.zero_seven)
67
64
    def deprecated_static():
68
65
        """Deprecated static."""
69
66
        return 1
75
72
        expected_warning = (
76
73
            "bzrlib.tests.test_symbol_versioning."
77
74
            "deprecated_static "
78
 
            "was deprecated in version 0.7.0.", DeprecationWarning, 2)
 
75
            "was deprecated in version 0.7.", DeprecationWarning, 2)
79
76
        expected_docstring = (
80
77
            'Deprecated static.\n'
81
78
            '\n'
82
 
            'This function was deprecated in version 0.7.0.\n'
 
79
            'This function was deprecated in version 0.7.\n'
83
80
            )
84
81
        self.check_deprecated_callable(
85
82
            expected_warning, expected_docstring,
91
88
        expected_warning = (
92
89
            "bzrlib.tests.test_symbol_versioning."
93
90
            "TestDeprecationWarnings.deprecated_method "
94
 
            "was deprecated in version 0.7.0.", DeprecationWarning, 2)
95
 
        expected_docstring = (
96
 
            'Deprecated method docstring.\n'
97
 
            '\n'
98
 
            '        This might explain stuff.\n'
99
 
            '        \n'
100
 
            '        This method was deprecated in version 0.7.0.\n'
101
 
            '        ')
 
91
            "was deprecated in version 0.7.", DeprecationWarning, 2)
 
92
        expected_docstring = ('Deprecated method docstring.\n'
 
93
                              '        \n'
 
94
                              '        This might explain stuff.\n'
 
95
                              '        \n'
 
96
                              '        This method was deprecated in version 0.7.\n'
 
97
                              '        ')
102
98
        self.check_deprecated_callable(expected_warning, expected_docstring,
103
99
                                       "deprecated_method",
104
100
                                       "bzrlib.tests.test_symbol_versioning",
106
102
 
107
103
    def test_deprecated_function(self):
108
104
        expected_warning = (
109
 
            "bzrlib.tests.test_symbol_versioning.sample_deprecated_function "
110
 
            "was deprecated in version 0.7.0.", DeprecationWarning, 2)
 
105
            "bzrlib.tests.test_symbol_versioning.deprecated_function "
 
106
            "was deprecated in version 0.7.", DeprecationWarning, 2)
111
107
        expected_docstring = ('Deprecated function docstring.\n'
112
108
                              '\n'
113
 
                              'This function was deprecated in version 0.7.0.\n'
 
109
                              'This function was deprecated in version 0.7.\n'
114
110
                              )
115
111
        self.check_deprecated_callable(expected_warning, expected_docstring,
116
 
                                       "sample_deprecated_function",
 
112
                                       "deprecated_function",
117
113
                                       "bzrlib.tests.test_symbol_versioning",
118
 
                                       sample_deprecated_function)
 
114
                                       deprecated_function)
119
115
 
120
116
    def test_deprecated_list(self):
121
117
        expected_warning = (
122
 
            "Modifying a_deprecated_list was deprecated in version 0.9.0."
 
118
            "Modifying a_deprecated_list was deprecated in version 0.9."
123
119
            " Don't use me", DeprecationWarning, 3)
124
120
        old_warning_method = symbol_versioning.warn
125
121
        try:
157
153
 
158
154
    def test_deprecated_dict(self):
159
155
        expected_warning = (
160
 
            "access to a_deprecated_dict was deprecated in version 0.14.0."
 
156
            "access to a_deprecated_dict was deprecated in version 0.14."
161
157
            " Pull the other one!", DeprecationWarning, 2)
162
158
        old_warning_method = symbol_versioning.warn
163
159
        try:
178
174
    def check_deprecated_callable(self, expected_warning, expected_docstring,
179
175
                                  expected_name, expected_module,
180
176
                                  deprecated_callable):
181
 
        if __doc__ is None:
182
 
            # With -OO the docstring should just be the deprecated version
183
 
            expected_docstring = expected_docstring.split('\n')[-2].lstrip()
184
177
        old_warning_method = symbol_versioning.warn
185
178
        try:
186
179
            symbol_versioning.set_warning_method(self.capture_warning)
195
188
            self.assertTrue(deprecated_callable.is_deprecated)
196
189
        finally:
197
190
            symbol_versioning.set_warning_method(old_warning_method)
198
 
 
 
191
    
199
192
    def test_deprecated_passed(self):
200
193
        self.assertEqual(True, symbol_versioning.deprecated_passed(None))
201
194
        self.assertEqual(True, symbol_versioning.deprecated_passed(True))
208
201
        """We can get a deprecation string for a method or function."""
209
202
        self.assertEqual('bzrlib.tests.test_symbol_versioning.'
210
203
            'TestDeprecationWarnings.test_deprecation_string was deprecated in '
211
 
            'version 0.11.0.',
 
204
            'version 0.11.',
212
205
            symbol_versioning.deprecation_string(
213
 
            self.test_deprecation_string,
214
 
            deprecated_in((0, 11, 0))))
 
206
            self.test_deprecation_string, symbol_versioning.zero_eleven))
215
207
        self.assertEqual('bzrlib.symbol_versioning.deprecated_function was '
216
 
            'deprecated in version 0.11.0.',
 
208
            'deprecated in version 0.11.',
217
209
            symbol_versioning.deprecation_string(
218
210
                symbol_versioning.deprecated_function,
219
 
                deprecated_in((0, 11, 0))))
 
211
                symbol_versioning.zero_eleven))
220
212
 
221
213
 
222
214
class TestSuppressAndActivate(TestCase):
223
215
 
224
216
    def setUp(self):
225
 
        TestCase.setUp(self)
226
217
        existing_filters = list(warnings.filters)
227
218
        def restore():
228
219
            warnings.filters[:] = existing_filters
240
231
        symbol_versioning.suppress_deprecation_warnings()
241
232
        self.assertFirstWarning('ignore', DeprecationWarning)
242
233
 
243
 
    def test_set_restore_filters(self):
244
 
        original_filters = warnings.filters[:]
245
 
        symbol_versioning.suppress_deprecation_warnings()()
246
 
        self.assertEqual(original_filters, warnings.filters)
247
 
 
248
234
    def test_suppress_deprecation_with_warning_filter(self):
249
235
        """don't suppress if we already have a filter"""
250
236
        warnings.filterwarnings('error', category=Warning)