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
|
import pytest
import sys
from os.path import join, exists, dirname
try:
from packaging.version import parse as LooseVersion
except ImportError:
from distutils.version import LooseVersion
PY_VERSION = LooseVersion('{}.{}'.format(*sys.version_info[0:2]))
IS_MODERN_PYTHON = PY_VERSION > LooseVersion('3.4')
def skip_notebook_tests_if_unsupported():
if not IS_MODERN_PYTHON:
pytest.skip('jupyter support is only for modern python versions')
try:
import IPython # NOQA
import nbconvert # NOQA
import nbformat # NOQA
import platform
if platform.python_implementation() == 'PyPy':
# In xdoctest <= 0.15.0 (~ 2021-01-01) this didn't cause an issue
# But I think there was a jupyter update that broke it.
# PyPy + Jupyter is currently very niche and I don't have the time
# to debug properly, so I'm just turning off these tests.
raise Exception
except Exception:
pytest.skip('Missing jupyter')
def cmd(command):
# simplified version of ub.cmd no fancy tee behavior
import subprocess
proc = subprocess.Popen(
command, shell=True, universal_newlines=True,
stdout=subprocess.PIPE, stderr=subprocess.PIPE
)
out, err = proc.communicate()
ret = proc.wait()
info = {
'proc': proc,
'out': out,
'test_doctest_in_notebook.ipynberr': err,
'ret': ret,
}
return info
def demodata_notebook_fpath():
try:
testdir = dirname(__file__)
except NameError:
# Hack for dev CLI usage
import os
testdir = os.path.expandvars('$HOME/code/xdoctest/tests/')
assert exists(testdir), 'assuming a specific dev environment'
notebook_fpath = join(testdir, "notebook_with_doctests.ipynb")
return notebook_fpath
def test_xdoctest_inside_notebook():
"""
xdoctest ~/code/xdoctest/tests/test_notebook.py test_xdoctest_inside_notebook
xdoctest tests/test_notebook.py test_xdoctest_inside_notebook
xdoctest notebook_with_doctests.ipynb
"""
# How to run Jupyter from Python
# https://nbconvert.readthedocs.io/en/latest/execute_api.html
skip_notebook_tests_if_unsupported()
notebook_fpath = demodata_notebook_fpath()
from xdoctest.utils import util_notebook
nb, resources = util_notebook.execute_notebook(notebook_fpath, verbose=3)
last_cell = nb['cells'][-1]
text = last_cell['outputs'][0]['text']
if '3 / 3 passed' not in text:
import warnings
warnings.warn('test_xdoctest_inside_notebook might fail due to io issues')
def test_xdoctest_outside_notebook():
skip_notebook_tests_if_unsupported()
if sys.platform.startswith('win32'):
pytest.skip()
notebook_fpath = demodata_notebook_fpath()
info = cmd(sys.executable + ' -m xdoctest ' + notebook_fpath)
text = info['out']
assert '3 / 3 passed' in text
|
