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
|
"""Turn the examples section of a function docstring into a notebook."""
import re
import sys
import pydoc
import seaborn
from seaborn.external.docscrape import NumpyDocString
import nbformat
def line_type(line):
if line.startswith(" "):
return "code"
else:
return "markdown"
def add_cell(nb, lines, cell_type):
cell_objs = {
"code": nbformat.v4.new_code_cell,
"markdown": nbformat.v4.new_markdown_cell,
}
text = "\n".join(lines)
cell = cell_objs[cell_type](text)
nb["cells"].append(cell)
if __name__ == "__main__":
_, name = sys.argv
# Parse the docstring and get the examples section
obj = getattr(seaborn, name)
if obj.__class__.__name__ != "function":
obj = obj.__init__
lines = NumpyDocString(pydoc.getdoc(obj))["Examples"]
# Remove code indentation, the prompt, and mpl return variable
pat = re.compile(r"\s{4}[>\.]{3} (ax = ){0,1}(g = ){0,1}")
nb = nbformat.v4.new_notebook()
# We always start with at least one line of text
cell_type = "markdown"
cell = []
for line in lines:
# Ignore matplotlib plot directive
if ".. plot" in line or ":context:" in line:
continue
# Ignore blank lines
if not line:
continue
if line_type(line) != cell_type:
# We are on the first line of the next cell,
# so package up the last cell
add_cell(nb, cell, cell_type)
cell_type = line_type(line)
cell = []
if line_type(line) == "code":
line = re.sub(pat, "", line)
cell.append(line)
# Package the final cell
add_cell(nb, cell, cell_type)
nbformat.write(nb, f"docstrings/{name}.ipynb")
|
