Convert magnet to use pydantic model #104
Merged
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
…ng. Can extract by area
…automatic_yaml_generation
…tKing06/lcls-tools into 92_automatic_yaml_generation
…ctional changes to tests
nneveu
approved these changes
Nov 8, 2023
| frozen=True, | ||
| ) | ||
| ... | ||
|
|
| ) | ||
| with open(location, "r") as device_file: | ||
| config_data = yaml.safe_load(device_file) | ||
| if name: |
There was a problem hiding this comment.
Add comments here on default behavior and naming issue.
| metadata: | ||
| b_tolerance : 0.002 # in Tesla? | ||
| length : 0.135 # in meters? |
| def test_set_bdes_with_args(self, mock_trim, mock_bdes_put): | ||
| bdes_settings = { | ||
| "SOL1B": 0.1, | ||
| } |
There was a problem hiding this comment.
What happens if someone passes a dict with SOL1B not as a string/in quotes?
| self.assertIsNone(create_magnet(self.bad_config, "SOL1B")) | ||
| self.assertIsNone(create_magnet(area="GUNB", name="BAD-MAGNET-NAME")) | ||
|
|
||
| @patch( |
Derikka
pushed a commit
to Derikka/lcls-tools
that referenced
this pull request
Mar 17, 2024
* magnets and screen conversion from csv to dictionary structures working. Can extract by area * add functionality for extracting multiple areas at once * add PVs to yaml magnets extraction * removing unneeded file * working on adding image pvs to yaml files * working on image device code * flake8 and black formatting * make construction function self, add error handling for MEME timeout * formatting * make area a list in screens * add pv_info to screen construction * restrict wildcard search in meme * added models for magnet and associated fields * start to move magnet functions over to pydantic model * magnet pydantic model working with reader now * updated yaml test files to reflect new yaml for devices * magnet and reader tests up to date with pydantic changes, minimal functional changes to tests * make MagnetPVSet have frozen attributes.# * make MagnetPVSet have frozen attributes. * frozen for controls_information base class * missed return for area property! * add setter for bdes * working on being able to set bdes values for several mags * find file by area in reader * use area over location for scope * change yaml path. * remove path * first attempt at function to scan mags * magnet and device now using pydantic model * tests reflect model changes, need to check coverage * add check for function in scan * remove custom exception, pydantic handles mandatory information now * coverage up to 100% for each new class now * formatting * add pydantic to requirements * remove superceeded yaml * add comments for units in tolerance/length * add comment explaining adding name for device here --------- Co-authored-by: Neveu <[email protected]> Co-authored-by: Neveu <[email protected]> Co-authored-by: matt <[email protected]>
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.
Summary of Changes
Device and Magnet classes were originally constructed via dictionary loaded from yaml files. The majority of initialisation code was associated with type-checking, and ensuring that the correct information was defined inside the dictionary passed to the constructor.
It was found that Pydantic models can achieve the same effect and do better at type-enforcement/field-enforcement as well as simplifying the code that defines the class architecture for our devices.
Tests
The user-facing side of these changes now allow us to write code for interfacing with devices like below:
closes #100