Add is_instance attribute to the List Parameter #1023
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1023 +/- ##
==========================================
+ Coverage 87.25% 87.28% +0.02%
==========================================
Files 9 9
Lines 4928 4946 +18
==========================================
+ Hits 4300 4317 +17
- Misses 628 629 +1 ☔ View full report in Codecov by Sentry. |
jlstevens
reviewed
Feb 19, 2025
doc/user_guide/Parameter_Types.ipynb
Outdated
| "- `param.HookList`: A list of callable objects, for executing user-defined code at some processing stage\n", | ||
| "\n", | ||
| "List Parameters accept a Python list of objects. Typically the `item_type` will be specified for those objects, so that the rest of the code does not have to further check types when it refers to those values. Where appropriate, the `bounds` of the list can be set as (_min_length_, _max_length_), defaulting to `(0,None)`. Because List parameters already have an empty value ([]), they do not support `allow_None`.\n", | ||
| "List Parameters accept a Python list of objects. Typically the `item_type` will be specified for those objects, so that the rest of the code does not have to further check types when it refers to those values. Where appropriate, the `bounds` of the list can be set as (_min_length_, _max_length_), defaulting to `(0,None)`. Because List parameters already have an empty value ([]), they do not support `allow_None`. `is_isntance` defaults to `True` and can be set to `False` to declare the objects must be subclasses of `item_type`.\n", |
jlstevens
approved these changes
Feb 19, 2025
Contributor
jlstevens
left a comment
jlstevens
left a comment
There was a problem hiding this comment.
Other than the typo, looks good to me!
I am wondering if there are any other collection parameter types that should support is_instance but do not. Nothing comes immediately to mind....
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #868