bec-ipython-client 3.64.5__py3-none-any.whl → 3.89.3__py3-none-any.whl

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,24 +11,28 @@ 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 pydantic import ValidationError
+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
 from bec_lib.callback_handler import EventType
 from bec_lib.client import BECClient
 from bec_lib.logger import bec_logger
+from bec_lib.procedures.hli import ProcedureHli
 from bec_lib.redis_connector import RedisConnector
 from bec_lib.service_config import ServiceConfig
+from bec_lib.utils.pydantic_pretty_print import pretty_print_pydantic_validation_error
 
 logger = bec_logger.logger
 
@@ -51,6 +59,7 @@ class BECIPythonClient:
     # the CLIBECClient but directly through the BECIPythonClient. While this is not
     # needed for normal usage, it is required, e.g. for mocks.
     _local_only_types: Tuple = ()
+    _client: CLIBECClient | BECClient
 
     def __init__(
         self,
@@ -68,6 +77,7 @@ class BECIPythonClient:
             name="BECIPythonClient",
             prompt_for_acl=True,
         )
+
         self._ip = IPython.get_ipython()
         self.started = False
         self._sighandler = None
@@ -79,6 +89,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,12 +147,13 @@ 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,
             lambda o, p, cycle: o.__str__ is object.__str__ and p.text(repr(o)) or p.text(str(o)),
         )
+        self._set_idle()
 
     def _update_namespace_callback(self, action: Literal["add", "remove"], ns_objects: dict):
         """Callback to update the global namespace of ipython.
@@ -179,18 +191,75 @@ class BECIPythonClient:
         magics = BECMagics(self._ip, self)
         self._ip.register_magics(magics)
 
-    def shutdown(self):
+    def shutdown(self, per_thread_timeout_s: float | None = None):
         """shutdown the client and all its components"""
         try:
             self.gui.close()
         except AttributeError:
             pass
-        self._client.shutdown()
+        self._client.shutdown(per_thread_timeout_s)
+        logger.success("done")
+
+    def _create_exception_handler(self):
+        return functools.partial(_ip_exception_handler, parent=self)
 
+    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
 
-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}")
+        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.info.device:
+            header.append(f"Device: {alarm.alarm.info.device}\n", style="bold")
+
+        console.print(Panel(header, title="Alarm Info", border_style="red", expand=False))
+
+        # --- SHOW SUMMARY
+        if alarm.alarm.info.compact_error_message:
+            console.print(
+                Panel(
+                    Text(alarm.alarm.info.compact_error_message, style="yellow"),
+                    title="Summary",
+                    border_style="yellow",
+                    expand=False,
+                )
+            )
+
+        # --- SHOW FULL TRACEBACK
+        tb_str = alarm.alarm.info.error_message
+        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, ValidationError):
+        pretty_print_pydantic_validation_error(evalue)
+        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
@@ -220,9 +289,14 @@ class BECClientPrompt(Prompts):
             next_scan_number = str(self.client.queue.next_scan_number)
         except Exception:
             next_scan_number = "?"
+
+        if self.client.active_account:
+            username = f"{self.client.active_account} | {self.username}"
+        else:
+            username = self.username
         return [
             (status_led, "\u2022"),
-            (Token.Prompt, " " + self.username),
+            (Token.Prompt, " " + username),  # BEC ACL username and pgroup
             (Token.Prompt, "@" + self.session_name),
             (Token.Prompt, " ["),
             (Token.PromptNum, str(self.shell.execution_count)),
@@ -269,7 +343,6 @@ def main():
     parser = argparse.ArgumentParser(
         prog="BEC IPython client", description="BEC command line interface"
     )
-    parser.add_argument("--version", action="store_true", default=False)
     parser.add_argument("--nogui", action="store_true", default=False)
     parser.add_argument(
         "--gui-id",
@@ -289,10 +362,6 @@ def main():
     # remove already parsed args from command line args
     sys.argv = sys.argv[:1] + left_args
 
-    if args.version:
-        print(f"BEC IPython client: {version('bec_ipython_client')}")
-        sys.exit(0)
-
     if available_plugins and config.is_default():
         # check if config is defined in a plugin;
         # in this case the plugin config takes precedence over

bec_ipython_client/signals.py

@@ -1,9 +1,15 @@
+from __future__ import annotations
+
 import signal
 import threading
 import time
+from typing import TYPE_CHECKING
 
 from bec_lib.bec_errors import ScanInterruption
 
+if TYPE_CHECKING:  # pragma: no cover
+    from bec_lib.client import BECClient
+
 PAUSE_MSG = """
 The Scan Queue is entering a paused state. These are your options for changing
 the state of the queue:
@@ -73,7 +79,7 @@ class SignalHandler:
 
 
 class SigintHandler(SignalHandler):
-    def __init__(self, bec):
+    def __init__(self, bec: BECClient):
         super().__init__(signal.SIGINT)
         self.bec = bec
         self.last_sigint_time = None  # time most recent SIGINT was processed
@@ -84,11 +90,11 @@ class SigintHandler(SignalHandler):
         if not current_scan:
             raise KeyboardInterrupt
 
-        status = current_scan.get("status").lower()
+        status = current_scan.status.lower()
         if status not in ["running", "deferred_pause"]:
             raise KeyboardInterrupt
 
-        if any(current_scan.get("is_scan")) and (
+        if any(current_scan.is_scan) and (
             self.last_sigint_time is None or time.time() - self.last_sigint_time > 10
         ):
             # reset the counter to 1

{bec_ipython_client-3.64.5.dist-info → bec_ipython_client-3.89.3.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: bec_ipython_client
-Version: 3.64.5
+Version: 3.89.3
 Summary: BEC IPython client
 Project-URL: Bug Tracker, https://github.com/bec-project/bec/issues
 Project-URL: Homepage, https://github.com/bec-project/bec
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Requires-Dist: bec-lib~=3.0
 Requires-Dist: ipython~=8.22
 Requires-Dist: numpy<3.0,>=1.24

bec_ipython_client-3.89.3.dist-info/RECORD

@@ -0,0 +1,44 @@
+.gitignore,sha256=XxC6jyyftTo2CLtm4K8axuNPYwA9Wgaz2R93WhX8bTQ,3364
+PKG-INFO,sha256=trZwsE2OpNig8TZ6MjQ6HN5lX5tRxLrygSFHiz4FATs,1052
+demo.py,sha256=AquJB-0Tu2bIEFpcJ0Q3RUBt1xldqS6GgU5CjOAg_ww,7083
+pyproject.toml,sha256=Gv8V_TLxvNXUR9W-ROwlP7dGq9cbC8BfRC9anNsoddQ,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=h7417qQj0rwj5gjbKg6pn8Y_yYJf4b8Fs5EP29sXXOg,13564
+bec_ipython_client/prettytable.py,sha256=TnhGPGuU0XEvnIYJ1UfTEwadcowFW4rqJW8z_Sm0EDw,2534
+bec_ipython_client/progressbar.py,sha256=aDKYjzXmGSwa82ewm59V8WSuqVQz9GiZPx5G65fEwpk,11090
+bec_ipython_client/signals.py,sha256=P7FrIB66dGdPESUngBnIVPGrAhcd2Tek8ufq9ALBoYU,4340
+bec_ipython_client/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_ipython_client/callbacks/device_progress.py,sha256=NzWIO1oowxpN14hPXBne6RfZxOW82EhwDM3jHLnn3xI,2603
+bec_ipython_client/callbacks/ipython_live_updates.py,sha256=zaXR6UX7fA01-N0B0C2t67lOqjBgq8nal8eZpgf_nDc,11416
+bec_ipython_client/callbacks/live_table.py,sha256=ewdter1z1arV1EvEsReOihluyTmAHMrHtOu_S29vixo,14432
+bec_ipython_client/callbacks/move_device.py,sha256=TkbtKFBr1nuJ8THTSm70Y8D7_va2YQ57oBGGt0BavW4,8153
+bec_ipython_client/callbacks/utils.py,sha256=e8USLnufNTpI2Bkp-sjRsSFvIXxB2CirF6WRPVsOets,5338
+bec_ipython_client/high_level_interfaces/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_ipython_client/high_level_interfaces/bec_hli.py,sha256=G1eF-lbLEDuN2mr_AYSxhhGb4LT6P72g0a4sU9M9zgk,1221
+bec_ipython_client/high_level_interfaces/spec_hli.py,sha256=z7WtjiC4LtMfKJn12SbguHPCLqbAsZNfUDyiUW0LOiU,5818
+bec_ipython_client/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_ipython_client/plugins/SLS/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_ipython_client/plugins/SLS/sls_info.py,sha256=93GU_XNRDsCO0ZvUrCf_SWnUMJ1FlRTJSuXXh_bYJ30,4934
+bec_ipython_client/plugins/XTreme/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_ipython_client/plugins/XTreme/x-treme.py,sha256=ZKI_EEPYyWW-sdrK9DIllb81aeObc1O3fU1eWqipjTQ,3631
+bec_ipython_client/plugins/flomni/flomni_config.yaml,sha256=bCN1VKCzF6tw24HYeUE2b81kXMXzhEd69Ea8_q8Ywfk,6184
+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=gks7IYoDDXpbkC_EGWQfKtH08Yig71PRZtleXFhkU8A,8903
+tests/client_tests/test_device_progress.py,sha256=GEw2g8MQZnv5mxABEZlxBmaMpxVS33wogaYohFolDEs,2353
+tests/client_tests/test_ipython_live_updates.py,sha256=s4HLqF2hVQaaJhRKv0dxj0DiZK5M9Z_WwMAbGk19EFg,11918
+tests/client_tests/test_live_table.py,sha256=0EKgWOgDqpjN8fJEeAzoKNCwFneDEsUY2NfWQkxB6xc,18155
+tests/client_tests/test_move_callback.py,sha256=bUCcWoz_tc-yRAtwmEUMrKE_qKwatop_wReSugGGEIQ,8670
+tests/client_tests/test_pretty_table.py,sha256=uQ-KPb3RXoCFE_t1IrpkT6kZAoqW7pFXxbFc445sX0Y,469
+tests/end-2-end/_ensure_requirements_container.py,sha256=dv_ACfo9nHyiiEL3AMccaEg38VxGqB0W7u_iPyCVeiE,701
+tests/end-2-end/test_procedures_e2e.py,sha256=ai8pUrHaL-5sYuaKYucuYEwyvhelS1dsW9KGoBb1Riw,4872
+tests/end-2-end/test_scans_e2e.py,sha256=JhyWjDyUlBZAM_gL6QtfKXfI_fXdUnykYCIWCSorRiA,32527
+tests/end-2-end/test_scans_lib_e2e.py,sha256=dqs0ojkyQWStIQbqABq9mQrjqQyE43gr37VPhxvQ8b8,19427
+bec_ipython_client-3.89.3.dist-info/METADATA,sha256=trZwsE2OpNig8TZ6MjQ6HN5lX5tRxLrygSFHiz4FATs,1052
+bec_ipython_client-3.89.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+bec_ipython_client-3.89.3.dist-info/entry_points.txt,sha256=oQUXYY0jjD9ZvKPHwaGn2wkUIWpDZM8L4ixDA3RlBWE,53
+bec_ipython_client-3.89.3.dist-info/RECORD,,

{bec_ipython_client-3.64.5.dist-info → bec_ipython_client-3.89.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

demo.py

@@ -23,7 +23,7 @@ scans = bec.scans
 
 
 logger.success("Started BECClient")
-scans.umv(dev.samx, 5, relative=True)
+scans.umv(dev.samx, 5, dev.samy, 20, relative=False)
 
 # with scans.interactive_scan() as scan:
 #     for ii in range(10):
@@ -226,4 +226,5 @@ scans.umv(dev.samx, 5, relative=True)
 # event = threading.Event()
 # event.wait()
 print("eos")
+bec.shutdown()
 # p.join()

pyproject.toml

@@ -4,9 +4,9 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_ipython_client"
-version = "3.64.5"
+version = "3.89.3"
 description = "BEC IPython client"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Programming Language :: Python :: 3",

tests/client_tests/conftest.py

@@ -0,0 +1,19 @@
+import fakeredis
+import pytest
+
+from bec_lib.redis_connector import RedisConnector
+
+
+def fake_redis_server(host, port, **kwargs):
+    redis = fakeredis.FakeRedis()
+    return redis
+
+
+@pytest.fixture
+def connected_connector():
+    connector = RedisConnector("localhost:1", redis_cls=fake_redis_server)
+    connector._redis_conn.flushall()
+    try:
+        yield connector
+    finally:
+        connector.shutdown()

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
 
@@ -204,10 +205,40 @@ def test_bec_ipython_client_property_access(ipython_client):
                 client.start()
 
                 with mock.patch.object(client._client, "connector") as mock_connector:
-                    mock_connector.get.return_value = messages.VariableMessage(value="account")
+                    mock_connector.get_last.return_value = messages.VariableMessage(value="account")
                     assert client._client.active_account == "account"
 
                     with pytest.raises(AttributeError):
                         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
+    error_info = messages.ErrorInfo(
+        error_message="This is a test alarm",
+        compact_error_message="Test alarm",
+        exception_type="TestAlarm",
+        device=None,
+    )
+    alarm_msg = messages.AlarmMessage(severity=Alarms.MAJOR, info=error_info)
+    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