bec-widgets 1.6.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

CHANGELOG.md

@@ -1,14 +1,32 @@
 # CHANGELOG
 
 
-## v1.6.0 (2024-11-27)
+## v1.7.0 (2024-12-02)
 
 ### Bug Fixes
 
-- **tests**: Make use of BECDockArea with client mixin to start server and use it in tests
-  ([`da18c2c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/da18c2ceecf9aeaf0e0ea9b78f4c867b27b9c314))
+- **tests**: Add test for Console widget
+  ([`da579b6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/da579b6d213bcdf28c40c1a9e4e2535fdde824fb))
 
-Depending on the test, auto-updates are enabled or not.
+### Features
+
+- **console**: Add "prompt" signal to inform when shell is at prompt
+  ([`3aeb0b6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3aeb0b66fbeb03d3d0ee60e108cc6b98fd9aa9b9))
+
+- **console**: Add 'terminate' and 'send_ctrl_c' methods to Console
+  ([`02086ae`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/02086aeae09233ec4e6ccc0e6a17f2b078d500b8))
+
+.terminate() ends the started process, sending SIGTERM signal. If process is not dead after optional
+  timeout, SIGKILL is sent. .send_ctrl_c() sends SIGINT to the child process, and waits for prompt
+  until optional timeout is reached. Timeouts raise 'TimeoutError' exception.
+
+
+## v1.6.0 (2024-11-27)
+
+### Bug Fixes
+
+- Add back accidentally removed variables
+  ([`e998352`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e9983521ed2a1c04af048a55ece70a1943a84313))
 
 - Differentiate click and drag for DeviceItem, adapt tests accordingly
   ([`cffcdf2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cffcdf292363249bcc7efa9d130431d0bc727fda))
@@ -17,12 +35,6 @@ This fixes the blocking "QDrag.exec_()" on Linux, indeed before the drag'n'drop
   started with a simple click and it was waiting for drop forever. Now there are 2 different cases,
   click or drag'n'drop - the drag'n'drop test actually moves the mouse and releases the button.
 
-- **server**: Use dock area by default
-  ([`2fe7f5e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2fe7f5e1510a5ea72676045e6ea3485e6b11c220))
-
-- **rpc**: Gui hide/show also hide/show all floating docks
-  ([`c27d058`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c27d058b01fe604eccec76454e39360122e48515))
-
 - Do not quit automatically when last window is "closed"
   ([`96e255e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/96e255e4ef394eb79006a66d13e06775ae235667))
 
@@ -31,8 +43,16 @@ Qt confuses closed and hidden
 - No need to call inspect.signature - it can fail on methods coming from C (like Qt methods)
   ([`6029246`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/60292465e9e52d3248ae681c68c07298b9b3ce14))
 
-- Add back accidentally removed variables
-  ([`e998352`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e9983521ed2a1c04af048a55ece70a1943a84313))
+- **rpc**: Gui hide/show also hide/show all floating docks
+  ([`c27d058`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c27d058b01fe604eccec76454e39360122e48515))
+
+- **server**: Use dock area by default
+  ([`2fe7f5e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2fe7f5e1510a5ea72676045e6ea3485e6b11c220))
+
+- **tests**: Make use of BECDockArea with client mixin to start server and use it in tests
+  ([`da18c2c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/da18c2ceecf9aeaf0e0ea9b78f4c867b27b9c314))
+
+Depending on the test, auto-updates are enabled or not.
 
 ### Features
 
@@ -40,26 +60,26 @@ Qt confuses closed and hidden
   BECDockArea
   ([`31d8703`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/31d87036c9801e639a7ca6fc003c90e0c4edb19d))
 
-- Add rpc_id member to client objects
-  ([`3ba0b1d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3ba0b1daf5b83da840e90fbbc063ed7b86ebe99b))
-
-- **client**: Add show()/hide() methods to "gui" object
-  ([`e68e2b5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e68e2b5978339475b97555c3e20795807932fbc9))
-
-- **server**: Add main window, with proper gui_id derived from given id
-  ([`daf6ea0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/daf6ea0159c9ffc7b53bb7ae6b9abc16a302972c))
+- Add '--hide' argument to BEC GUI server
+  ([`1f60fec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f60fec7201ed252d7e49bf16f2166ee7f6bed6a))
 
 - Add main window container widget
   ([`f80ec33`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f80ec33ae5a261dbcab901ae30f4cc802316e554))
 
+- Add rpc_id member to client objects
+  ([`3ba0b1d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3ba0b1daf5b83da840e90fbbc063ed7b86ebe99b))
+
 - Asynchronous .start() for GUI
   ([`2047e48`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2047e484d5a4b2f5ea494a1e49035b35b1bbde35))
 
 - Do not take focus when GUI is loaded
   ([`1f71d8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f71d8e5eded9952f9b34bfc427e2ff44cf5fc18))
 
-- Add '--hide' argument to BEC GUI server
-  ([`1f60fec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f60fec7201ed252d7e49bf16f2166ee7f6bed6a))
+- **client**: Add show()/hide() methods to "gui" object
+  ([`e68e2b5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e68e2b5978339475b97555c3e20795807932fbc9))
+
+- **server**: Add main window, with proper gui_id derived from given id
+  ([`daf6ea0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/daf6ea0159c9ffc7b53bb7ae6b9abc16a302972c))
 
 
 ## v1.5.3 (2024-11-21)
@@ -192,19 +212,3 @@ Qt confuses closed and hidden
 
 - **colormap_button**: Colormap button with menu to select colormap filtered by the colormap type
   ([`b039933`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b039933405e2fbe92bd81bd0748e79e8d443a741))
-
-
-## v1.2.0 (2024-10-25)
-
-### Features
-
-- **colors**: Evenly spaced color generation + new golden ratio calculation
-  ([`40c9fea`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/40c9fea35f869ef52e05948dd1989bcd99f602e0))
-
-### Refactoring
-
-- Add bec_lib version to statusbox
-  ([`5d4b86e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d4b86e1c6e1800051afce4f991153e370767fa6))
-
-
-## v1.1.0 (2024-10-25)

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 1.6.0
+Version: 1.7.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

bec_widgets/widgets/editors/console/console.py

@@ -10,9 +10,13 @@ import fcntl
 import html
 import os
 import pty
+import re
+import signal
 import sys
+import time
 
 import pyte
+from pygments.token import Token
 from pyte.screens import History
 from qtpy import QtCore, QtGui, QtWidgets
 from qtpy.QtCore import Property as pyqtProperty
@@ -235,10 +239,14 @@ class BECConsole(QtWidgets.QWidget):
     PLUGIN = True
     ICON_NAME = "terminal"
 
+    prompt = pyqtSignal(bool)
+
     def __init__(self, parent=None, cols=132):
         super().__init__(parent)
 
         self.term = _TerminalWidget(self, cols, rows=43)
+        self.term.prompt.connect(self.prompt)  # forward signal from term to this widget
+
         self.scroll_bar = QScrollBar(Qt.Vertical, self)
         # self.scroll_bar.hide()
         layout = QHBoxLayout(self)
@@ -320,9 +328,38 @@ class BECConsole(QtWidgets.QWidget):
     def start(self, deactivate_ctrl_d=True):
         self.term.start(deactivate_ctrl_d=deactivate_ctrl_d)
 
-    def push(self, text):
+    def push(self, text, hit_return=False):
         """Push some text to the terminal"""
-        return self.term.push(text)
+        return self.term.push(text, hit_return=hit_return)
+
+    def execute_command(self, command):
+        self.push(command, hit_return=True)
+
+    def set_prompt_tokens(self, *tokens):
+        """Prepare regexp to identify prompt, based on tokens
+
+        Tokens are returned from get_ipython().prompts.in_prompt_tokens()
+        """
+        regex_parts = []
+        for token_type, token_value in tokens:
+            if token_type == Token.PromptNum:  # Handle dynamic prompt number
+                regex_parts.append(r"[\d\?]+")  # Match one or more digits or '?'
+            else:
+                # Escape other prompt parts (e.g., "In [", "]: ")
+                if not token_value:
+                    regex_parts.append(".+?")  # arbitrary string
+                else:
+                    regex_parts.append(re.escape(token_value))
+
+        # Combine into a single regex
+        prompt_pattern = "".join(regex_parts)
+        self.term._prompt_re = re.compile(prompt_pattern + r"\s*$")
+
+    def terminate(self, timeout=10):
+        self.term.stop(timeout=timeout)
+
+    def send_ctrl_c(self, timeout=None):
+        self.term.send_ctrl_c(timeout)
 
     cols = pyqtProperty(int, get_cols, set_cols)
     rows = pyqtProperty(int, get_rows, set_rows)
@@ -336,7 +373,15 @@ class _TerminalWidget(QtWidgets.QPlainTextEdit):
     Start ``Backend`` process and render Pyte output as text.
     """
 
+    prompt = pyqtSignal(bool)
+
     def __init__(self, parent, cols=125, rows=50, **kwargs):
+        # regexp to match prompt
+        self._prompt_re = None
+        # last prompt
+        self._prompt_str = None
+        # process pid
+        self.pid = None
         # file descriptor to communicate with the subprocess
         self.fd = None
         self.backend = None
@@ -433,7 +478,7 @@ class _TerminalWidget(QtWidgets.QPlainTextEdit):
         self.update_term_size()
 
         # Start the Bash process
-        self.fd = self.fork_shell()
+        self.pid, self.fd = self.fork_shell()
 
         if self.fd:
             # Create the ``Backend`` object
@@ -449,6 +494,62 @@ class _TerminalWidget(QtWidgets.QPlainTextEdit):
         self.appendHtml(f"<br><h2>{repr(self._cmd)} - Process exited.</h2>")
         self.setReadOnly(True)
 
+    def send_ctrl_c(self, wait_prompt=True, timeout=None):
+        """Send CTRL-C to the process
+
+        If wait_prompt=True (default), wait for a new prompt after CTRL-C
+        If no prompt is displayed after 'timeout' seconds, TimeoutError is raised
+        """
+        os.kill(self.pid, signal.SIGINT)
+        if wait_prompt:
+            timeout_error = False
+            if timeout:
+
+                def set_timeout_error():
+                    nonlocal timeout_error
+                    timeout_error = True
+
+                timeout_timer = QTimer()
+                timeout_timer.singleShot(timeout * 1000, set_timeout_error)
+            while self._prompt_str is None:
+                QApplication.instance().process_events()
+                if timeout_error:
+                    raise TimeoutError(
+                        f"CTRL-C: could not get back to prompt after {timeout} seconds."
+                    )
+
+    def _is_running(self):
+        if os.waitpid(self.pid, os.WNOHANG) == (0, 0):
+            return True
+        return False
+
+    def stop(self, kill=True, timeout=None):
+        """Stop the running process
+
+        SIGTERM is the default signal for terminating processes.
+
+        If kill=True (default), SIGKILL will be sent if the process does not exit after timeout
+        """
+        # try to exit gracefully
+        os.kill(self.pid, signal.SIGTERM)
+
+        # wait until process is truly dead
+        t0 = time.perf_counter()
+        while self._is_running():
+            time.sleep(1)
+            if timeout is not None and time.perf_counter() - t0 > timeout:
+                # still alive after 'timeout' seconds
+                if kill:
+                    # send SIGKILL and make a last check in loop
+                    os.kill(self.pid, signal.SIGKILL)
+                    kill = False
+                else:
+                    # still running after timeout...
+                    raise TimeoutError(
+                        f"Could not terminate process with pid: {self.pid} within timeout"
+                    )
+        self.process_exited()
+
     def data_ready(self, screen):
         """Handle new screen: redraw, set scroll bar max and slider, move cursor to its position
 
@@ -540,11 +641,13 @@ class _TerminalWidget(QtWidgets.QPlainTextEdit):
         elif code is not None:
             self.write(code)
 
-    def push(self, text):
+    def push(self, text, hit_return=False):
         """
         Write 'text' to terminal
         """
         self.write(text.encode("utf-8"))
+        if hit_return:
+            self.write(b"\n")
 
     def contextMenuEvent(self, event):
         if self.fd is None:
@@ -650,6 +753,20 @@ class _TerminalWidget(QtWidgets.QPlainTextEdit):
                 self.output[line_no] = line
             # fill the text area with HTML contents in one go
             self.appendHtml(f"<pre>{chr(10).join(self.output)}</pre>")
+
+            if self._prompt_re is not None:
+                text_buf = self.toPlainText()
+                prompt = self._prompt_re.search(text_buf)
+                if prompt is None:
+                    if self._prompt_str:
+                        self.prompt.emit(False)
+                    self._prompt_str = None
+                else:
+                    prompt_str = prompt.string.rstrip()
+                    if prompt_str != self._prompt_str:
+                        self._prompt_str = prompt_str
+                        self.prompt.emit(True)
+
             # did updates, all clean
             screen.dirty.clear()
 
@@ -711,7 +828,7 @@ class _TerminalWidget(QtWidgets.QPlainTextEdit):
             # We are in the parent process.
             # Set file control
             fcntl.fcntl(fd, fcntl.F_SETFL, os.O_NONBLOCK)
-            return fd
+            return pid, fd
 
 
 if __name__ == "__main__":
@@ -728,6 +845,24 @@ if __name__ == "__main__":
 
     console = BECConsole(mainwin)
     mainwin.setCentralWidget(console)
+
+    def check_prompt(at_prompt):
+        if at_prompt:
+            print("NEW PROMPT")
+        else:
+            print("EXECUTING SOMETHING...")
+
+    console.set_prompt_tokens(
+        (Token.OutPromptNum, "•"),
+        (Token.Prompt, ""),  # will match arbitrary string,
+        (Token.Prompt, " ["),
+        (Token.PromptNum, "3"),
+        (Token.Prompt, "/"),
+        (Token.PromptNum, "1"),
+        (Token.Prompt, "] "),
+        (Token.Prompt, "❯❯"),
+    )
+    console.prompt.connect(check_prompt)
     console.start()
 
     # Show widget and launch Qt's event loop.

{bec_widgets-1.6.0.dist-info → bec_widgets-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 1.6.0
+Version: 1.7.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

{bec_widgets-1.6.0.dist-info → bec_widgets-1.7.0.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=bAWGX_NR9rQZmv_bmyLXkEMRreWp0JzVNpsNTxk0NwE,8637
 .pylintrc,sha256=eeY8YwSI74oFfq6IYIbCqnx3Vk8ZncKaatv96n_Y8Rs,18544
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=rP_mHsOcY94LFhcrRp1KzMa8-oloUwXlsGJvNyoRdOc,7434
+CHANGELOG.md,sha256=-XyIDJ1C204NhjKieHBciyZVtpEQnlqAZgusnhdxU-k,7859
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=2HB-XRVq4chLKrU2LZsMvGQNQCFLyftCLvdNiSpkccM,1308
+PKG-INFO,sha256=0rkaKmhcyUiRQJnmMXE8GgO0BMm8JMEcVGpGzkTwdOc,1308
 README.md,sha256=Od69x-RS85Hph0-WwWACwal4yUd67XkEn4APEfHhHFw,2649
-pyproject.toml,sha256=QcjZWBGoaVccsAkR_wifdqlxLApFyxtKW9cH0B8FAuw,2586
+pyproject.toml,sha256=MH0RsHdGV1exWgR_0BWw67wwFgluGLni_d2Qdn3HlLk,2586
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .gitlab/issue_templates/bug_report_template.md,sha256=gAuyEwl7XlnebBrkiJ9AqffSNOywmr8vygUFWKTuQeI,386
 .gitlab/issue_templates/documentation_update_template.md,sha256=FHLdb3TS_D9aL4CYZCjyXSulbaW5mrN2CmwTaeLPbNw,860
@@ -197,7 +197,7 @@ bec_widgets/widgets/dap/lmfit_dialog/lmfit_dialog_vertical.ui,sha256=LQCQKQMcocd
 bec_widgets/widgets/dap/lmfit_dialog/register_lm_fit_dialog.py,sha256=7tB1gsvv310_kVuKf2u4EdSR4F1posm7QCrWH5Kih-Q,480
 bec_widgets/widgets/editors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/editors/console/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/widgets/editors/console/console.py,sha256=V_xT5q_yBvstGMBXnocD10MFXmum8l_82HfPD2tj_FE,24581
+bec_widgets/widgets/editors/console/console.py,sha256=RLzN-a2h27NLeQVjJiZRCtngRDPBmsGdouZ22bKbTUE,29327
 bec_widgets/widgets/editors/console/console.pyproject,sha256=JcoDuZG03g1Bxkd3Aipo7jjLexujfbibIZqXHIgLSWc,26
 bec_widgets/widgets/editors/console/console_plugin.py,sha256=EvFTruYDVHiS4pHIwZnuEvJhS9eQoktuB_k5mcPuEts,1357
 bec_widgets/widgets/editors/console/register_console.py,sha256=zoF-i3R9sRGzb85sdoxVunebYOfOD53fkCELTPtrFRc,471
@@ -313,8 +313,8 @@ bec_widgets/widgets/utility/visual/dark_mode_button/dark_mode_button.py,sha256=Z
 bec_widgets/widgets/utility/visual/dark_mode_button/dark_mode_button.pyproject,sha256=Lbi9zb6HNlIq14k6hlzR-oz6PIFShBuF7QxE6d87d64,34
 bec_widgets/widgets/utility/visual/dark_mode_button/dark_mode_button_plugin.py,sha256=CzChz2SSETYsR8-36meqWnsXCT-FIy_J_xeU5coWDY8,1350
 bec_widgets/widgets/utility/visual/dark_mode_button/register_dark_mode_button.py,sha256=rMpZ1CaoucwobgPj1FuKTnt07W82bV1GaSYdoqcdMb8,521
-bec_widgets-1.6.0.dist-info/METADATA,sha256=2HB-XRVq4chLKrU2LZsMvGQNQCFLyftCLvdNiSpkccM,1308
-bec_widgets-1.6.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-bec_widgets-1.6.0.dist-info/entry_points.txt,sha256=dItMzmwA1wizJ1Itx15qnfJ0ZzKVYFLVJ1voxT7K7D4,214
-bec_widgets-1.6.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-1.6.0.dist-info/RECORD,,
+bec_widgets-1.7.0.dist-info/METADATA,sha256=0rkaKmhcyUiRQJnmMXE8GgO0BMm8JMEcVGpGzkTwdOc,1308
+bec_widgets-1.7.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+bec_widgets-1.7.0.dist-info/entry_points.txt,sha256=dItMzmwA1wizJ1Itx15qnfJ0ZzKVYFLVJ1voxT7K7D4,214
+bec_widgets-1.7.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-1.7.0.dist-info/RECORD,,

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "1.6.0"
+version = "1.7.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [