forked from mu-editor/mu
-
Notifications
You must be signed in to change notification settings - Fork 0
/
make.py
333 lines (271 loc) · 7.94 KB
/
make.py
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
#!python3
import os
import sys
import fnmatch
import shutil
import subprocess
PYTEST = "pytest"
PYFLAKES = "pyflakes"
PYCODESTYLE = "pycodestyle"
PYGETTEXT = os.path.join(sys.base_prefix, "tools", "i18n", "pygettext.py")
INCLUDE_PATTERNS = {
"*.py"
}
EXCLUDE_PATTERNS = {
"build/*",
"docs/*",
"mu/contrib/*",
"mu/modes/api/*",
"utils/*",
}
_exported = {}
def _walk(
start_from=".",
include_patterns=None,
exclude_patterns=None,
recurse=True
):
if include_patterns:
_include_patterns = set(os.path.normpath(p) for p in include_patterns)
else:
_include_patterns = set()
if exclude_patterns:
_exclude_patterns = set(os.path.normpath(p) for p in exclude_patterns)
else:
_exclude_patterns = set()
for dirpath, dirnames, filenames in os.walk(start_from):
for filename in filenames:
filepath = os.path.normpath(os.path.join(dirpath, filename))
if not any(fnmatch.fnmatch(filepath, pattern)
for pattern in _include_patterns):
continue
if any(fnmatch.fnmatch(filepath, pattern)
for pattern in _exclude_patterns):
continue
yield filepath
if not recurse:
break
def _process_code(executable, use_python, *args):
"""Perform some action (check, translate etc.) across the .py files
in the codebase, skipping docs and build artefacts
"""
if use_python:
execution = ["python", executable]
else:
execution = [executable]
returncodes = set()
for filepath in _walk(".", INCLUDE_PATTERNS, EXCLUDE_PATTERNS, False):
p = subprocess.run(execution + [filepath] + list(args))
returncodes.add(p.returncode)
for filepath in _walk("mu", INCLUDE_PATTERNS, EXCLUDE_PATTERNS):
p = subprocess.run(execution + [filepath] + list(args))
returncodes.add(p.returncode)
for filepath in _walk("tests", INCLUDE_PATTERNS, EXCLUDE_PATTERNS):
p = subprocess.run(execution + [filepath] + list(args))
returncodes.add(p.returncode)
return max(returncodes)
def _rmtree(dirpath, cascade_errors=False):
try:
shutil.rmtree(dirpath)
except OSError:
if cascade_errors:
raise
def _rmfiles(start_from, pattern):
"""Remove files from a directory and its descendants
Starting from `start_from` directory and working downwards,
remove all files which match `pattern`, eg *.pyc
"""
for filepath in _walk(start_from, {pattern}):
os.remove(filepath)
def export(function):
"""Decorator to tag certain functions as exported, meaning
that they show up as a command, with arguments, when this
file is run.
"""
_exported[function.__name__] = function
return function
@export
def test(*pytest_args):
"""Run the test suite
Call py.test to run the test suite with additional args.
The subprocess runner will raise an exception if py.test exits
with a failure value. This forces things to stop if tests fail.
"""
print("\ntest")
return subprocess.run([PYTEST] + list(pytest_args)).returncode
@export
def coverage():
"""View a report on test coverage
Call py.test with coverage turned on
"""
print("\ncoverage")
return subprocess.run([
PYTEST,
"--cov-config",
".coveragerc",
"--cov-report",
"term-missing",
"--cov=mu",
"tests/"
]).returncode
@export
def pyflakes(*pyflakes_args):
"""Run the PyFlakes code checker
Call pyflakes on all .py files outside the docs and contrib directories
"""
print("\npyflakes")
os.environ["PYFLAKES_BUILTINS"] = "_"
return _process_code(PYFLAKES, False, *pyflakes_args)
@export
def pycodestyle(*pycodestyle_args):
"""Run the PEP8 style checker
"""
print("\nPEP8")
args = ("--ignore=E731,E402,W504",) + pycodestyle_args
return _process_code(PYCODESTYLE, False, *args)
@export
def pep8(*pep8_args):
"""Run the PEP8 style checker
"""
return pycodestyle(*pep8_args)
@export
def check():
"""Run all the checkers and tests
"""
print("\nCheck")
funcs = [
clean,
pyflakes,
pycodestyle,
coverage
]
for func in funcs:
return_code = func()
if return_code != 0:
return return_code
return 0
@export
def clean():
"""Reset the project and remove auto-generated assets
"""
print("\nClean")
_rmtree("build")
_rmtree("dist")
_rmtree("mu.egg-info")
_rmtree("coverage")
_rmtree("docs/build")
_rmtree("lib")
_rmtree("pynsist_pkgs")
_rmfiles(".", "*.pyc")
return 0
@export
def translate():
"""Translate
"""
if not os.path.exists(PYGETTEXT):
raise RuntimeError("pygettext.py could not be found at %s" % PYGETTEXT)
result = _process_code(PYGETTEXT, True)
print("\nNew messages.pot file created.")
print("Remember to update the translation strings"
"found in the locale directory.")
return result
@export
def translateall():
"""Translate All The Things
"""
if not os.path.exists(PYGETTEXT):
raise RuntimeError("pygettext.py could not be found at %s" % PYGETTEXT)
result = subprocess.run([
"python", PYGETTEXT,
"mu/*", "mu/debugger/*", "mu/modes/*", "mu/resources/*"
]).returncode
print("\nNew messages.pot file created.")
print("Remember to update the translation strings"
"found in the locale directory.")
return result
@export
def run():
"""Run Mu from within a virtual environment
"""
clean()
if not os.environ.get("VIRTUAL_ENV"):
raise RuntimeError("Cannot run Mu;"
"your Python virtualenv is not activated")
return subprocess.run(["python", "-m", "mu"]).returncode
@export
def dist():
"""Generate a source distribution and a binary wheel
"""
check()
print("Checks pass; good to package")
return subprocess.run(
["python", "setup.py", "sdist", "bdist_wheel"]
).returncode
@export
def publish_test():
"""Upload to a test PyPI
"""
dist()
print("Packaging complete; upload to PyPI")
return subprocess.run([
"twine", "upload",
"-r", "test", "--sign", "dist/*"]
).returncode
@export
def publish_live():
"""Upload to PyPI
"""
dist()
print("Packaging complete; upload to PyPI")
return subprocess.run(["twine", "upload", "--sign", "dist/*"]).returncode
@export
def win32():
"""Build 32-bit Windows installer
"""
check()
print("Building 32-bit Windows installer")
return subprocess.run(["python", "win_installer.py", "32"]).returncode
@export
def win64():
"""Build 64-bit Windows installer
"""
check()
print("Building 64-bit Windows installer")
return subprocess.run(["python", "win_installer.py", "64"]).returncode
@export
def docs():
"""Build the docs
"""
cwd = os.getcwd()
os.chdir("docs")
try:
return subprocess.run(["cmd", "/c", "make.bat", "html"]).returncode
except Exception:
return 1
finally:
os.chdir(cwd)
@export
def help():
"""Display all commands with their description in alphabetical order
"""
module_doc = sys.modules['__main__'].__doc__ or "check"
print(module_doc + "\n" + "=" * len(module_doc) + "\n")
for command, function in sorted(_exported.items()):
doc = function.__doc__
if doc:
first_line = doc.splitlines()[0]
else:
first_line = ""
print("make {} - {}".format(command, first_line))
def main(command="help", *args):
"""Dispatch on command name, passing all remaining parameters to the
module-level function.
"""
try:
function = _exported[command]
except KeyError:
raise RuntimeError("No such command: %s" % command)
else:
return function(*args)
if __name__ == '__main__':
sys.exit(main(*sys.argv[1:]))