bec-ipython-client 3.125.2__tar.gz → 3.127.0__tar.gz

{bec_ipython_client-3.125.2 → bec_ipython_client-3.127.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_ipython_client
-Version: 3.125.2
+Version: 3.127.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.125.2 → bec_ipython_client-3.127.0}/bec_ipython_client/main.py

@@ -5,6 +5,7 @@ import collections
 import functools
 import os
 import sys
+import traceback
 from typing import Iterable, Literal, Tuple
 
 import IPython
@@ -147,7 +148,7 @@ class BECIPythonClient:
         self._ip.prompts = BECClientPrompt(ip=self._ip, client=self._client, username="unknown")
         self._refresh_ipython_username()
         self._load_magics()
-        self._ip.events.register("post_run_cell", log_console)
+        self._ip.events.register("pre_run_cell", log_console)
         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(
@@ -252,25 +253,31 @@ def _ip_exception_handler(
 ):
     if issubclass(etype, AlarmBase):
         parent._alarm_history.append((etype, evalue, tb, tb_offset))
+        log_console_error(etype, evalue, tb)
         print("\x1b[31m BEC alarm:\x1b[0m")
         evalue.pretty_print()
         print("For more details, use 'bec.show_last_alarm()'")
         return
     if issubclass(etype, ValidationError):
+        log_console_error(etype, evalue, tb)
         pretty_print_pydantic_validation_error(evalue)
         return
     if issubclass(etype, (ScanInterruption, DeviceConfigError)):
+        log_console_error(etype, evalue, tb, f"{evalue.__class__.__name__}: {evalue}")
         print(f"\x1b[31m {evalue.__class__.__name__}:\x1b[0m {evalue}")
         return
     if issubclass(etype, redis.exceptions.NoPermissionError):
         # pylint: disable=protected-access
         msg = f"The current user ({bec._client.username}) does not have the required permissions.\n {evalue}"
+        log_console_error(etype, evalue, tb, f"Unauthorized: {msg}")
         logger.info(f"Unauthorized: {msg}")
         print(f"\x1b[31m Unauthorized:\x1b[0m {msg}")
         return
     if issubclass(etype, ExceptionWithErrorInfo):
+        log_console_error(etype, evalue, tb)
         evalue.pretty_print()
         return
+    log_console_error(etype, evalue, tb)
     self.showtraceback((etype, evalue, tb), tb_offset=None)  # standard IPython's printout
 
 
@@ -322,7 +329,17 @@ class BECClientPrompt(Prompts):
 
 def log_console(execution_info):
     """log the console input"""
-    logger.log("CONSOLE_LOG", f"{execution_info.info.raw_cell}")
+    logger.log("CONSOLE_LOG", f"{execution_info.raw_cell}")
+
+
+def log_console_error(etype, evalue, tb=None, message: str | None = None):
+    """Log console errors to the shared log stream."""
+    if message is None:
+        if tb is not None:
+            message = "".join(traceback.format_exception(etype, evalue, tb)).rstrip()
+        else:
+            message = f"{etype.__name__}: {evalue}"
+    logger.log("CONSOLE_LOG_ERROR", message)
 
 
 # pylint: disable=wrong-import-position

{bec_ipython_client-3.125.2 → bec_ipython_client-3.127.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_ipython_client"
-version = "3.125.2"
+version = "3.127.0"
 description = "BEC IPython client"
 requires-python = ">=3.11"
 classifiers = [
@@ -62,6 +62,8 @@ Homepage = "https://github.com/bec-project/bec"
 
 
 
+
+
 
 
 

{bec_ipython_client-3.125.2 → bec_ipython_client-3.127.0}/tests/client_tests/test_bec_client.py

@@ -4,10 +4,12 @@ from unittest import mock
 
 import IPython
 import pytest
+import redis.exceptions
 
 from bec_ipython_client import BECIPythonClient, main
 from bec_lib import messages
 from bec_lib.alarm_handler import AlarmBase, AlarmHandler, Alarms
+from bec_lib.bec_errors import DeviceConfigError
 from bec_lib.redis_connector import RedisConnector
 from bec_lib.service_config import ServiceConfig
 
@@ -238,3 +240,55 @@ def test_bec_ipython_client_show_last_no_alarm(ipython_client, capsys):
     client.show_last_alarm()
     captured = capsys.readouterr()
     assert "No alarm has been raised in this session." in captured.out
+
+
+def test_ipython_exception_handler_logs_console_error_for_device_config_error():
+    shell = mock.MagicMock()
+    with mock.patch.object(main.logger, "log") as mock_log:
+        main._ip_exception_handler(
+            shell, DeviceConfigError, DeviceConfigError("bad config"), None, parent=mock.MagicMock()
+        )
+
+    mock_log.assert_called_once_with("CONSOLE_LOG_ERROR", "DeviceConfigError: bad config")
+    shell.showtraceback.assert_not_called()
+
+
+def test_ipython_exception_handler_logs_console_error_for_unhandled_exception():
+    shell = mock.MagicMock()
+    try:
+        raise RuntimeError("boom")
+    except RuntimeError as exc:
+        with mock.patch.object(main.logger, "log") as mock_log:
+            main._ip_exception_handler(
+                shell, RuntimeError, exc, exc.__traceback__, parent=mock.MagicMock()
+            )
+
+    mock_log.assert_called_once()
+    assert mock_log.call_args.args[0] == "CONSOLE_LOG_ERROR"
+    assert "RuntimeError: boom" in mock_log.call_args.args[1]
+    shell.showtraceback.assert_called_once()
+
+
+def test_ipython_exception_handler_logs_console_error_for_permission_error():
+    shell = mock.MagicMock()
+    parent = mock.MagicMock()
+    with (
+        mock.patch.object(main.logger, "log") as mock_log,
+        mock.patch.object(main.logger, "info") as mock_info,
+        mock.patch.object(
+            main, "bec", mock.MagicMock(_client=mock.MagicMock(username="alice")), create=True
+        ),
+    ):
+        main._ip_exception_handler(
+            shell,
+            redis.exceptions.NoPermissionError,
+            redis.exceptions.NoPermissionError("denied"),
+            None,
+            parent=parent,
+        )
+
+    mock_log.assert_called_once()
+    assert mock_log.call_args.args[0] == "CONSOLE_LOG_ERROR"
+    assert "Unauthorized:" in mock_log.call_args.args[1]
+    mock_info.assert_called_once()
+    shell.showtraceback.assert_not_called()