1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
from time import sleep
from unittest.mock import Mock, call
import pytest
import logbook
from logbook.utils import (
deprecated,
forget_deprecation_locations,
log_deprecation_message,
logged_if_slow,
suppressed_deprecations,
)
_THRESHOLD = 0.1
@pytest.mark.flaky(reruns=5)
def test_logged_if_slow_reached(test_handler):
with test_handler.applicationbound():
with logged_if_slow("checking...", threshold=_THRESHOLD):
sleep(2 * _THRESHOLD)
assert len(test_handler.records) == 1
[record] = test_handler.records
assert record.message == "checking..."
@pytest.mark.flaky(reruns=5)
def test_logged_if_slow_did_not_reached(test_handler):
with test_handler.applicationbound():
with logged_if_slow("checking...", threshold=_THRESHOLD):
sleep(_THRESHOLD / 2)
assert len(test_handler.records) == 0
@pytest.mark.flaky(reruns=5)
def test_logged_if_slow_logger():
logger = Mock()
with logged_if_slow("checking...", threshold=_THRESHOLD, logger=logger):
sleep(2 * _THRESHOLD)
assert logger.log.call_args == call(logbook.DEBUG, "checking...")
@pytest.mark.flaky(reruns=5)
def test_logged_if_slow_level(test_handler):
with test_handler.applicationbound():
with logged_if_slow("checking...", threshold=_THRESHOLD, level=logbook.WARNING):
sleep(2 * _THRESHOLD)
assert test_handler.records[0].level == logbook.WARNING
@pytest.mark.flaky(reruns=5)
def test_logged_if_slow_deprecated(logger, test_handler):
with test_handler.applicationbound():
with logged_if_slow("checking...", threshold=_THRESHOLD, func=logbook.error):
sleep(2 * _THRESHOLD)
assert test_handler.records[0].level == logbook.ERROR
assert test_handler.records[0].message == "checking..."
with pytest.raises(TypeError):
logged_if_slow("checking...", logger=logger, func=logger.error)
def test_deprecated_func_called(capture):
assert deprecated_func(1, 2) == 3
def test_deprecation_message(capture):
deprecated_func(1, 2)
[record] = capture.records
assert "deprecated" in record.message
assert "deprecated_func" in record.message
def test_deprecation_with_message(capture):
@deprecated("use something else instead")
def func(a, b):
return a + b
func(1, 2)
[record] = capture.records
assert "use something else instead" in record.message
assert "func is deprecated" in record.message
def test_no_deprecations(capture):
@deprecated("msg")
def func(a, b):
return a + b
with suppressed_deprecations():
assert func(1, 2) == 3
assert not capture.records
def _no_decorator(func):
return func
@pytest.mark.parametrize("decorator", [_no_decorator, classmethod])
def test_class_deprecation(capture, decorator):
class Bla:
@deprecated("reason")
@classmethod
def func(self, a, b):
assert isinstance(self, Bla)
return a + b
assert Bla().func(2, 4) == 6
[record] = capture.records
assert "Bla.func is deprecated" in record.message
def test_deprecations_different_sources(capture):
def f():
deprecated_func(1, 2)
def g():
deprecated_func(1, 2)
f()
g()
assert len(capture.records) == 2
def test_deprecations_same_sources(capture):
def f():
deprecated_func(1, 2)
f()
f()
assert len(capture.records) == 1
def test_deprecation_message_different_sources(capture):
def f(flag):
if flag:
log_deprecation_message("first message type")
else:
log_deprecation_message("second message type")
f(True)
f(False)
assert len(capture.records) == 2
def test_deprecation_message_same_sources(capture):
def f(flag):
if flag:
log_deprecation_message("first message type")
else:
log_deprecation_message("second message type")
f(True)
f(True)
assert len(capture.records) == 1
def test_deprecation_message_full_warning(capture):
def f():
log_deprecation_message("some_message")
f()
[record] = capture.records
assert record.message == "Deprecation message: some_message"
def test_name_doc():
@deprecated
def some_func():
"""docstring here"""
pass
assert some_func.__name__ == "some_func"
assert "docstring here" in some_func.__doc__
def test_doc_update():
@deprecated("some_message")
def some_func():
"""docstring here"""
pass
some_func.__doc__ = "new_docstring"
assert "docstring here" not in some_func.__doc__
assert "new_docstring" in some_func.__doc__
assert "some_message" in some_func.__doc__
def test_deprecatd_docstring():
message = "Use something else instead"
@deprecated()
def some_func():
"""This is a function"""
@deprecated(message)
def other_func():
"""This is another function"""
assert ".. deprecated" in some_func.__doc__
assert f".. deprecated\n {message}" in other_func.__doc__
@pytest.fixture
def capture(request):
handler = logbook.TestHandler(level=logbook.WARNING)
handler.push_application()
@request.addfinalizer
def pop():
handler.pop_application()
return handler
@deprecated
def deprecated_func(a, b):
return a + b
@pytest.fixture(autouse=True)
def forget_locations():
forget_deprecation_locations()
|
