forked from marshmallow-code/apispec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tasks.py
92 lines (79 loc) · 2.17 KB
/
tasks.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
# -*- coding: utf-8 -*-
import os
import sys
import webbrowser
from invoke import task
docs_dir = 'docs'
build_dir = os.path.join(docs_dir, '_build')
@task
def test(ctx, watch=False, last_failing=False):
"""Run the tests.
Note: --watch requires pytest-xdist to be installed.
"""
import pytest
syntax(ctx)
args = []
if watch:
args.append('-f')
if last_failing:
args.append('--lf')
args.append('tests')
retcode = pytest.main(args)
sys.exit(retcode)
@task
def syntax(ctx):
"""Run pre-commit hooks on codebase. Checks formatting and syntax."""
ctx.run('pre-commit run --all-files --show-diff-on-failure', echo=True)
@task
def watch(ctx):
"""Run tests when a file changes. Requires pytest-xdist."""
import pytest
errcode = pytest.main(['-f'])
sys.exit(errcode)
@task
def clean(ctx):
ctx.run('rm -rf build')
ctx.run('rm -rf dist')
ctx.run('rm -rf apispec.egg-info')
clean_docs(ctx)
print('Cleaned up.')
@task
def clean_docs(ctx):
ctx.run('rm -rf %s' % build_dir)
@task
def browse_docs(ctx):
path = os.path.join(build_dir, 'index.html')
webbrowser.open_new_tab(path)
def build_docs(ctx, browse):
ctx.run('sphinx-build %s %s' % (docs_dir, build_dir), echo=True)
if browse:
browse_docs(ctx)
@task
def docs(ctx, clean=False, browse=False, watch=False):
"""Build the docs."""
if clean:
clean_docs(ctx)
if watch:
watch_docs(ctx, browse=browse)
else:
build_docs(ctx, browse=browse)
@task
def watch_docs(ctx, browse=False):
"""Run build the docs when a file changes."""
try:
import sphinx_autobuild # noqa
except ImportError:
print('ERROR: watch task requires the sphinx_autobuild package.')
print('Install it with:')
print(' pip install sphinx-autobuild')
sys.exit(1)
ctx.run(
'sphinx-autobuild {0} {1} {2} -z apispec'.format(
'--open-browser' if browse else '', docs_dir, build_dir,
), echo=True, pty=True,
)
@task
def readme(ctx, browse=False):
ctx.run('rst2html.py README.rst > README.html')
if browse:
webbrowser.open_new_tab('README.html')