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
|
# Copyright (C) 2023, Benjamin Drung <bdrung@ubuntu.com>
#
# Permission to use, copy, modify, and/or distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
# AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
# PERFORMANCE OF THIS SOFTWARE.
"""Run mypy to check static typing of the Python code."""
import shutil
import subprocess
import sys
import unittest
from . import get_source_files, unittest_verbosity
class MypyTestCase(unittest.TestCase):
"""
This unittest class provides a test that runs mypy to check static
typing of the Python code. The list of source files is provided by
the get_source_files() function.
"""
@unittest.skipIf(not shutil.which("mypy"), "mypy not found")
def test_mypy(self) -> None:
"""Test: Run mypy on Python source code."""
# The *-distro-info binaries do not have type hints.
# Exlude system installed modules due to https://github.com/python/mypy/issues/14559
sources = [
s for s in get_source_files() if not (s.endswith("-distro-info") or s.startswith("/"))
]
# PEP 561 does not support distributing typing information as part of module-only
# distributions. So suppress errors for missing type hints of installed `distro_info`.
cmd = ["mypy", "--ignore-missing-imports", "--strict"] + sources
if unittest_verbosity() >= 2:
sys.stderr.write(f"Running following command:\n{' '.join(cmd)}\n")
process = subprocess.run(cmd, capture_output=True, check=False, text=True)
if process.returncode != 0: # pragma: no cover
msgs = []
if process.stderr:
msgs.append(
f"mypy exited with code {process.returncode} and has"
f" unexpected output on stderr:\n{process.stderr.rstrip()}"
)
if process.stdout:
msgs.append(f"mypy found issues:\n{process.stdout.rstrip()}")
if not msgs:
msgs.append(
f"mypy exited with code {process.returncode} "
"and has no output on stdout or stderr."
)
self.fail("\n".join(msgs))
|
