Method get_validator_params

codegen/utils.py:429–485

Get kwargs to pass to the constructor of this node's validator superclass. Returns ------- dict The keys are strings matching the names of the constructor params of this node's validator superclass. The values are repr-str

(self)

    # Validators
    def get_validator_params(self):
        """
        Get kwargs to pass to the constructor of this node's validator
        superclass.

        Returns
        -------
        dict
            The keys are strings matching the names of the constructor
            params of this node's validator superclass. The values are
            repr-strings of the values to be passed to the constructor.
            These values are ready to be used to code generate calls to the
            constructor. The values should be evald before being passed to
            the constructor directly.

        """
        params = {
            "plotly_name": repr(self.name_property),
            "parent_name": repr(self.parent_path_str),
        }

        if self.is_compound:
            params["data_class_str"] = repr(self.name_datatype_class)
            params["data_docs"] = '"""\n"""'
        else:
            assert self.is_simple

            # Exclude general properties
            excluded_props = ["valType", "description", "dflt"]
            if self.datatype == "subplotid":
                # Default is required for subplotid validator
                excluded_props.remove("dflt")

            attr_nodes = [
                n for n in self.simple_attrs if n.plotly_name not in excluded_props
            ]

            for node in attr_nodes:
                params[node.name_undercase] = repr(node.node_data)

            # Add extra properties
            if self.datatype == "color" and self.parent:
                # Check for colorscale sibling. We use the presence of a
                # colorscale sibling to determine whether numeric color
                # values are permissible
                colorscale_node_list = [
                    node
                    for node in self.parent.child_datatypes
                    if node.datatype == "colorscale"
                ]
                if colorscale_node_list:
                    colorscale_path = colorscale_node_list[0].path_str
                    params["colorscale_path"] = repr(colorscale_path)
            elif self.datatype == "literal":
                params["val"] = self.node_data

        return params