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
|
import importlib
import re
import sys
import warnings
from os.path import abspath, dirname
from docutils import nodes, utils, frontend
from docutils.parsers.rst import Directive
from docutils.parsers.rst.directives import flag
from myst_parser.docutils_ import Parser
from sphinx import addnodes
sys.path.insert(0, abspath(dirname(dirname(dirname(__file__)))))
from tools.schemapi.utils import fix_docstring_issues, SchemaInfo # noqa: E402
def type_description(schema):
"""Return a concise type description for the given schema"""
if not schema or not isinstance(schema, dict) or schema.keys() == {"description"}:
return "any"
elif "$ref" in schema:
return ":class:`{}`".format(schema["$ref"].split("/")[-1])
elif "enum" in schema:
return "[{}]".format(", ".join(repr(s) for s in schema["enum"]))
elif "type" in schema:
if isinstance(schema["type"], list):
return "[{}]".format(", ".join(schema["type"]))
elif schema["type"] == "array":
return "array({})".format(type_description(schema.get("items", {})))
elif schema["type"] == "object":
return "dict"
else:
return "`{}`".format(schema["type"])
elif "anyOf" in schema:
return "anyOf({})".format(
", ".join(type_description(s) for s in schema["anyOf"])
)
else:
warnings.warn(
"cannot infer type for schema with keys {}" "".format(schema.keys()),
stacklevel=1,
)
return "--"
def prepare_table_header(titles, widths):
"""Build docutil empty table"""
ncols = len(titles)
assert len(widths) == ncols
tgroup = nodes.tgroup(cols=ncols)
for width in widths:
tgroup += nodes.colspec(colwidth=width)
header = nodes.row()
for title in titles:
header += nodes.entry("", nodes.paragraph(text=title))
tgroup += nodes.thead("", header)
tbody = nodes.tbody()
tgroup += tbody
return nodes.table("", tgroup), tbody
reClassDef = re.compile(r":class:`([^`]+)`")
reCode = re.compile(r"`([^`]+)`")
def add_class_def(node, classDef):
"""Add reference on classDef to node"""
ref = addnodes.pending_xref(
reftarget=classDef,
reftype="class",
refdomain="py", # py:class="None" py:module="altair" refdoc="user_guide/marks"
refexplicit=False,
# refdoc="",
refwarn=False,
)
ref["py:class"] = "None"
ref["py:module"] = "altair"
ref += nodes.literal(text=classDef, classes=["xref", "py", "py-class"])
node += ref
return node
def add_text(node, text):
"""Add text with inline code to node"""
is_text = True
for part in reCode.split(text):
if part:
if is_text:
node += nodes.Text(part, part)
else:
node += nodes.literal(part, part)
is_text = not is_text
return node
def build_row(item, rootschema):
"""Return nodes.row with property description"""
prop, propschema, required = item
row = nodes.row()
# Property
row += nodes.entry("", nodes.paragraph(text=prop), classes=["vl-prop"])
# Type
str_type = type_description(propschema)
par_type = nodes.paragraph()
is_text = True
for part in reClassDef.split(str_type):
if part:
if is_text:
add_text(par_type, part)
else:
add_class_def(par_type, part)
is_text = not is_text
# row += nodes.entry('')
row += nodes.entry("", par_type, classes=["vl-type-def"])
# Description
md_parser = Parser()
# str_descr = "***Required.*** " if required else ""
description = SchemaInfo(propschema, rootschema).deep_description
description = description if description else " "
str_descr = ""
str_descr += description
str_descr = fix_docstring_issues(str_descr)
document_settings = frontend.get_default_settings()
document_settings.setdefault("raw_enabled", True)
doc_descr = utils.new_document("schema_description", document_settings)
md_parser.parse(str_descr, doc_descr)
# row += nodes.entry('', *doc_descr.children, classes="vl-decsr")
row += nodes.entry("", *doc_descr.children, classes=["vl-decsr"])
return row
def build_schema_table(items, rootschema):
"""Return schema table of items (iterator of prop, schema.item, required)"""
table, tbody = prepare_table_header(
["Property", "Type", "Description"], [10, 20, 50]
)
for item in items:
tbody += build_row(item, rootschema)
return table
def select_items_from_schema(schema, props=None):
"""Return iterator (prop, schema.item, required) on prop, return all in None"""
properties = schema.get("properties", {})
required = schema.get("required", [])
if not props:
for prop, item in properties.items():
yield prop, item, prop in required
else:
for prop in props:
try:
yield prop, properties[prop], prop in required
except KeyError as err:
raise Exception(f"Can't find property: {prop}") from err
def prepare_schema_table(schema, rootschema, props=None):
items = select_items_from_schema(schema, props)
return build_schema_table(items, rootschema)
def validate_properties(properties):
return properties.strip().split()
class AltairObjectTableDirective(Directive):
"""
Directive for building a table of attribute descriptions.
Usage:
.. altair-object-table:: altair.MarkConfig
"""
has_content = False
required_arguments = 1
option_spec = {"properties": validate_properties, "dont-collapse-table": flag}
def run(self):
objectname = self.arguments[0]
modname, classname = objectname.rsplit(".", 1)
module = importlib.import_module(modname)
cls = getattr(module, classname)
schema = cls.resolve_references(cls._schema)
properties = self.options.get("properties", None)
dont_collapse_table = "dont-collapse-table" in self.options
result = []
if not dont_collapse_table:
html = "<details><summary><a>Click to show table</a></summary>"
raw_html = nodes.raw("", html, format="html")
result += [raw_html]
# create the table from the object
result.append(prepare_schema_table(schema, cls._rootschema, props=properties))
if not dont_collapse_table:
html = "</details>"
raw_html = nodes.raw("", html, format="html")
result += [raw_html]
return result
def setup(app):
app.add_directive("altair-object-table", AltairObjectTableDirective)
|
