bec-ipython-client 3.35.6__py3-none-any.whl → 3.84.0__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,16 +11,18 @@ 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
@@ -25,6 +31,7 @@ from bec_lib.client import BECClient
 from bec_lib.logger import bec_logger
 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
 
@@ -79,6 +86,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 +144,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 +195,66 @@ class BECIPythonClient:
             pass
         self._client.shutdown()
 
+    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 +284,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)),
@@ -271,6 +340,12 @@ def main():
     )
     parser.add_argument("--version", action="store_true", default=False)
     parser.add_argument("--nogui", action="store_true", default=False)
+    parser.add_argument(
+        "--gui-id",
+        action="store",
+        default=None,
+        help="ID of the GUI to connect to, if not set, a new GUI will be created",
+    )
     parser.add_argument("--dont-wait-for-server", action="store_true", default=False)
     parser.add_argument("--post-startup-file", action="store", default=None)
 
@@ -278,7 +353,7 @@ def main():
         if hasattr(plugin["module"], "extend_command_line_args"):
             plugin["module"].extend_command_line_args(parser)
 
-    args, left_args, config = parse_cmdline_args(parser)
+    args, left_args, config = parse_cmdline_args(parser, config_name="client")
 
     # remove already parsed args from command line args
     sys.argv = sys.argv[:1] + left_args

{bec_ipython_client-3.35.6.dist-info → bec_ipython_client-3.84.0.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: bec_ipython_client
-Version: 3.35.6
+Version: 3.84.0
 Summary: BEC IPython client
-Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec/issues
-Project-URL: Homepage, https://gitlab.psi.ch/bec/bec
+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.35.6.dist-info → bec_ipython_client-3.84.0.dist-info}/RECORD

@@ -1,21 +1,21 @@
-.gitignore,sha256=UmJ0gTRAPp4EI1A6tb9Pi-k5uxDIb_NWJU9ye6AW-8Y,3306
-PKG-INFO,sha256=s2CbZvQumJ7v15ZfE0_xuHM9zRpm6BJzRQHQzCvKd4Y,1042
-demo.py,sha256=TE-niyXPUEAP-GaL-QRBPgnaxfXqBmTsBiKUxl3F_VQ,7053
-pyproject.toml,sha256=wtZG5v0G-id1KhouYlViubc_l4QlCH37zbvS1CbCLQo,1219
+.gitignore,sha256=XxC6jyyftTo2CLtm4K8axuNPYwA9Wgaz2R93WhX8bTQ,3364
+PKG-INFO,sha256=ijJpv2TMYSqXFg607-vZwabQv7Ib-B-cWeiu71D9-Xc,1052
+demo.py,sha256=AquJB-0Tu2bIEFpcJ0Q3RUBt1xldqS6GgU5CjOAg_ww,7083
+pyproject.toml,sha256=HuXmixsLCNg82K4Z_GDHOdRWAVHza_oeQ7Pe5fKipHU,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=6qtqp-naj8HUPq6_UC_mZD9PIBdbrZGtRoHJlSNmqAI,1816
-bec_ipython_client/main.py,sha256=6S57jE9zdGyIUi_NclnsF2brpEkU5_zJYVWWVX3IIBs,10845
+bec_ipython_client/bec_startup.py,sha256=GGlHyxnSCQfYF5n-pYq2ic0pSyW5zvnT2PAlI5kY77w,1930
+bec_ipython_client/main.py,sha256=XxSaiRuvDPKRzM3yuPz3FW5I0wnfyL2SgEfEG3VrDJg,13543
 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=y3GFSlCD-etOIrLJkX2ozxEyCNRMaRAaTdZmN8xOcjk,2385
-bec_ipython_client/callbacks/ipython_live_updates.py,sha256=2giQImMMaqRKnD7PW1xrDPmrxi-qy8MHdY_daWtJe-g,10290
-bec_ipython_client/callbacks/live_table.py,sha256=AMYHXoXR0KPGfGMnsmFNxY_SeFedA80flV-ROSoX6lE,12163
-bec_ipython_client/callbacks/move_device.py,sha256=FXCztPGqKNmaSKs9Q13y7syZJs57IZo4mJH6GTOIbOU,5863
-bec_ipython_client/callbacks/utils.py,sha256=AEEzsfD9S2ZMuJA4yAxy9gMa1iPMCxQ3zr7ZDO01bHE,5702
+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=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
 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
@@ -26,16 +26,19 @@ bec_ipython_client/plugins/XTreme/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeR
 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=H6ZYUlh7VUN1OHxZ-wk6pUBC09XlMmmAn8cInzOjQw4,7584
+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=HpA16Mx0WdseqlfP0FojlAd6VfvjnwAUReDkItZVYWs,6081
-tests/client_tests/test_live_table.py,sha256=8SUFBSiGmomqUc4d7VwxbbjcFiCrbdKZxU2AKRXJ_Cc,11219
-tests/client_tests/test_move_callback.py,sha256=e5c14pa9tUsMPgNhI9m7vrml5TKEAmMAQKLuiZPftDw,7026
+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/test_scans_e2e.py,sha256=CxlXjQrzDJebaoZObt_oYx41wbnHLuJLSjKlno4u2B4,30981
-tests/end-2-end/test_scans_lib_e2e.py,sha256=gHQ1qzuvX49LciGB3FPrd_Ha2KpVPRmc3Q5oBZb9pLw,19128
-bec_ipython_client-3.35.6.dist-info/METADATA,sha256=s2CbZvQumJ7v15ZfE0_xuHM9zRpm6BJzRQHQzCvKd4Y,1042
-bec_ipython_client-3.35.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-bec_ipython_client-3.35.6.dist-info/entry_points.txt,sha256=oQUXYY0jjD9ZvKPHwaGn2wkUIWpDZM8L4ixDA3RlBWE,53
-bec_ipython_client-3.35.6.dist-info/RECORD,,
+tests/end-2-end/_ensure_requirements_container.py,sha256=RT2a5cUZnXtMjJRlPImGzgyX-KJPLiav5WSp_l3wzv8,725
+tests/end-2-end/test_procedures_e2e.py,sha256=xjczbB33Cf5pDLe1KWcalRRBrSxOQ3cbV3s3w3GsC_A,4922
+tests/end-2-end/test_scans_e2e.py,sha256=GMStotxqu24794TxIFc55PCtOjuG2qbkmibcUj7r-DI,31069
+tests/end-2-end/test_scans_lib_e2e.py,sha256=dqs0ojkyQWStIQbqABq9mQrjqQyE43gr37VPhxvQ8b8,19427
+bec_ipython_client-3.84.0.dist-info/METADATA,sha256=ijJpv2TMYSqXFg607-vZwabQv7Ib-B-cWeiu71D9-Xc,1052
+bec_ipython_client-3.84.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+bec_ipython_client-3.84.0.dist-info/entry_points.txt,sha256=oQUXYY0jjD9ZvKPHwaGn2wkUIWpDZM8L4ixDA3RlBWE,53
+bec_ipython_client-3.84.0.dist-info/RECORD,,

{bec_ipython_client-3.35.6.dist-info → bec_ipython_client-3.84.0.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.35.6"
+version = "3.84.0"
 description = "BEC IPython client"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Programming Language :: Python :: 3",
@@ -39,8 +39,8 @@ dev = [
 bec = "bec_ipython_client.main:main"
 
 [project.urls]
-"Bug Tracker" = "https://gitlab.psi.ch/bec/bec/issues"
-Homepage = "https://gitlab.psi.ch/bec/bec"
+"Bug Tracker" = "https://github.com/bec-project/bec/issues"
+Homepage = "https://github.com/bec-project/bec"
 
 [tool.hatch.build.targets.wheel]
 include = ["*"]

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
 
@@ -30,6 +31,7 @@ try:
   import sys
   print(completer.all_completions('bec.'), flush=True)
   print(completer.all_completions('BECIP'), flush=True)
+  print(_main_dict["args"].gui_id, flush=True)
 finally:
   import os
   import signal
@@ -41,6 +43,8 @@ finally:
             sys.executable,
             main.__file__,
             "--nogui",
+            "--gui-id",
+            "test_gui_id",
             "--dont-wait-for-server",
             "--post-startup-file",
             file_to_execute,
@@ -58,6 +62,7 @@ finally:
     assert (
         "BECIPythonClient" not in output_lines[1]
     )  # just to ensure something we don't want is really not there
+    assert "test_gui_id" in output
 
 
 def test_bec_load_hli_tab_completion(tmpdir):
@@ -200,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