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
|
from __future__ import annotations
import os
from pathlib import Path
import subprocess
import pytest
from pyvista.typing.mypy_plugin import promote_type
TEST_DIR = str(Path(__file__).parent)
ROOT_DIR = str(Path(TEST_DIR).parent.parent.parent)
assert 'tests' in os.listdir(ROOT_DIR) # noqa: PTH208
MYPY_PLUGIN_MODULE = str(Path(ROOT_DIR) / 'pyvista' / 'typing' / 'mypy_plugin.py')
MYPY_CONFIG_FILE_NO_PLUGIN = str(Path(TEST_DIR) / 'mypy_no_plugin.ini')
MYPY_CONFIG_FILE_USE_PLUGIN = str(Path(TEST_DIR) / 'mypy_use_plugin.ini')
@pytest.fixture
def decorated_single():
@promote_type(float)
class Foo: ...
return Foo
@pytest.fixture
def decorated_double():
@promote_type(float, str)
class Foo: ...
return Foo
def test_promote_type_runtime(decorated_single, decorated_double):
klass = decorated_single()
assert isinstance(klass, decorated_single)
klass = decorated_double()
assert isinstance(klass, decorated_double)
cases = [
dict( # Test that the duck type is not a float by default
use_plugin=False,
promote_type=float,
arg_type=float,
expected_output='py:9: error: Argument 1 to "foo" has incompatible type "DuckType"; '
'expected "float" [arg-type]',
),
dict( # Same as above, but use the plugin.
use_plugin=True, promote_type=float, arg_type=float, expected_output=''
),
dict( # Test promotion as a subclass.
use_plugin=True, promote_type=int, arg_type=float, expected_output=''
),
dict( # Test promotion is one-way.
use_plugin=True,
promote_type=float,
arg_type=int,
expected_output='py:9: error: Argument 1 to "foo" has incompatible type "DuckType"; '
'expected "int" [arg-type]',
),
]
@pytest.mark.parametrize(
('use_plugin', 'promote_type', 'arg_type', 'expected_output'),
[case.values() for case in cases],
)
def test_promote_type_static(use_plugin, promote_type, arg_type, expected_output, tmp_path):
code = f"""
from pyvista.typing.mypy_plugin import promote_type
@promote_type({promote_type.__name__})
class DuckType: ...
y: DuckType
def foo(x: {arg_type.__name__}) -> None: ...
foo(y)
"""
mypy_output = _run_mypy_code(code, use_plugin=use_plugin, tmp_path=tmp_path)
stdout = str(mypy_output.stdout.decode('utf-8'))
code = mypy_output.returncode
if expected_output == '':
assert code == 0, f'Mypy did not return success status:\n{stdout}'
else:
assert code != 0, f'Mypy returned success status, but an error was expected:\n{stdout}'
assert expected_output in stdout
def _run_mypy_code(code, use_plugin, tmp_path):
"""Call mypy from the project root dir with or without the plugin enabled."""
# Save code to tmp file
tmp_file = tmp_path / 'code.py'
with open(tmp_file, 'w', encoding='utf-8') as file: # noqa: PTH123
file.write(code)
cwd = Path.cwd()
try:
# Use '--follow-imports=skip' to only analyze the files passed to mypy
# otherwise it will analyze the entire pyvista library
args = ['mypy', '--show-traceback', '--follow-imports=skip']
# Set config file
config = MYPY_CONFIG_FILE_USE_PLUGIN if use_plugin else MYPY_CONFIG_FILE_NO_PLUGIN
args.extend(['--config-file', config])
# Only run mypy on the code block and plugin module files
args.extend([tmp_file, MYPY_PLUGIN_MODULE])
return subprocess.run(args, capture_output=True, check=False)
finally:
os.chdir(cwd)
|
