-
-
Notifications
You must be signed in to change notification settings - Fork 505
/
test_docs.py
101 lines (72 loc) · 3 KB
/
test_docs.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
"""
The ref_available tests verify that all of the panes, layouts, and widgets defined by panel are
represented in the reference gallery.
The doc_available tests check that python in markdown files can be run top to bottom.
"""
import ast
import runpy
from inspect import isclass
from pathlib import Path
import pytest
import panel as pn
pytestmark = pytest.mark.docs
REF_PATH = Path(__file__).parents[2] / "examples" / "reference"
ref_available = pytest.mark.skipif(not REF_PATH.is_dir(), reason="folder 'examples/reference' not found")
DOC_PATH = Path(__file__).parents[2] / "doc"
IGNORED = ['vtk']
doc_files = [df for df in sorted(DOC_PATH.rglob("*.md")) if not any(ig in str(df).lower() for ig in IGNORED)]
doc_available = pytest.mark.skipif(not DOC_PATH.is_dir(), reason="folder 'doc' not found")
@ref_available
def test_layouts_are_in_reference_gallery():
exceptions = {"ListPanel", "Panel"}
docs = {f.with_suffix("").name for f in (REF_PATH / "layouts").iterdir()}
def is_panel_layout(attr):
layout = getattr(pn.layout, attr)
return isclass(layout) and issubclass(layout, pn.layout.Panel)
layouts = set(filter(is_panel_layout, dir(pn.layout)))
assert layouts - exceptions - docs == set()
@ref_available
def test_widgets_are_in_reference_gallery():
exceptions = {"Ace", "CompositeWidget", "Widget", "ToggleGroup", "NumberInput", "Spinner"}
docs = {
f.with_suffix("").name
for g in ("indicators", "widgets")
for f in (REF_PATH / g).iterdir()
}
def is_panel_widget(attr):
widget = getattr(pn.widgets, attr)
return isclass(widget) and issubclass(widget, pn.widgets.Widget)
widgets = set(filter(is_panel_widget, dir(pn.widgets)))
assert widgets - exceptions - docs == set()
@ref_available
def test_panes_are_in_reference_gallery():
exceptions = {"PaneBase", "YT", "RGGPlot", "Interactive", "ICO", "Image", "IPyLeaflet"}
docs = {f.with_suffix("").name for f in (REF_PATH / "panes").iterdir()}
def is_panel_pane(attr):
pane = getattr(pn.pane, attr)
return isclass(pane) and issubclass(pane, pn.pane.PaneBase)
panes = set(filter(is_panel_pane, dir(pn.pane)))
assert panes - exceptions - docs == set()
@doc_available
@pytest.mark.parametrize(
"file", doc_files, ids=[str(f.relative_to(DOC_PATH)) for f in doc_files]
)
def test_markdown_codeblocks(file, tmp_path):
from markdown_it import MarkdownIt
exceptions = ("await", "pn.serve", "django", "raise", "display(")
md_ast = MarkdownIt().parse(file.read_text(encoding="utf-8"))
lines = ""
for n in md_ast:
if n.tag == "code" and n.info is not None:
if "pyodide" in n.info.lower():
if ">>>" not in n.content:
lines += n.content
if not lines:
return
ast.parse(lines)
if any(w in lines for w in exceptions):
return
mod = tmp_path / f'{file.stem}.py'
with open(mod, 'w', encoding='utf-8') as f:
f.writelines(lines)
runpy.run_path(mod)