usov_i-org/bec
1
0
Fork 0
mirror of https://github.com/ivan-usov-org/bec.git synced 2025-04-22 02:20:02 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: add ipython magic to print metadata for a scan

Browse Source
This commit is contained in:
perl_d 2025-02-10 12:14:35 +01:00
parent 7efdbbf6d4
commit c55eb42c7a
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
bec_ipython_client/bec_ipython_client/bec_magics.py
View File

@ -2,8 +2,11 @@ from __future__ import annotations
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
import rich
from IPython.core.magic import Magics, line_magic, magics_class from IPython.core.magic import Magics, line_magic, magics_class
from bec_lib.metadata_schema import get_metadata_schema_for_scan
if TYPE_CHECKING: if TYPE_CHECKING:
from bec_ipython_client import BECIPythonClient from bec_ipython_client import BECIPythonClient
@ -58,3 +61,12 @@ class BECMagics(Magics):
def halt(self, line): def halt(self, line):
"Request a scan halt, i.e. abort without cleanup." "Request a scan halt, i.e. abort without cleanup."
return self.client.queue.request_scan_halt() return self.client.queue.request_scan_halt()
@line_magic
def schema(self, line):
"print the metadata schema for a given scan"
scans = self.shell.user_ns["scans"]
if not hasattr(scans, line):
print(f"Scan {line} does not exist.")
else:
rich.print_json(data=get_metadata_schema_for_scan(line).model_json_schema())