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
|
import os
import sys
import subprocess
import webbrowser
from invoke import task
from ._config import ROOT_DIR
@task
def lint(ctx):
"""alias for "invoke test --style" """
flake8_wrapper() # exits on fail
black_wrapper(False) # always exits
@task(
optional=["unit", "style"],
help=dict(
unit="run unit tests (pytest)",
installed="like unit, but prefer using installed package, "
+ "and do not allow the use of internet.",
style="run style tests (flake8 and black)",
cover="show test coverage",
),
)
def test(ctx, unit=False, installed=False, style=False, cover=False):
"""run tests (unit, style)"""
if not (unit or installed or style or cover):
sys.exit("Test task needs --unit, --style or --cover")
if unit:
sys.exit(pytest_wrapper())
if style:
flake8_wrapper() # exits on fail
black_wrapper(False) # always exits
if installed:
for p in list(sys.path):
if p in ("", "."):
sys.path.remove(p)
elif p == ROOT_DIR or p == os.path.dirname(ROOT_DIR):
sys.path.remove(p)
os.environ["IMAGEIO_NO_INTERNET"] = "1"
sys.exit(pytest_wrapper(needs_internet=False))
if cover:
res = pytest_wrapper(cov_report="html")
if res:
raise RuntimeError("Cannot show coverage, tests failed.")
print("Launching browser.")
fname = os.path.join(os.getcwd(), "htmlcov", "index.html")
if not os.path.isfile(fname):
raise IOError("Generated file not found: %s" % fname)
webbrowser.open_new_tab(fname)
@task
def autoformat(ctx):
"""Alias for format."""
black_wrapper(True)
@task
def format(ctx):
"""Format the code using the Black uncompromising formatter."""
black_wrapper(True)
@task
def checkformat(ctx):
"""Check for formatting errors using Black."""
black_wrapper(False)
def flake8_wrapper():
"""Helper function to catch the worst style errors (e.g. unused variables)."""
# http://pep8.readthedocs.io/en/latest/intro.html#error-codes
cmd = [sys.executable, "-m", "flake8", "--select=F,E11", "imageio", "tests"]
ret_code = subprocess.call(cmd, cwd=ROOT_DIR)
if ret_code == 0:
print("No style errors found")
else:
sys.exit(ret_code)
def black_wrapper(writeback):
"""Helper function to invoke black programatically."""
check = [] if writeback else ["--check"]
sys.argv[1:] = check + ROOT_DIR
import black
black.main()
def pytest_wrapper(cov_report="term", needs_internet=True):
"""Helper function to run tests."""
import pytest
# basic opts
args = ["-v"]
if not needs_internet:
args += ["-m", "not needs_internet"]
# coverage add-on
args += [
"--cov",
"imageio",
"--cov-config",
".coveragerc",
"--cov-report",
cov_report,
]
# test location
args += [os.path.join(ROOT_DIR, "tests")]
return pytest.main(args)
|
