Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Handle extras option in IntegerValidator #4612

Merged
merged 3 commits into from
Jul 3, 2024
Merged

Handle extras option in IntegerValidator #4612

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1522cd
handle extras in IntegerValidator
archmoj May 17, 2024
c0a7757
Update CHANGELOG.md
LiamConnors Jun 13, 2024
751092e
Merge branch 'master' into handle-extras-integer-validator
archmoj Jul 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 30 additions & 3 deletions packages/python/plotly/_plotly_utils/basevalidators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -824,13 +824,21 @@ class IntegerValidator(BaseValidator):
"dflt",
"min",
"max",
"extras",
"arrayOk"
]
},
"""

def __init__(
self, plotly_name, parent_name, min=None, max=None, array_ok=False, **kwargs
self,
plotly_name,
parent_name,
min=None,
max=None,
extras=None,
array_ok=False,
**kwargs,
):
super(IntegerValidator, self).__init__(
plotly_name=plotly_name, parent_name=parent_name, **kwargs
Expand All @@ -855,6 +863,7 @@ def __init__(
else:
self.has_min_max = False

self.extras = extras if extras is not None else []
self.array_ok = array_ok

def description(self):
Expand All @@ -878,6 +887,16 @@ def description(self):
)
)

# Extras
if self.extras:
desc = (
desc
+ (
"""
OR exactly one of {extras} (e.g. '{eg_extra}')"""
).format(extras=self.extras, eg_extra=self.extras[-1])
)

if self.array_ok:
desc = (
desc
Expand All @@ -891,6 +910,8 @@ def validate_coerce(self, v):
if v is None:
# Pass None through
pass
elif v in self.extras:
return v
elif self.array_ok and is_homogeneous_array(v):
np = get_module("numpy")
v_array = copy_to_readonly_numpy_array(
Expand All @@ -917,14 +938,20 @@ def validate_coerce(self, v):
v = v_array
elif self.array_ok and is_simple_array(v):
# Check integer type
invalid_els = [e for e in v if not isinstance(e, int)]
invalid_els = [
e for e in v if not isinstance(e, int) and e not in self.extras
]

if invalid_els:
self.raise_invalid_elements(invalid_els[:10])

# Check min/max
if self.has_min_max:
invalid_els = [e for e in v if not (self.min_val <= e <= self.max_val)]
invalid_els = [
e
for e in v
if not (self.min_val <= e <= self.max_val) and e not in self.extras
]

if invalid_els:
self.raise_invalid_elements(invalid_els[:10])
Expand Down