Add array_ok to SubplotidValidator, used in pie.legend #5465
+92
−16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Author
|
FYI @camdecoster @emilykl |
camdecoster
requested changes
Jan 12, 2026
Contributor
camdecoster
left a comment
camdecoster
left a comment
There was a problem hiding this comment.
This looks good, but there a few small changes to make. Thanks for the PR!
Comment on lines
1763
to
1768
| desc = """\ | ||
| The '{plotly_name}' property is an identifier of a particular | ||
| subplot, of type '{base}', that may be specified as the string '{base}' | ||
| optionally followed by an integer >= 1 | ||
| (e.g. '{base}', '{base}1', '{base}2', '{base}3', etc.) | ||
| """.format(plotly_name=self.plotly_name, base=self.base) |
Contributor
There was a problem hiding this comment.
You can remove this code since you redefined it below.
Suggested change
Comment on lines
+1773
to
+1775
| - the string '{base}' | ||
| optionally followed by an integer >= 1 | ||
| (e.g. '{base}', '{base}1', '{base}2', '{base}3', etc.)""".format( |
Contributor
There was a problem hiding this comment.
Suggested change
| - the string '{base}' | |
| optionally followed by an integer >= 1 | |
| (e.g. '{base}', '{base}1', '{base}2', '{base}3', etc.)""".format( | |
| - the string '{base}' optionally followed by an integer >= 1 | |
| (e.g. '{base}', '{base}1', '{base}2', '{base}3', etc.)""".format( |
Comment on lines
1737
to
1738
| "otherOpts": [ | ||
| "regex" |
Contributor
There was a problem hiding this comment.
Suggested change
| "otherOpts": [ | |
| "arrayOk", | |
| "regex" |
Comment on lines
+1784
to
+1800
| def coerce(value, invalid_els): | ||
| if not isinstance(value, str): | ||
| invalid_els.append(value) | ||
| return value | ||
| match = fullmatch(self.regex, value) | ||
| if not match: | ||
| is_valid = False | ||
| invalid_els.append(value) | ||
| return value | ||
| else: | ||
| digit_str = match.group(1) | ||
| if len(digit_str) > 0 and int(digit_str) == 0: | ||
| is_valid = False | ||
| invalid_els.append(value) | ||
| return value | ||
| elif len(digit_str) > 0 and int(digit_str) == 1: | ||
| # Remove 1 suffix (e.g. x1 -> x) | ||
| v = self.base | ||
| is_valid = True | ||
| return self.base | ||
| else: | ||
| is_valid = True | ||
| return value |
Contributor
There was a problem hiding this comment.
I think it would make more sense to refactor this function to just check if the given input is a valid id. Then you could reference that in the if/then block. It feels weird to define invalid_els for the single value case.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update
SubplotidValidatorto handle arrays of values.Additional fix for closing #5463.
Changes
Handle arrays in
SubplotidValidatorAdded array_ok tests
Testing
Be on main
Run the following code:
Note that a
ValueErroris raisedSwitch to this branch
Run the same code again
Note that chart is rendered correctly
Disclaimer
I am required to add that…the software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. in no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.