Skip to content

Commit a7d29c9

Browse files
committed
rename validate -> _validate to make property private
1 parent dec1209 commit a7d29c9

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

Diff for: packages/python/plotly/_plotly_utils/basevalidators.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -2438,12 +2438,12 @@ def description(self):
24382438

24392439
return desc
24402440

2441-
def validate_coerce(self, v, skip_invalid=False, validate=True):
2441+
def validate_coerce(self, v, skip_invalid=False, _validate=True):
24422442
if v is None:
24432443
v = self.data_class()
24442444

24452445
elif isinstance(v, dict):
2446-
v = self.data_class(v, skip_invalid=skip_invalid, validate=validate)
2446+
v = self.data_class(v, skip_invalid=skip_invalid, _validate=_validate)
24472447

24482448
elif isinstance(v, self.data_class):
24492449
# Copy object
@@ -2614,7 +2614,7 @@ def get_trace_class(self, trace_name):
26142614

26152615
return self._class_map[trace_name]
26162616

2617-
def validate_coerce(self, v, skip_invalid=False, validate=True):
2617+
def validate_coerce(self, v, skip_invalid=False, _validate=True):
26182618
from plotly.basedatatypes import BaseTraceType
26192619

26202620
# Import Histogram2dcontour, this is the deprecated name of the
@@ -2649,15 +2649,15 @@ def validate_coerce(self, v, skip_invalid=False, validate=True):
26492649
if skip_invalid:
26502650
# Treat as scatter trace
26512651
trace = self.get_trace_class("scatter")(
2652-
skip_invalid=skip_invalid, validate=validate, **v_copy
2652+
skip_invalid=skip_invalid, _validate=_validate, **v_copy
26532653
)
26542654
res.append(trace)
26552655
else:
26562656
res.append(None)
26572657
invalid_els.append(v_el)
26582658
else:
26592659
trace = self.get_trace_class(trace_type)(
2660-
skip_invalid=skip_invalid, validate=validate, **v_copy
2660+
skip_invalid=skip_invalid, _validate=_validate, **v_copy
26612661
)
26622662
res.append(trace)
26632663
else:

Diff for: packages/python/plotly/codegen/datatypes.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ def __init__(self"""
349349
# Handle skip_invalid
350350
# -------------------
351351
self._skip_invalid = kwargs.pop('skip_invalid', False)
352-
self._validate = kwargs.pop('validate', True)
352+
self._validate = kwargs.pop('_validate', True)
353353
"""
354354
)
355355

Diff for: packages/python/plotly/plotly/basedatatypes.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ class is a subclass of both BaseFigure and widgets.DOMWidget.
9292
super(BaseFigure, self).__init__()
9393

9494
# Initialize validation
95-
self._validate = kwargs.pop("validate", True)
95+
self._validate = kwargs.pop("_validate", True)
9696

9797
# Assign layout_plotly to layout
9898
# ------------------------------
@@ -143,7 +143,7 @@ class is a subclass of both BaseFigure and widgets.DOMWidget.
143143

144144
# ### Import traces ###
145145
data = self._data_validator.validate_coerce(
146-
data, skip_invalid=skip_invalid, validate=self._validate
146+
data, skip_invalid=skip_invalid, _validate=self._validate
147147
)
148148

149149
# ### Save tuple of trace objects ###
@@ -186,7 +186,7 @@ class is a subclass of both BaseFigure and widgets.DOMWidget.
186186

187187
# ### Import Layout ###
188188
self._layout_obj = self._layout_validator.validate_coerce(
189-
layout, skip_invalid=skip_invalid, validate=self._validate
189+
layout, skip_invalid=skip_invalid, _validate=self._validate
190190
)
191191

192192
# ### Import clone of layout properties ###

Diff for: packages/python/plotly/plotly/io/_templates.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ def __getitem__(self, item):
8888
)
8989
template_str = pkgutil.get_data("plotly", path).decode("utf-8")
9090
template_dict = json.loads(template_str)
91-
template = Template(template_dict, validate=False)
91+
template = Template(template_dict, _validate=False)
9292

9393
self._templates[template_name] = template
9494
templates.append(self._templates[template_name])

Diff for: packages/python/plotly/plotly/tests/test_core/test_graph_objs/test_validate.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ def test_validate_false():
2626
# Build figure with variety of invalid properties (both name and value),
2727
# make sure underscore notation is still applied properly
2828

29-
fig = go.Figure(validate=False, **build_invalid_fig())
29+
fig = go.Figure(_validate=False, **build_invalid_fig())
3030
assert json.loads(fig.to_json()) == expected_invalid_dict
3131

3232
with pytest.raises(ValueError):
33-
go.Figure(validate=True, **build_invalid_fig())
33+
go.Figure(_validate=True, **build_invalid_fig())
3434

3535
finally:
3636
pio.templates.default = template

0 commit comments

Comments
 (0)