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
|
# stdlib
import datetime
# 3rd party
import pytest
from deprecation import UnsupportedWarning # type: ignore
# this package
from deprecation_alias import deprecated
def test_deprecation():
def func(*args, **kwargs):
"""
A normal function.
"""
return args, kwargs
@deprecated(deprecated_in='1', removed_in='3', current_version='2', details="use 'bar' instead.")
def deprecated_func(*args, **kwargs):
"""
A deprecated function.
"""
return args, kwargs
deprecated_alias = deprecated(
deprecated_in='1',
removed_in='3',
current_version='2',
details="use 'bar' instead.",
name="deprecated_alias",
)(func) # yapf: disable
with pytest.warns(DeprecationWarning) as record:
assert deprecated_func(1, a_list=['a', 'b']) == ((1, ), {"a_list": ['a', 'b']})
assert deprecated_alias(1, a_list=['a', 'b']) == ((1, ), {"a_list": ['a', 'b']})
assert len(record) == 2
assert record[0].message.args == ( # type: ignore
"deprecated_func", '1', '3', "use 'bar' instead."
)
assert record[1].message.args == ( # type: ignore
"deprecated_alias", '1', '3', "use 'bar' instead."
)
assert ".. deprecated::" in deprecated_func.__doc__
assert ".. deprecated::" in deprecated_alias.__doc__
assert ".. deprecated::" not in func.__doc__ # type: ignore
def test_unsupported():
def func(*args, **kwargs):
"""
A normal function.
"""
return args, kwargs
@deprecated(deprecated_in='1', removed_in='3', current_version='5', details="use 'bar' instead.")
def deprecated_func(*args, **kwargs):
"""
A deprecated function.
"""
return args, kwargs
deprecated_alias = deprecated(
deprecated_in='1',
removed_in='3',
current_version='5',
details="use 'bar' instead.",
name="deprecated_alias",
)(func) # yapf: disable
with pytest.warns(UnsupportedWarning) as record:
assert deprecated_func(1, a_list=['a', 'b']) == ((1, ), {"a_list": ['a', 'b']})
assert deprecated_alias(1, a_list=['a', 'b']) == ((1, ), {"a_list": ['a', 'b']})
assert len(record) == 2
assert record[0].message.args == ( # type: ignore
"deprecated_func", '1', '3', "use 'bar' instead."
)
assert record[1].message.args == ( # type: ignore
"deprecated_alias", '1', '3', "use 'bar' instead."
)
assert ".. deprecated::" in deprecated_func.__doc__
assert ".. deprecated::" in deprecated_alias.__doc__
assert ".. deprecated::" not in func.__doc__ # type: ignore
def test_deprecation_dates(fixed_datetime: datetime.datetime):
def func(*args, **kwargs):
"""
A normal function.
"""
return args, kwargs
@deprecated(
deprecated_in='1',
removed_in=datetime.date(2021, 1, 1),
details="use 'bar' instead.",
)
def deprecated_func(*args, **kwargs):
"""
A deprecated function.
"""
return args, kwargs
deprecated_alias = deprecated(
deprecated_in='1',
removed_in=datetime.date(2021, 1, 1),
details="use 'bar' instead.",
name="deprecated_alias",
)(func) # yapf: disable
with pytest.warns(DeprecationWarning) as record:
assert deprecated_func(1, a_list=['a', 'b']) == ((1, ), {"a_list": ['a', 'b']})
assert deprecated_alias(1, a_list=['a', 'b']) == ((1, ), {"a_list": ['a', 'b']})
assert len(record) == 2
assert record[0].message.args == ( # type: ignore
"deprecated_func", '1', datetime.date(2021, 1, 1), "use 'bar' instead."
)
assert record[1].message.args == ( # type: ignore
"deprecated_alias", '1', datetime.date(2021, 1, 1), "use 'bar' instead."
)
assert ".. deprecated::" in deprecated_func.__doc__
assert ".. deprecated::" in deprecated_alias.__doc__
assert ".. deprecated::" not in func.__doc__ # type: ignore
def test_deprecation_as_function():
def func(*args, **kwargs):
"""
A normal function.
"""
return args, kwargs
deprecated_func = deprecated(
deprecated_in='1',
removed_in='3',
current_version='2',
details="use 'bar' instead.",
func=func,
)
deprecated_alias = deprecated(
deprecated_in='1',
removed_in='3',
current_version='2',
details="use 'bar' instead.",
func=func,
name="deprecated_alias",
)
with pytest.warns(DeprecationWarning) as record:
assert deprecated_func(1, a_list=['a', 'b']) == ((1, ), {"a_list": ['a', 'b']})
assert deprecated_alias(1, a_list=['a', 'b']) == ((1, ), {"a_list": ['a', 'b']})
assert len(record) == 2
assert record[0].message.args == ( # type: ignore
"func", '1', '3', "use 'bar' instead."
)
assert record[1].message.args == ( # type: ignore
"deprecated_alias", '1', '3', "use 'bar' instead."
)
assert deprecated_func.__doc__ is not None
assert ".. deprecated::" in deprecated_func.__doc__
assert deprecated_alias.__doc__ is not None
assert ".. deprecated::" in deprecated_alias.__doc__
assert ".. deprecated::" not in func.__doc__ # type: ignore
def test_bad_args():
with pytest.raises(TypeError, match="Cannot set removed_in to a value without also setting deprecated_in"):
deprecated(removed_in="1.2.3")
|
