bec-ipython-client 3.77.0__py3-none-any.whl → 3.78.0__py3-none-any.whl

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_ipython_client
-Version: 3.77.0
+Version: 3.78.0
 Summary: BEC IPython client
 Project-URL: Bug Tracker, https://github.com/bec-project/bec/issues
 Project-URL: Homepage, https://github.com/bec-project/bec

bec_ipython_client/callbacks/device_progress.py

@@ -14,11 +14,16 @@ class LiveUpdatesDeviceProgress(LiveUpdatesTable):
 
     REPORT_TYPE = "device_progress"
 
-    def _run_update(self, device_names: str):
+    def core(self):
+        """core function to run the live updates for the table"""
+        self._wait_for_report_instructions()
+        self._run_update(self.report_instruction[self.REPORT_TYPE])
+
+    def _run_update(self, device_names: list[str]):
         """Run the update loop for the progress bar.
 
         Args:
-            device_names (str): The name of the device to monitor.
+            device_names (list[str]): The name of the device to monitor.
         """
         with ScanProgressBar(
             scan_number=self.scan_item.scan_number, clear_on_exit=False
@@ -29,7 +34,7 @@ class LiveUpdatesDeviceProgress(LiveUpdatesTable):
                 self._print_client_msgs_asap()
         self._print_client_msgs_all()
 
-    def _update_progressbar(self, progressbar: ScanProgressBar, device_names: str) -> bool:
+    def _update_progressbar(self, progressbar: ScanProgressBar, device_names: list[str]) -> bool:
         """Update the progressbar based on the device status message
 
         Args:

bec_ipython_client/callbacks/live_table.py

@@ -171,6 +171,13 @@ class LiveUpdatesTable(LiveUpdatesBase):
 
     def core(self):
         """core function to run the live updates for the table"""
+        self._wait_for_report_instructions()
+        show_table = self.report_instruction[self.REPORT_TYPE].get("show_table", True)
+        self._print_table_data = show_table
+        self._run_update(self.report_instruction[self.REPORT_TYPE]["points"])
+
+    def _wait_for_report_instructions(self):
+        """wait until the report instructions are available"""
         req_ID = self.scan_queue_request.requestID
         while True:
             request_block = [
@@ -182,10 +189,6 @@ class LiveUpdatesTable(LiveUpdatesBase):
                 break
             self.check_alarms()
 
-        show_table = self.report_instruction[self.REPORT_TYPE].get("show_table", True)
-        self._print_table_data = show_table
-        self._run_update(self.report_instruction[self.REPORT_TYPE]["points"])
-
     def _run_update(self, target_num_points: int):
         """run the update loop with the progress bar
 

bec_ipython_client/main.py

@@ -1,4 +1,8 @@
+from __future__ import annotations
+
 import argparse
+import collections
+import functools
 import os
 import sys
 from importlib.metadata import version
@@ -7,16 +11,17 @@ from typing import Iterable, Literal, Tuple
 import IPython
 import redis
 import redis.exceptions
-import requests
 from IPython.terminal.ipapp import TerminalIPythonApp
 from IPython.terminal.prompts import Prompts, Token
+from rich.console import Console
+from rich.panel import Panel
+from rich.text import Text
 
 from bec_ipython_client.beamline_mixin import BeamlineMixin
 from bec_ipython_client.bec_magics import BECMagics
 from bec_ipython_client.callbacks.ipython_live_updates import IPythonLiveUpdates
 from bec_ipython_client.signals import ScanInterruption, SigintHandler
 from bec_lib import plugin_helper
-from bec_lib.acl_login import BECAuthenticationError
 from bec_lib.alarm_handler import AlarmBase
 from bec_lib.bec_errors import DeviceConfigError
 from bec_lib.bec_service import parse_cmdline_args
@@ -79,6 +84,7 @@ class BECIPythonClient:
         self._client.callbacks.register(
             event_type=EventType.NAMESPACE_UPDATE, callback=self._update_namespace_callback
         )
+        self._alarm_history = collections.deque(maxlen=100)
 
     def __getattr__(self, name):
         return getattr(self._client, name)
@@ -136,7 +142,7 @@ class BECIPythonClient:
         self._refresh_ipython_username()
         self._load_magics()
         self._ip.events.register("post_run_cell", log_console)
-        self._ip.set_custom_exc((Exception,), _ip_exception_handler)  # register your handler
+        self._ip.set_custom_exc((Exception,), self._create_exception_handler())
         # represent objects using __str__, if overwritten, otherwise use __repr__
         self._ip.display_formatter.formatters["text/plain"].for_type(
             object,
@@ -187,10 +193,63 @@ class BECIPythonClient:
             pass
         self._client.shutdown()
 
+    def _create_exception_handler(self):
+        return functools.partial(_ip_exception_handler, parent=self)
 
-def _ip_exception_handler(self, etype, evalue, tb, tb_offset=None):
-    if issubclass(etype, (AlarmBase, ScanInterruption, DeviceConfigError)):
-        print(f"\x1b[31m BEC alarm:\x1b[0m {evalue}")
+    def show_last_alarm(self, offset: int = 0):
+        """
+        Show the last alarm raised in this session with rich formatting.
+        """
+        try:
+            alarm: AlarmBase = self._alarm_history[-1 - offset][1]
+        except IndexError:
+            print("No alarm has been raised in this session.")
+            return
+
+        console = Console()
+
+        # --- HEADER ---
+        header = Text()
+        header.append("Alarm Raised\n", style="bold red")
+        header.append(f"Severity: {alarm.severity.name}\n", style="bold")
+        header.append(f"Type: {alarm.alarm_type}\n", style="bold")
+        if alarm.alarm.source.get("device"):
+            header.append(f"Device: {alarm.alarm.source['device']}\n", style="bold")
+
+        console.print(Panel(header, title="Alarm Info", border_style="red", expand=False))
+
+        # --- SHOW SUMMARY
+        if alarm.alarm.compact_msg:
+            console.print(
+                Panel(
+                    Text(alarm.alarm.compact_msg, style="yellow"),
+                    title="Summary",
+                    border_style="yellow",
+                    expand=False,
+                )
+            )
+
+        # --- SHOW FULL TRACEBACK
+        tb_str = alarm.alarm.msg
+        if tb_str:
+            try:
+                console.print(tb_str)
+            except Exception:
+                # fallback in case msg is not a traceback
+                console.print(Panel(tb_str, title="Message", border_style="cyan"))
+
+
+def _ip_exception_handler(
+    self, etype, evalue, tb, tb_offset=None, parent: BECIPythonClient = None, **kwargs
+):
+    if issubclass(etype, AlarmBase):
+        parent._alarm_history.append((etype, evalue, tb, tb_offset))
+        print("\x1b[31m BEC alarm:\x1b[0m")
+        evalue.pretty_print()
+        print("For more details, use 'bec.show_last_alarm()'")
+        return
+    if issubclass(etype, (ScanInterruption, DeviceConfigError)):
+        print(f"\x1b[31m {evalue.__class__.__name__}:\x1b[0m {evalue}")
         return
     if issubclass(etype, redis.exceptions.NoPermissionError):
         # pylint: disable=protected-access

{bec_ipython_client-3.77.0.dist-info → bec_ipython_client-3.78.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_ipython_client
-Version: 3.77.0
+Version: 3.78.0
 Summary: BEC IPython client
 Project-URL: Bug Tracker, https://github.com/bec-project/bec/issues
 Project-URL: Homepage, https://github.com/bec-project/bec

{bec_ipython_client-3.77.0.dist-info → bec_ipython_client-3.78.0.dist-info}/RECORD

@@ -1,19 +1,19 @@
 .gitignore,sha256=XxC6jyyftTo2CLtm4K8axuNPYwA9Wgaz2R93WhX8bTQ,3364
-PKG-INFO,sha256=kEsaWm0XSawsU8btTo-SyPnXeSFf_jXcDi3vmFZEdds,1052
+PKG-INFO,sha256=RJxXzCYV3zYrykWuJBQir3qMUpj_91SSeW9VqsG-WWQ,1052
 demo.py,sha256=AquJB-0Tu2bIEFpcJ0Q3RUBt1xldqS6GgU5CjOAg_ww,7083
-pyproject.toml,sha256=RVAsp1s-QQRo5cdPW9BS7fozezKy4CG9EuhiBUrSM80,1229
+pyproject.toml,sha256=RXan6rptFvdX9lpzL3DvMM5kDp3D-STl3flmWy4GwQo,1229
 bec_ipython_client/__init__.py,sha256=ihd_V8I7Qo0MWKMo7bcvPf-ZyUQqkcNf8IAWLJKiFJE,79
 bec_ipython_client/beamline_mixin.py,sha256=scMWIFbHJajyECzbwEVKyQUGjpqA9C_KiU2M6FuRH_Q,1067
 bec_ipython_client/bec_magics.py,sha256=Rz2aXkUCeAV_VxdXqLUNHh8T44kSH9ha83OiEtdptzI,2792
 bec_ipython_client/bec_startup.py,sha256=GGlHyxnSCQfYF5n-pYq2ic0pSyW5zvnT2PAlI5kY77w,1930
-bec_ipython_client/main.py,sha256=OQeDX1XxavvKo-0lpM8-Pd8tkMIS09DG7fqeCjsIEHw,11237
+bec_ipython_client/main.py,sha256=PzKLA5BNze_TTDrmMo0tYxvcwez9cFIOVB68nMbOOdU,13275
 bec_ipython_client/prettytable.py,sha256=TnhGPGuU0XEvnIYJ1UfTEwadcowFW4rqJW8z_Sm0EDw,2534
 bec_ipython_client/progressbar.py,sha256=aDKYjzXmGSwa82ewm59V8WSuqVQz9GiZPx5G65fEwpk,11090
 bec_ipython_client/signals.py,sha256=mbThPo6h3mQ6RFRm9viETDMC_unFa7QxiymCdM_ZK7U,4194
 bec_ipython_client/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_ipython_client/callbacks/device_progress.py,sha256=5sYfk4Xr_4-NCs6lCe7o7nTpMs_sEFYwITAMaELlbOA,2385
+bec_ipython_client/callbacks/device_progress.py,sha256=NzWIO1oowxpN14hPXBne6RfZxOW82EhwDM3jHLnn3xI,2603
 bec_ipython_client/callbacks/ipython_live_updates.py,sha256=Cx62yJSzIcRvAA_lC86PSs8825hJtk22yBPhuJjgRPc,10520
-bec_ipython_client/callbacks/live_table.py,sha256=pUoqg2ib43-XpqRpjtahpUnnsriNYzLtF3IiAiVkGxg,13350
+bec_ipython_client/callbacks/live_table.py,sha256=3qmwCEjqe-xFqo3Ez2dhKchawlr0cOmNgzpg857-gp0,13503
 bec_ipython_client/callbacks/move_device.py,sha256=TkbtKFBr1nuJ8THTSm70Y8D7_va2YQ57oBGGt0BavW4,8153
 bec_ipython_client/callbacks/utils.py,sha256=jS92ndZNU2t5n9FsLrSbulmUIeepHhwdQdfO60YjiJk,5702
 bec_ipython_client/high_level_interfaces/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -28,7 +28,7 @@ bec_ipython_client/plugins/flomni/flomni_config.yaml,sha256=bCN1VKCzF6tw24HYeUE2
 tests/conftest.py,sha256=4yzGYqs8EVOxxY9Bu-yGbzmOpzG9dxs3cwSCzjmRziQ,233
 tests/client_tests/conftest.py,sha256=dUvYqvl6wogxN-kRCUuo_Uzna3P2uSYD7qGHyMGBlPY,413
 tests/client_tests/test_beamline_mixins.py,sha256=8Ws0bmzl2gSW0VuOVu80_JbYNb5Y-htchmrrptwjwDo,4611
-tests/client_tests/test_bec_client.py,sha256=pMpjDpgdeynHMJXZkXCMYERm5OEwu4VR50ID28eNFhc,7722
+tests/client_tests/test_bec_client.py,sha256=KJePnvUc1I5218qaCEcIExEGSB_D-v17irarv6Ix994,8832
 tests/client_tests/test_device_progress.py,sha256=GEw2g8MQZnv5mxABEZlxBmaMpxVS33wogaYohFolDEs,2353
 tests/client_tests/test_ipython_live_updates.py,sha256=HpA16Mx0WdseqlfP0FojlAd6VfvjnwAUReDkItZVYWs,6081
 tests/client_tests/test_live_table.py,sha256=0EKgWOgDqpjN8fJEeAzoKNCwFneDEsUY2NfWQkxB6xc,18155
@@ -38,7 +38,7 @@ tests/end-2-end/_ensure_requirements_container.py,sha256=RT2a5cUZnXtMjJRlPImGzgy
 tests/end-2-end/test_procedures_e2e.py,sha256=3CPzjW3VpsSU8GKVP814SSvLZ0c7bBtPB_VtX725TCY,4737
 tests/end-2-end/test_scans_e2e.py,sha256=CxlXjQrzDJebaoZObt_oYx41wbnHLuJLSjKlno4u2B4,30981
 tests/end-2-end/test_scans_lib_e2e.py,sha256=-yYW-bm2jmXg4QYa6jSQFRlaLa81zeUvP7oTodccWg0,19213
-bec_ipython_client-3.77.0.dist-info/METADATA,sha256=kEsaWm0XSawsU8btTo-SyPnXeSFf_jXcDi3vmFZEdds,1052
-bec_ipython_client-3.77.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-bec_ipython_client-3.77.0.dist-info/entry_points.txt,sha256=oQUXYY0jjD9ZvKPHwaGn2wkUIWpDZM8L4ixDA3RlBWE,53
-bec_ipython_client-3.77.0.dist-info/RECORD,,
+bec_ipython_client-3.78.0.dist-info/METADATA,sha256=RJxXzCYV3zYrykWuJBQir3qMUpj_91SSeW9VqsG-WWQ,1052
+bec_ipython_client-3.78.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+bec_ipython_client-3.78.0.dist-info/entry_points.txt,sha256=oQUXYY0jjD9ZvKPHwaGn2wkUIWpDZM8L4ixDA3RlBWE,53
+bec_ipython_client-3.78.0.dist-info/RECORD,,

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_ipython_client"
-version = "3.77.0"
+version = "3.78.0"
 description = "BEC IPython client"
 requires-python = ">=3.11"
 classifiers = [

tests/client_tests/test_bec_client.py

@@ -7,6 +7,7 @@ import pytest
 
 from bec_ipython_client import BECIPythonClient, main
 from bec_lib import messages
+from bec_lib.alarm_handler import AlarmBase, AlarmHandler, Alarms
 from bec_lib.redis_connector import RedisConnector
 from bec_lib.service_config import ServiceConfig
 
@@ -211,3 +212,33 @@ def test_bec_ipython_client_property_access(ipython_client):
                         client.active_account = "account"
                     with pytest.raises(AttributeError):
                         client._client.active_account = "account"
+
+
+def test_bec_ipython_client_show_last_alarm(ipython_client, capsys):
+    client = ipython_client
+    alarm_msg = messages.AlarmMessage(
+        severity=Alarms.MAJOR,
+        alarm_type="TestAlarm",
+        source={},
+        msg="This is a test alarm",
+        compact_msg="Test alarm",
+    )
+    client.alarm_handler = AlarmHandler(connector=mock.MagicMock())
+    client.alarm_handler.add_alarm(alarm_msg)
+    client._alarm_history.append(
+        (AlarmBase, client.alarm_handler.get_unhandled_alarms()[0], None, None)
+    )
+    client.show_last_alarm()
+    captured = capsys.readouterr()
+    assert "Alarm Raised" in captured.out
+    assert "Severity: MAJOR" in captured.out
+    assert "Type: TestAlarm" in captured.out
+    assert "This is a test alarm" in captured.out
+
+
+def test_bec_ipython_client_show_last_no_alarm(ipython_client, capsys):
+    client = ipython_client
+    client._alarm_history = []
+    client.show_last_alarm()
+    captured = capsys.readouterr()
+    assert "No alarm has been raised in this session." in captured.out