bec-ipython-client 3.77.1__tar.gz → 3.78.1__tar.gz

{bec_ipython_client-3.77.1 → bec_ipython_client-3.78.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_ipython_client
-Version: 3.77.1
+Version: 3.78.1
 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.1 → bec_ipython_client-3.78.1}/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.1 → bec_ipython_client-3.78.1}/pyproject.toml

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

{bec_ipython_client-3.77.1 → bec_ipython_client-3.78.1}/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