Added new SrcValidator base class for src properties (e.g. xsrc)

This validator accepts plotly.grid_objs.Column objects along with strings

Author: jonmmease

_plotly_utils/basevalidators.py

@@ -519,6 +519,33 @@ def validate_coerce(self, v):
         return v
 
 
+class SrcValidator(BaseValidator):
+
+    def __init__(self, plotly_name, parent_name, **kwargs):
+        super(SrcValidator, self).__init__(
+            plotly_name=plotly_name, parent_name=parent_name, **kwargs)
+
+    def description(self):
+        return ("""\
+    The '{plotly_name}' property must be specified as a string or
+    as a plotly.grid_objs.Column object""".format(plotly_name=self.plotly_name))
+
+    def validate_coerce(self, v):
+        from plotly.grid_objs import Column
+        if v is None:
+            # Pass None through
+            pass
+        elif isinstance(v, string_types):
+            pass
+        elif isinstance(v, Column):
+            # Convert to id string
+            v = v.id
+        else:
+            self.raise_invalid_val(v)
+
+        return v
+
+
 class NumberValidator(BaseValidator):
     """
         "number": {

codegen/utils.py

@@ -360,6 +360,9 @@ def name_base_validator(self) -> str:
         """
         if self.path_str in CUSTOM_VALIDATOR_DATATYPES:
             validator_base = f"{CUSTOM_VALIDATOR_DATATYPES[self.path_str]}"
+        elif self.plotly_name.endswith('src') and self.datatype == 'string':
+            validator_base = (f"_plotly_utils.basevalidators."
+                              f"SrcValidator")
         else:
             datatype_title_case = self.datatype.title().replace('_', '')
             validator_base = (f"_plotly_utils.basevalidators."

plotly/graph_objs/_area.py

@@ -33,9 +33,8 @@ def customdatasrc(self):
         """
         Sets the source reference on plot.ly for  customdata .
     
-        The 'customdatasrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'customdatasrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -80,9 +79,8 @@ def hoverinfosrc(self):
         """
         Sets the source reference on plot.ly for  hoverinfo .
     
-        The 'hoverinfosrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'hoverinfosrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -173,9 +171,8 @@ def idssrc(self):
         """
         Sets the source reference on plot.ly for  ids .
     
-        The 'idssrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'idssrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -333,9 +330,8 @@ def rsrc(self):
         """
         Sets the source reference on plot.ly for  r .
     
-        The 'rsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'rsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -453,9 +449,8 @@ def tsrc(self):
         """
         Sets the source reference on plot.ly for  t .
     
-        The 'tsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'tsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------

plotly/graph_objs/_bar.py

@@ -31,9 +31,8 @@ def basesrc(self):
         """
         Sets the source reference on plot.ly for  base .
     
-        The 'basesrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'basesrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -120,9 +119,8 @@ def customdatasrc(self):
         """
         Sets the source reference on plot.ly for  customdata .
     
-        The 'customdatasrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'customdatasrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -367,9 +365,8 @@ def hoverinfosrc(self):
         """
         Sets the source reference on plot.ly for  hoverinfo .
     
-        The 'hoverinfosrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'hoverinfosrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -464,9 +461,8 @@ def hovertextsrc(self):
         """
         Sets the source reference on plot.ly for  hovertext .
     
-        The 'hovertextsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'hovertextsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -507,9 +503,8 @@ def idssrc(self):
         """
         Sets the source reference on plot.ly for  ids .
     
-        The 'idssrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'idssrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -752,9 +747,8 @@ def offsetsrc(self):
         """
         Sets the source reference on plot.ly for  offset .
     
-        The 'offsetsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'offsetsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -891,9 +885,8 @@ def rsrc(self):
         """
         Sets the source reference on plot.ly for  r .
     
-        The 'rsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'rsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -1149,9 +1142,8 @@ def textpositionsrc(self):
         """
         Sets the source reference on plot.ly for  textposition .
     
-        The 'textpositionsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'textpositionsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -1170,9 +1162,8 @@ def textsrc(self):
         """
         Sets the source reference on plot.ly for  text .
     
-        The 'textsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'textsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -1191,9 +1182,8 @@ def tsrc(self):
         """
         Sets the source reference on plot.ly for  t .
     
-        The 'tsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'tsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -1305,9 +1295,8 @@ def widthsrc(self):
         """
         Sets the source reference on plot.ly for  width .
     
-        The 'widthsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'widthsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -1416,9 +1405,8 @@ def xsrc(self):
         """
         Sets the source reference on plot.ly for  x .
     
-        The 'xsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'xsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -1527,9 +1515,8 @@ def ysrc(self):
         """
         Sets the source reference on plot.ly for  y .
     
-        The 'ysrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'ysrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------

plotly/graph_objs/_box.py

@@ -82,9 +82,8 @@ def customdatasrc(self):
         """
         Sets the source reference on plot.ly for  customdata .
     
-        The 'customdatasrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'customdatasrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -190,9 +189,8 @@ def hoverinfosrc(self):
         """
         Sets the source reference on plot.ly for  hoverinfo .
     
-        The 'hoverinfosrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'hoverinfosrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -306,9 +304,8 @@ def idssrc(self):
         """
         Sets the source reference on plot.ly for  ids .
     
-        The 'idssrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'idssrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -710,9 +707,8 @@ def textsrc(self):
         """
         Sets the source reference on plot.ly for  text .
     
-        The 'textsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'textsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -910,9 +906,8 @@ def xsrc(self):
         """
         Sets the source reference on plot.ly for  x .
     
-        The 'xsrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'xsrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------
@@ -1020,9 +1015,8 @@ def ysrc(self):
         """
         Sets the source reference on plot.ly for  y .
     
-        The 'ysrc' property is a string and must be specified as:
-          - A string
-          - A number that will be converted to a string
+        The 'ysrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
 
         Returns
         -------