Ecs 6432 Add ability to ignore specific upstream devices in load #392
Conversation
This file contains 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
… string of device names to exclude when loading. Added try-except for 'exclude_devices'. Pass exclude_devices as a list to get_happi_objs function.
…ient.search() results and removes devices that should not be loaded.
…y the results variable.
…ef get_happi_objs() to avoid mutable default arguments issue.
…moval of devices that shouldn't be loaded.
tangkong
reviewed
Nov 2, 2024
...oming_release_notes/297-ECS-6432_Add_ability_to_ignore_specific_upstream_devices_in_load.rst
Outdated
Show resolved
Hide resolved
ZLLentz
reviewed
Nov 2, 2024
ZLLentz
reviewed
Nov 2, 2024
|
I agree that this looks good overall |
Co-authored-by: Zachary Lentz <ZLLentz@users.noreply.github.com>
…ulti-line array of strings or an actual list.
…nd test_happi_objs_with_exclude_devices() into one test.
|
Ah sorry one last thing: could you document the proper yaml setup in the https://github.com/pcdshub/hutch-python/blob/master/docs/source/yaml_files.rst There's been some back and forth as to how we specify these excluded devices and it'll be good to explicitly document this. |
ZLLentz
previously approved these changes
Nov 5, 2024
|
Updated yaml_files.rst. I think everything looks good. |
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.
Added a new feature that lets hutches exclude specific upstream devices when loading.
Description
Refactored parts of
get_happi_objs()function, so it's only necessary to check thecontainersvariable once at the end of the function and removed specific upstream devices fromcontainers.Motivation and Context
Allows user to exclude specific upstream devices when loading, so they don't need to see irrelevant information.
https://jira.slac.stanford.edu/browse/ECS-6432
How Has This Been Tested?
Tested manually and with unit tests.
Where Has This Been Documented?
In release notes.
Pre-merge checklist
docs/pre-release-notes.shand created a pre-release documentation page