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 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
|
import os.path as opath
import textwrap
from io import StringIO
from codegen.utils import PlotlyNode, write_source_py
def get_typing_type(plotly_type, array_ok=False):
"""
Get Python type corresponding to a valType string from the plotly schema
Parameters
----------
plotly_type : str
a plotly datatype string
array_ok : bool
Whether lists/arrays are permitted
Returns
-------
str
Python type string
"""
if plotly_type == "data_array":
pytype = "numpy.ndarray"
elif plotly_type == "info_array":
pytype = "list"
elif plotly_type == "colorlist":
pytype = "list"
elif plotly_type in ("string", "color", "colorscale", "subplotid"):
pytype = "str"
elif plotly_type in ("enumerated", "flaglist", "any"):
pytype = "Any"
elif plotly_type in ("number", "angle"):
pytype = "int|float"
elif plotly_type == "integer":
pytype = "int"
elif plotly_type == "boolean":
pytype = "bool"
else:
raise ValueError("Unknown plotly type: %s" % plotly_type)
if array_ok:
return f"{pytype}|numpy.ndarray"
else:
return pytype
def build_datatype_py(node):
"""
Build datatype (graph_objs) class source code string for a datatype
PlotlyNode
Parameters
----------
node : PlotlyNode
The datatype node (node.is_datatype must evaluate to true) for which
to build the datatype class
Returns
-------
str
String containing source code for the datatype class definition
"""
# Validate inputs
# ---------------
assert node.is_compound
# Handle template traces
# ----------------------
# We want template trace/layout classes like
# plotly.graph_objs.layout.template.data.Scatter to map to the
# corresponding trace/layout class (e.g. plotly.graph_objs.Scatter).
# So rather than generate a class definition, we just import the
# corresponding trace/layout class
if node.parent_path_str == "layout.template.data":
return f"from plotly.graph_objs import {node.name_datatype_class}"
elif node.path_str == "layout.template.layout":
return "from plotly.graph_objs import Layout"
# Extract node properties
# -----------------------
undercase = node.name_undercase
datatype_class = node.name_datatype_class
literal_nodes = [n for n in node.child_literals if n.plotly_name in ["type"]]
# Initialze source code buffer
# ----------------------------
buffer = StringIO()
# Imports
# -------
buffer.write(
f"from plotly.basedatatypes "
f"import {node.name_base_datatype} as _{node.name_base_datatype}\n"
)
buffer.write(f"import copy as _copy\n")
# Write class definition
# ----------------------
buffer.write(
f"""
class {datatype_class}(_{node.name_base_datatype}):\n"""
)
# ### Layout subplot properties ###
if datatype_class == "Layout":
subplot_nodes = [
node
for node in node.child_compound_datatypes
if node.node_data.get("_isSubplotObj", False)
]
subplot_names = [n.name_property for n in subplot_nodes]
buffer.write(
f"""
_subplotid_prop_names = {repr(subplot_names)}
import re
_subplotid_prop_re = re.compile(
'^(' + '|'.join(_subplotid_prop_names) + r')(\d+)$')
"""
)
subplot_validator_names = [n.name_validator_class for n in subplot_nodes]
validator_csv = ", ".join(subplot_validator_names)
subplot_dict_str = (
"{"
+ ", ".join(
f"'{subname}': {valname}"
for subname, valname in zip(subplot_names, subplot_validator_names)
)
+ "}"
)
buffer.write(
f"""
@property
def _subplotid_validators(self):
\"\"\"
dict of validator classes for each subplot type
Returns
-------
dict
\"\"\"
from plotly.validators.layout import ({validator_csv})
return {subplot_dict_str}
def _subplot_re_match(self, prop):
return self._subplotid_prop_re.match(prop)
"""
)
child_datatype_nodes = node.child_datatypes
subtype_nodes = child_datatype_nodes
valid_props_list = sorted(
[node.name_property for node in subtype_nodes + literal_nodes]
)
buffer.write(
f"""
# class properties
# --------------------
_parent_path_str = '{node.parent_path_str}'
_path_str = '{node.path_str}'
_valid_props = {{"{'", "'.join(valid_props_list)}"}}
"""
)
# ### Property definitions ###
for subtype_node in subtype_nodes:
if subtype_node.is_array_element:
prop_type = (
f"tuple[plotly.graph_objs{node.dotpath_str}."
+ f"{subtype_node.name_datatype_class}]"
)
elif subtype_node.is_compound:
prop_type = (
f"plotly.graph_objs{node.dotpath_str}."
+ f"{subtype_node.name_datatype_class}"
)
# remap template traces to regular traces
prop_type = prop_type.replace("layout.template.data", "")
elif subtype_node.is_mapped:
prop_type = ""
else:
prop_type = get_typing_type(subtype_node.datatype, subtype_node.is_array_ok)
# #### Get property description ####
raw_description = subtype_node.description
property_description = "\n".join(
textwrap.wrap(
raw_description,
initial_indent=" " * 8,
subsequent_indent=" " * 8,
width=79 - 8,
)
)
# # #### Get validator description ####
validator = subtype_node.get_validator_instance()
if validator:
validator_description = reindent_validator_description(validator, 4)
# #### Combine to form property docstring ####
if property_description.strip():
property_docstring = f"""{property_description}
{validator_description}"""
else:
property_docstring = f" {validator_description}"
else:
property_docstring = property_description
# #### Write get property ####
buffer.write(
f"""\
# {subtype_node.name_property}
# {'-' * len(subtype_node.name_property)}
@property
def {subtype_node.name_property}(self):
\"\"\"
{property_docstring}
Returns
-------
{prop_type}
\"\"\"
return self['{subtype_node.name_property}']"""
)
# #### Write set property ####
buffer.write(
f"""
@{subtype_node.name_property}.setter
def {subtype_node.name_property}(self, val):
self['{subtype_node.name_property}'] = val\n"""
)
# ### Literals ###
for literal_node in literal_nodes:
buffer.write(
f"""\
# {literal_node.name_property}
# {'-' * len(literal_node.name_property)}
@property
def {literal_node.name_property}(self):
return self._props['{literal_node.name_property}']\n"""
)
# ### Private properties descriptions ###
valid_props = {node.name_property for node in subtype_nodes}
buffer.write(
f"""
# Self properties description
# ---------------------------
@property
def _prop_descriptions(self):
return \"\"\"\\"""
)
buffer.write(node.get_constructor_params_docstring(indent=8))
buffer.write(
f"""
\"\"\""""
)
mapped_nodes = [n for n in subtype_nodes if n.is_mapped]
mapped_properties = {n.plotly_name: n.relative_path for n in mapped_nodes}
if mapped_properties:
buffer.write(
f"""
_mapped_properties = {repr(mapped_properties)}"""
)
# ### Constructor ###
buffer.write(
f"""
def __init__(self"""
)
add_constructor_params(buffer, subtype_nodes, prepend_extras=["arg"])
# ### Constructor Docstring ###
header = f"Construct a new {datatype_class} object"
class_name = (
f"plotly.graph_objs" f"{node.parent_dotpath_str}." f"{node.name_datatype_class}"
)
extras = [
(
f"arg",
f"dict of properties compatible with this constructor "
f"or an instance of :class:`{class_name}`",
)
]
add_docstring(
buffer,
node,
header=header,
prepend_extras=extras,
return_type=node.name_datatype_class,
)
buffer.write(
f"""
super({datatype_class}, self).__init__('{node.name_property}')
if '_parent' in kwargs:
self._parent = kwargs['_parent']
return
"""
)
if datatype_class == "Layout":
buffer.write(
f"""
# Override _valid_props for instance so that instance can mutate set
# to support subplot properties (e.g. xaxis2)
self._valid_props = {{"{'", "'.join(valid_props_list)}"}}
"""
)
buffer.write(
f"""
# Validate arg
# ------------
if arg is None:
arg = {{}}
elif isinstance(arg, self.__class__):
arg = arg.to_plotly_json()
elif isinstance(arg, dict):
arg = _copy.copy(arg)
else:
raise ValueError(\"\"\"\\
The first argument to the {class_name}
constructor must be a dict or
an instance of :class:`{class_name}`\"\"\")
# Handle skip_invalid
# -------------------
self._skip_invalid = kwargs.pop('skip_invalid', False)
self._validate = kwargs.pop('_validate', True)
"""
)
buffer.write(
f"""
# Populate data dict with properties
# ----------------------------------"""
)
for subtype_node in subtype_nodes:
name_prop = subtype_node.name_property
buffer.write(
f"""
_v = arg.pop('{name_prop}', None)
_v = {name_prop} if {name_prop} is not None else _v
if _v is not None:
self['{name_prop}'] = _v"""
)
# ### Literals ###
if literal_nodes:
buffer.write(
f"""
# Read-only literals
# ------------------
"""
)
for literal_node in literal_nodes:
lit_name = literal_node.name_property
lit_val = repr(literal_node.node_data)
buffer.write(
f"""
self._props['{lit_name}'] = {lit_val}
arg.pop('{lit_name}', None)"""
)
buffer.write(
f"""
# Process unknown kwargs
# ----------------------
self._process_kwargs(**dict(arg, **kwargs))
# Reset skip_invalid
# ------------------
self._skip_invalid = False
"""
)
# Return source string
# --------------------
return buffer.getvalue()
def reindent_validator_description(validator, extra_indent):
"""
Return validator description with modified indenting. The string that is
returned has no leading indent, and the subsequent lines are indented by 4
spaces (the default for validator descriptions) plus `extra_indent` spaces
Parameters
----------
validator : BaseValidator
Validator from which to extract the description
extra_indent : int
Number of spaces of indent to add to subsequent lines (those after
the first line). Validators description start with in indent of 4
spaces
Returns
-------
str
Validator description string
"""
# Remove leading indent and add extra spaces to subsequent indent
return ("\n" + " " * extra_indent).join(validator.description().strip().split("\n"))
def add_constructor_params(buffer, subtype_nodes, prepend_extras=(), append_extras=()):
"""
Write datatype constructor params to a buffer
Parameters
----------
buffer : StringIO
Buffer to write to
subtype_nodes : list of PlotlyNode
List of datatype nodes to be written as constructor params
prepend_extras : list[str]
List of extra parameters to include at the beginning of the params
append_extras : list[str]
List of extra parameters to include at the end of the params
Returns
-------
None
"""
for extra in prepend_extras:
buffer.write(
f""",
{extra}=None"""
)
for i, subtype_node in enumerate(subtype_nodes):
buffer.write(
f""",
{subtype_node.name_property}=None"""
)
for extra in append_extras:
buffer.write(
f""",
{extra}=None"""
)
buffer.write(
""",
**kwargs"""
)
buffer.write(
f"""
):"""
)
def add_docstring(
buffer, node, header, prepend_extras=(), append_extras=(), return_type=None
):
"""
Write docstring for a compound datatype node
Parameters
----------
buffer : StringIO
Buffer to write to
node : PlotlyNode
Compound datatype plotly node for which to write docstring
header :
Top-level header for docstring that will preceded the input node's
own description. Header should be < 71 characters long
prepend_extras :
List or tuple of propery name / description pairs that should be
included at the beginning of the docstring
append_extras :
List or tuple of propery name / description pairs that should be
included at the end of the docstring
return_type :
The docstring return type
Returns
-------
"""
# Validate inputs
# ---------------
assert node.is_compound
# Build wrapped description
# -------------------------
node_description = node.description
if node_description:
description_lines = textwrap.wrap(
node_description,
width=79 - 8,
initial_indent=" " * 8,
subsequent_indent=" " * 8,
)
node_description = "\n".join(description_lines) + "\n\n"
# Write header and description
# ----------------------------
buffer.write(
f"""
\"\"\"
{header}
{node_description} Parameters
----------"""
)
# Write parameter descriptions
# ----------------------------
# Write any prepend extras
for p, v in prepend_extras:
v_wrapped = "\n".join(
textwrap.wrap(
v, width=79 - 12, initial_indent=" " * 12, subsequent_indent=" " * 12
)
)
buffer.write(
f"""
{p}
{v_wrapped}"""
)
# Write core docstring
buffer.write(node.get_constructor_params_docstring(indent=8))
# Write any append extras
for p, v in append_extras:
if "\n" in v:
# If v contains newlines then assume it's already wrapped as
# desired
v_wrapped = v
else:
v_wrapped = "\n".join(
textwrap.wrap(
v,
width=79 - 12,
initial_indent=" " * 12,
subsequent_indent=" " * 12,
)
)
buffer.write(
f"""
{p}
{v_wrapped}"""
)
# Write return block and close docstring
# --------------------------------------
buffer.write(
f"""
Returns
-------
{return_type}
\"\"\""""
)
def write_datatype_py(outdir, node):
"""
Build datatype (graph_objs) class source code and write to a file
Parameters
----------
outdir :
Root outdir in which the graph_objs package should reside
node :
The datatype node (node.is_datatype must evaluate to true) for which
to build the datatype class
Returns
-------
None
"""
# Build file path
# ---------------
# filepath = opath.join(outdir, "graph_objs", *node.parent_path_parts, "__init__.py")
filepath = opath.join(
outdir, "graph_objs", *node.parent_path_parts, "_" + node.name_undercase + ".py"
)
# Generate source code
# --------------------
datatype_source = build_datatype_py(node)
# Write file
# ----------
write_source_py(datatype_source, filepath, leading_newlines=2)
|