Method get_constructor_params_docstring

codegen/utils.py:881–954

Return a docstring-style string containing the names and descriptions of all of the node's child datatypes Parameters ---------- indent : int Leading indent of the string Returns ------- str

(self, indent=12)

        return bool([n for n in self.children if n.plotly_name == name])

    def get_constructor_params_docstring(self, indent=12):
        """
        Return a docstring-style string containing the names and
        descriptions of all of the node's child datatypes

        Parameters
        ----------
        indent : int
            Leading indent of the string

        Returns
        -------
        str
        """
        assert self.is_compound

        buffer = StringIO()

        subtype_nodes = self.child_datatypes
        for subtype_node in subtype_nodes:
            raw_description = subtype_node.description
            if raw_description:
                subtype_description = raw_description
            elif subtype_node.is_array_element:
                if (
                    self.name_datatype_class == "Data"
                    and self.parent
                    and self.parent.name_datatype_class == "Template"
                ):
                    class_name = (
                        f"plotly.graph_objects.{subtype_node.name_datatype_class}"
                    )
                else:
                    class_name = (
                        f"plotly.graph_objects"
                        f"{subtype_node.parent_dotpath_str}."
                        f"{subtype_node.name_datatype_class}"
                    )
                subtype_description = (
                    f"A tuple of :class:`{class_name}` instances or "
                    "dicts with compatible properties"
                )
            elif subtype_node.is_compound:
                if (
                    subtype_node.name_datatype_class == "Layout"
                    and self.name_datatype_class == "Template"
                ):
                    class_name = "plotly.graph_objects.Layout"
                else:
                    class_name = (
                        f"plotly.graph_objects"
                        f"{subtype_node.parent_dotpath_str}."
                        f"{subtype_node.name_datatype_class}"
                    )

                subtype_description = (
                    f":class:`{class_name}` instance or dict with compatible properties"
                )