-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Use attach_session_metadata decorator #16
Open
keithralphs
wants to merge
4
commits into
main
Choose a base branch
from
metadata_decorator
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,9 @@ | ||
from typing import Any, List, Mapping, Optional, Union | ||
|
||
import bluesky.plans as bp | ||
import bluesky.preprocessors as bpp | ||
from bluesky.protocols import Readable | ||
from dodal.plans.data_session_metadata import attach_data_session_metadata_decorator | ||
|
||
from dls_bluesky_core.core import MsgGenerator | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should import this from dodal.common.types too while we're at it |
||
|
||
|
@@ -14,37 +16,34 @@ def count( | |
detectors: List[Readable], | ||
num: int = 1, | ||
delay: Optional[Union[float, List[float]]] = None, | ||
baseline: Optional[List[Readable]] = None, | ||
metadata: Optional[Mapping[str, Any]] = None, | ||
) -> MsgGenerator: | ||
""" | ||
Take `n` readings from a device | ||
|
||
Args: | ||
detectors (List[Readable]): Readable devices to read | ||
num (int, optional): Number of readings to take. Defaults to 1. | ||
delay (Optional[Union[float, List[float]]], optional): Delay between readings. | ||
Defaults to None. | ||
metadata (Optional[Mapping[str, Any]], optional): Key-value metadata to include | ||
in exported data. | ||
Defaults to None. | ||
num (int): Number of readings to take. Defaults to 1. | ||
delay (Optional[Union[float, List[float]]]): Delay between readings. | ||
Defaults to None. | ||
baseline (Optional[List[Readable]]): List of devices to read at start | ||
and end of scan | ||
metadata (Optional[Mapping[str, Any]]): Key-value metadata to include | ||
in exported data. | ||
Defaults to None. | ||
|
||
Returns: | ||
MsgGenerator: _description_ | ||
|
||
Yields: | ||
Iterator[MsgGenerator]: _description_ | ||
""" | ||
plan_args = ( | ||
{ # If bp.count added delay to plan_args, we could remove all md handling | ||
"detectors": list(map(repr, detectors)), | ||
"num": num, | ||
"delay": delay, | ||
} | ||
) | ||
|
||
_md = { | ||
"plan_args": plan_args, | ||
**(metadata or {}), | ||
} | ||
|
||
yield from bp.count(detectors, num, delay=delay, md=_md) | ||
baseline = baseline or [] | ||
|
||
@bpp.baseline_decorator(baseline) | ||
@attach_data_session_metadata_decorator(provider=None) | ||
def inner_plan() -> MsgGenerator: | ||
yield from bp.count(detectors, num, delay=delay, md=metadata) | ||
|
||
yield from inner_plan() |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally I'd like the dropping 3.9 changes in a separate PR