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
234
235
|
import os
import re
import shutil
import sys
import tempfile
from sqlalchemy import testing
from sqlalchemy.testing import config
from sqlalchemy.testing import eq_
from sqlalchemy.testing import fixtures
class MypyPluginTest(fixtures.TestBase):
__requires__ = ("sqlalchemy2_stubs",)
@testing.fixture(scope="function")
def per_func_cachedir(self):
for item in self._cachedir():
yield item
@testing.fixture(scope="class")
def cachedir(self):
for item in self._cachedir():
yield item
def _cachedir(self):
with tempfile.TemporaryDirectory() as cachedir:
with open(
os.path.join(cachedir, "sqla_mypy_config.cfg"), "w"
) as config_file:
config_file.write(
"""
[mypy]\n
plugins = sqlalchemy.ext.mypy.plugin\n
"""
)
with open(
os.path.join(cachedir, "plain_mypy_config.cfg"), "w"
) as config_file:
config_file.write(
"""
[mypy]\n
"""
)
yield cachedir
@testing.fixture()
def mypy_runner(self, cachedir):
from mypy import api
def run(path, use_plugin=True, incremental=False):
args = [
"--strict",
"--raise-exceptions",
"--cache-dir",
cachedir,
"--config-file",
os.path.join(
cachedir,
"sqla_mypy_config.cfg"
if use_plugin
else "plain_mypy_config.cfg",
),
]
if incremental:
args.append(path)
else:
# mypy as of 0.990 is more aggressively blocking messaging
# for paths that are in sys.path, and as pytest puts currdir,
# test/ etc in sys.path, just copy the source file to the
# tempdir we are working in so that we don't have to try to
# manipulate sys.path and/or guess what mypy is doing
filename = os.path.basename(path)
test_program = os.path.join(cachedir, filename)
shutil.copyfile(path, test_program)
args.append(test_program)
# I set this locally but for the suite here needs to be
# disabled
os.environ.pop("MYPY_FORCE_COLOR", None)
result = api.run(args)
return result
return run
def _incremental_dirs():
path = os.path.join(os.path.dirname(__file__), "incremental")
files = []
for d in os.listdir(path):
if os.path.isdir(os.path.join(path, d)):
files.append(
os.path.join(os.path.dirname(__file__), "incremental", d)
)
for extra_dir in testing.config.options.mypy_extra_test_paths:
if extra_dir and os.path.isdir(extra_dir):
for d in os.listdir(os.path.join(extra_dir, "incremental")):
if os.path.isdir(os.path.join(path, d)):
files.append(os.path.join(extra_dir, "incremental", d))
return files
@testing.combinations(
*[(pathname,) for pathname in _incremental_dirs()], argnames="pathname"
)
@testing.requires.patch_library
def test_incremental(self, mypy_runner, per_func_cachedir, pathname):
import patch
cachedir = per_func_cachedir
dest = os.path.join(cachedir, "mymodel")
os.mkdir(dest)
patches = set()
print("incremental test: %s" % pathname)
for fname in os.listdir(pathname):
if fname.endswith(".py"):
shutil.copy(
os.path.join(pathname, fname), os.path.join(dest, fname)
)
print("copying to: %s" % os.path.join(dest, fname))
elif fname.endswith(".testpatch"):
patches.add(fname)
for patchfile in [None] + sorted(patches):
if patchfile is not None:
print("Applying patchfile %s" % patchfile)
patch_obj = patch.fromfile(os.path.join(pathname, patchfile))
assert patch_obj.apply(1, dest), (
"pathfile %s failed" % patchfile
)
print("running mypy against %s" % dest)
result = mypy_runner(
dest,
use_plugin=True,
incremental=True,
)
eq_(
result[2],
0,
msg="Failure after applying patch %s: %s"
% (patchfile, result[0]),
)
def _file_combinations():
path = os.path.join(os.path.dirname(__file__), "files")
files = []
for f in os.listdir(path):
if f.endswith(".py"):
files.append(
os.path.join(os.path.dirname(__file__), "files", f)
)
for extra_dir in testing.config.options.mypy_extra_test_paths:
if extra_dir and os.path.isdir(extra_dir):
for f in os.listdir(os.path.join(extra_dir, "files")):
if f.endswith(".py"):
files.append(os.path.join(extra_dir, "files", f))
return files
@testing.combinations(
*[(filename,) for filename in _file_combinations()], argnames="path"
)
def test_mypy(self, mypy_runner, path):
filename = os.path.basename(path)
use_plugin = True
expected_errors = []
expected_re = re.compile(r"\s*# EXPECTED(_MYPY)?: (.+)")
py_ver_re = re.compile(r"^#\s*PYTHON_VERSION\s?>=\s?(\d+\.\d+)")
with open(path) as file_:
for num, line in enumerate(file_, 1):
m = py_ver_re.match(line)
if m:
major, _, minor = m.group(1).partition(".")
if sys.version_info < (int(major), int(minor)):
config.skip_test(
"Requires python >= %s" % (m.group(1))
)
continue
if line.startswith("# NOPLUGINS"):
use_plugin = False
continue
m = expected_re.match(line)
if m:
is_mypy = bool(m.group(1))
expected_msg = m.group(2)
expected_msg = re.sub(r"# noqa[:]? ?.*", "", m.group(2))
expected_errors.append(
(num, is_mypy, expected_msg.strip())
)
result = mypy_runner(path, use_plugin=use_plugin)
not_located = []
if expected_errors:
# mypy 0.990 changed how return codes work, so don't assume a
# 1 or a 0 return code here, could be either depending on if
# errors were generated or not
print(result[0])
errors = []
for e in result[0].split("\n"):
if re.match(r".+\.py:\d+: error: .*", e):
errors.append(e)
for num, is_mypy, msg in expected_errors:
msg = msg.replace("'", '"')
prefix = "[SQLAlchemy Mypy plugin] " if not is_mypy else ""
for idx, errmsg in enumerate(errors):
if (
f"{filename}:{num + 1}: error: {prefix}{msg}"
in errmsg.replace("'", '"')
):
break
else:
not_located.append(msg)
continue
del errors[idx]
if not_located:
print(f"Couldn't locate expected messages: {not_located}")
assert False, "expected messages not found, see stdout"
assert not errors, "errors remain: %s" % "\n".join(errors)
else:
eq_(result[2], 0, msg=result)
|
