Skip to content

fix: Check plan outcome when calling Plan objects #1470

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.

Sign up for GitHub

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

Draft
tpoliaw wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: Check plan outcome when calling Plan objects #1470

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions src/blueapi/client/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from functools import cached_property
from itertools import chain
from pathlib import Path
from typing import Self
from typing import Any, Self

from bluesky_stomp.messaging import MessageContext, StompClient
from bluesky_stomp.models import Broker
Expand Down Expand Up @@ -38,7 +38,7 @@
)
from blueapi.utils import deprecated
from blueapi.worker import WorkerEvent, WorkerState
from blueapi.worker.event import ProgressEvent, TaskStatus
from blueapi.worker.event import ProgressEvent, TaskError, TaskResult, TaskStatus
from blueapi.worker.task_worker import TrackableTask

from .event_bus import AnyEvent, EventBusClient, OnAnyEvent
Expand Down Expand Up @@ -141,13 +141,17 @@ def __init__(self, name, model: PlanModel, client: "BlueapiClient"):
self._client = client
self.__doc__ = model.description

def __call__(self, *args, **kwargs):
def __call__(self, *args, **kwargs) -> Any:
req = TaskRequest(
name=self.name,
params=self._build_args(*args, **kwargs),
instrument_session=self._client.instrument_session,
)
self._client.run_task(req)
match self._client.run_task(req):
case TaskStatus(result=TaskResult(result=res)):
return res
case TaskStatus(result=TaskError(type=typ, message=msg)):
raise PlanFailedError(typ, msg)

@property
def help_text(self) -> str:
Expand Down Expand Up @@ -744,3 +748,9 @@ def login(self, token_path: Path | None = None):
auth.start_device_flow()
else:
print("Server is not configured to use authentication!")


class PlanFailedError(Exception):
def __init__(self, typ: str, message: str):
super().__init__(message)
self._type = typ
Loading