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
|
######################################################################
#
# File: test/unit/v1/test_version_utils.py
#
# Copyright 2019 Backblaze Inc. All Rights Reserved.
#
# License https://www.backblaze.com/using_b2_code.html
#
######################################################################
from __future__ import annotations
import warnings
from b2sdk.v1 import rename_argument, rename_function
from ..test_base import TestBase
class TestRenameArgument(TestBase):
VERSION = '0.1.10'
def test_warning(self):
@rename_argument('aaa', 'bbb', '0.1.0', '0.2.0', current_version=self.VERSION)
def easy(bbb):
"""easy docstring"""
return bbb
# check that warning is not emitted too early
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter('always')
assert easy(5) == 5
assert easy(bbb=5) == 5
assert easy.__name__ == 'easy'
assert easy.__doc__.strip() == 'easy docstring'
assert len(w) == 0
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter('always')
assert easy(aaa=5) == 5
assert len(w) == 1
assert issubclass(w[-1].category, DeprecationWarning)
assert (
str(w[-1].message)
== "'aaa' is a deprecated argument for 'easy' function/method - it was renamed to 'bbb' in version 0.1.0. Support for the old name is going to be dropped in 0.2.0."
), str(w[-1].message)
def test_outdated_replacement(self):
with self.assertRaises(
AssertionError,
msg=f"rename_argument decorator is still used in version {self.VERSION} when old argument name 'aaa' was scheduled to be dropped in 0.1.2. It is time to remove the mapping.",
):
@rename_argument('aaa', 'bbb', '0.1.0', '0.1.2', current_version=self.VERSION)
def late(bbb):
return bbb
assert late # make linters happy
def test_future_replacement(self):
with self.assertRaises(
AssertionError,
msg="rename_argument decorator indicates that the replacement of argument 'aaa' should take place in the future version 0.2.0, while the current version is 0.2.2. It looks like should be _discouraged_ at this point and not _deprecated_ yet. Consider using 'discourage_argument' decorator instead.",
):
@rename_argument('aaa', 'bbb', '0.2.0', '0.2.2', current_version=self.VERSION)
def early(bbb):
return bbb
assert early # make linters happy
def test_inverted_versions(self):
with self.assertRaises(
AssertionError,
msg="rename_argument decorator is set to start renaming argument 'aaa' starting at version 0.2.2 and finishing in 0.2.0. It needs to start at a lower version and finish at a higher version.",
):
@rename_argument('aaa', 'bbb', '0.2.2', '0.2.0', current_version=self.VERSION)
def backwards(bbb):
return bbb
assert backwards # make linters happy
class TestRenameFunction(TestBase):
VERSION = '0.1.10'
def test_rename_function(self):
def new(bbb):
return bbb
for i in ('new', new):
@rename_function(i, '0.1.0', '0.2.0', current_version=self.VERSION)
def old(bbb):
return bbb
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter('always')
assert old(5) == 5
assert len(w) == 1
assert issubclass(w[-1].category, DeprecationWarning)
assert (
str(w[-1].message)
== "'old' is deprecated since version 0.1.0 - it was moved to 'new', please switch to use that. The proxy for the old name is going to be removed in 0.2.0."
), str(w[-1].message)
|
