bec-widgets 0.50.1__tar.gz → 0.51.0__tar.gz

{bec_widgets-0.50.1 → bec_widgets-0.51.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bec_widgets
-Version: 0.50.1
+Version: 0.51.0
 Summary: BEC Widgets
 Home-page: https://gitlab.psi.ch/bec/bec-widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec-widgets/issues
@@ -22,14 +22,14 @@ BEC Widgets is a GUI framework designed for interaction with [BEC (Beamline Expe
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install BEC Widgets:
 
 ```bash
-pip install bec-widgets
+pip install bec_widgets
 ```
 
 For development purposes, you can clone the repository and install the package locally in editable mode:
 
 ```bash
 git clone https://gitlab.psi.ch/bec/bec-widgets
-cd bec-widgets
+cd bec_widgets
 pip install -e .[dev]
 ```
 
@@ -38,12 +38,12 @@ BEC Widgets currently supports both PyQt5 and PyQt6. By default, PyQt6 is instal
 To select a specific Python Qt distribution, install the package with an additional tag:
 
 ```bash
-pip install bec-widgets[pyqt6]
+pip install bec_widgets[pyqt6]
 ```
 or 
 
 ```bash
-pip install bec-widgets[pyqt5]
+pip install bec_widgets[pyqt5]
 ```
 ## Documentation
 

{bec_widgets-0.50.1 → bec_widgets-0.51.0}/README.md

@@ -6,14 +6,14 @@ BEC Widgets is a GUI framework designed for interaction with [BEC (Beamline Expe
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install BEC Widgets:
 
 ```bash
-pip install bec-widgets
+pip install bec_widgets
 ```
 
 For development purposes, you can clone the repository and install the package locally in editable mode:
 
 ```bash
 git clone https://gitlab.psi.ch/bec/bec-widgets
-cd bec-widgets
+cd bec_widgets
 pip install -e .[dev]
 ```
 
@@ -22,12 +22,12 @@ BEC Widgets currently supports both PyQt5 and PyQt6. By default, PyQt6 is instal
 To select a specific Python Qt distribution, install the package with an additional tag:
 
 ```bash
-pip install bec-widgets[pyqt6]
+pip install bec_widgets[pyqt6]
 ```
 or 
 
 ```bash
-pip install bec-widgets[pyqt5]
+pip install bec_widgets[pyqt5]
 ```
 ## Documentation
 

{bec_widgets-0.50.1 → bec_widgets-0.51.0}/bec_widgets/utils/bec_dispatcher.py

@@ -129,7 +129,15 @@ class BECDispatcher:
         self._slots[slot].update(set(topics_str))
 
     def disconnect_slot(self, slot: Callable, topics: Union[str, list]):
-        self.client.connector.unregister(topics, cb=slot)
+        # find the right slot to disconnect from ;
+        # slot callbacks are wrapped in QtThreadSafeCallback objects,
+        # but the slot we receive here is the original callable
+        for connected_slot in self._slots:
+            if connected_slot.cb == slot:
+                break
+        else:
+            return
+        self.client.connector.unregister(topics, cb=connected_slot)
         topics_str, _ = self.client.connector._convert_endpointinfo(topics)
         self._slots[slot].difference_update(set(topics_str))
         if not self._slots[slot]:

bec_widgets-0.51.0/bec_widgets/utils/plugin_utils.py

@@ -0,0 +1,40 @@
+import inspect
+
+from bec_lib.plugin_helper import _get_available_plugins
+
+from bec_widgets.utils import BECConnector
+
+
+def get_plugin_widgets() -> dict[str, BECConnector]:
+    """
+    Get all available widgets from the plugin directory. Widgets are classes that inherit from BECConnector.
+    The plugins are provided through python plugins and specified in the respective pyproject.toml file using
+    the following key:
+
+        [project.entry-points."bec.widgets.user_widgets"]
+        plugin_widgets = "path.to.plugin.module"
+
+    e.g.
+        [project.entry-points."bec.widgets.user_widgets"]
+        plugin_widgets = "pxiii_bec.bec_widgets.widgets"
+
+        assuming that the widgets module for the package pxiii_bec is located at pxiii_bec/bec_widgets/widgets and
+        contains the widgets to be loaded within the pxiii_bec/bec_widgets/widgets/__init__.py file.
+
+    Returns:
+        dict[str, BECConnector]: A dictionary of widget names and their respective classes.
+    """
+    modules = _get_available_plugins("bec.widgets.user_widgets")
+    loaded_plugins = {}
+    print(modules)
+    for module in modules:
+        mods = inspect.getmembers(module, predicate=_filter_plugins)
+        for name, mod_cls in mods:
+            if name in loaded_plugins:
+                print(f"Duplicated widgets plugin {name}.")
+            loaded_plugins[name] = mod_cls
+    return loaded_plugins
+
+
+def _filter_plugins(obj):
+    return inspect.isclass(obj) and issubclass(obj, BECConnector)

{bec_widgets-0.50.1 → bec_widgets-0.51.0}/bec_widgets.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bec-widgets
-Version: 0.50.1
+Version: 0.51.0
 Summary: BEC Widgets
 Home-page: https://gitlab.psi.ch/bec/bec-widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec-widgets/issues
@@ -22,14 +22,14 @@ BEC Widgets is a GUI framework designed for interaction with [BEC (Beamline Expe
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install BEC Widgets:
 
 ```bash
-pip install bec-widgets
+pip install bec_widgets
 ```
 
 For development purposes, you can clone the repository and install the package locally in editable mode:
 
 ```bash
 git clone https://gitlab.psi.ch/bec/bec-widgets
-cd bec-widgets
+cd bec_widgets
 pip install -e .[dev]
 ```
 
@@ -38,12 +38,12 @@ BEC Widgets currently supports both PyQt5 and PyQt6. By default, PyQt6 is instal
 To select a specific Python Qt distribution, install the package with an additional tag:
 
 ```bash
-pip install bec-widgets[pyqt6]
+pip install bec_widgets[pyqt6]
 ```
 or 
 
 ```bash
-pip install bec-widgets[pyqt5]
+pip install bec_widgets[pyqt5]
 ```
 ## Documentation
 

{bec_widgets-0.50.1 → bec_widgets-0.51.0}/bec_widgets.egg-info/SOURCES.txt

@@ -41,6 +41,7 @@ setup.py
 ./bec_widgets/utils/crosshair.py
 ./bec_widgets/utils/ctrl_c.py
 ./bec_widgets/utils/entry_validator.py
+./bec_widgets/utils/plugin_utils.py
 ./bec_widgets/utils/rpc_decorator.py
 ./bec_widgets/utils/thread_checker.py
 ./bec_widgets/utils/validator_delegate.py

{bec_widgets-0.50.1 → bec_widgets-0.51.0}/bec_widgets.egg-info/requires.txt

@@ -1,7 +1,6 @@
 pydantic
 qtconsole
-PyQt6-Qt6<=6.6.3
-PyQt6<=6.6.3
+PyQt6>=6.7
 jedi
 qtpy
 pyqtgraph
@@ -19,9 +18,10 @@ coverage
 pytest-qt
 black
 isort
+fakeredis
 
 [pyqt5]
 PyQt5>=5.9
 
 [pyqt6]
-PyQt6<=6.6.3
+PyQt6>=6.7

{bec_widgets-0.50.1 → bec_widgets-0.51.0}/setup.py

@@ -1,10 +1,10 @@
 # pylint: disable= missing-module-docstring
 from setuptools import find_packages, setup
 
-__version__ = "0.50.1"
+__version__ = "0.51.0"
 
 # Default to PyQt6 if no other Qt binding is installed
-QT_DEPENDENCY = "PyQt6<=6.6.3"
+QT_DEPENDENCY = "PyQt6>=6.7"
 
 # pylint: disable=unused-import
 try:
@@ -19,7 +19,6 @@ if __name__ == "__main__":
         install_requires=[
             "pydantic",
             "qtconsole",
-            "PyQt6-Qt6<=6.6.3",
             QT_DEPENDENCY,
             "jedi",
             "qtpy",
@@ -39,9 +38,10 @@ if __name__ == "__main__":
                 "pytest-qt",
                 "black",
                 "isort",
+                "fakeredis",
             ],
             "pyqt5": ["PyQt5>=5.9"],
-            "pyqt6": ["PyQt6<=6.6.3"],
+            "pyqt6": ["PyQt6>=6.7"],
         },
         version=__version__,
         packages=find_packages(),

bec_widgets-0.51.0/tests/unit_tests/test_bec_dispatcher.py

@@ -0,0 +1,140 @@
+# pylint: disable = no-name-in-module,missing-class-docstring, missing-module-docstring
+import threading
+import time
+from unittest import mock
+
+import pytest
+import redis
+from bec_lib.connector import MessageObject
+from bec_lib.messages import ScanMessage
+from bec_lib.redis_connector import RedisConnector
+from bec_lib.serialization import MsgpackSerialization
+
+from bec_widgets.utils.bec_dispatcher import QtRedisConnector
+
+
+@pytest.fixture
+def bec_dispatcher_w_connector(bec_dispatcher, topics_msg_list, send_msg_event):
+    def pubsub_msg_generator():
+        send_msg_event.wait()
+        for topic, msg in topics_msg_list:
+            yield {"channel": topic.encode(), "pattern": None, "data": msg}
+        while True:
+            time.sleep(0.2)
+            yield StopIteration
+
+    with mock.patch("redis.Redis"):
+        pubsub = redis.Redis().pubsub()
+        messages = pubsub_msg_generator()
+        pubsub.get_message.side_effect = lambda timeout: next(messages)
+        connector = QtRedisConnector("localhost:1")
+        bec_dispatcher.client.connector = connector
+        yield bec_dispatcher
+
+
+dummy_msg = MsgpackSerialization.dumps(ScanMessage(point_id=0, scan_id="0", data={}))
+
+
+@pytest.fixture
+def send_msg_event():
+    return threading.Event()
+
+
+@pytest.mark.parametrize(
+    "topics_msg_list",
+    [
+        (
+            ("topic1", dummy_msg),
+            ("topic2", dummy_msg),
+            ("topic3", dummy_msg),
+        )
+    ],
+)
+def test_dispatcher_disconnect_all(bec_dispatcher_w_connector, qtbot, send_msg_event):
+    bec_dispatcher = bec_dispatcher_w_connector
+    cb1 = mock.Mock(spec=[])
+    cb2 = mock.Mock(spec=[])
+
+    bec_dispatcher.connect_slot(cb1, "topic1")
+    bec_dispatcher.connect_slot(cb1, "topic2")
+    bec_dispatcher.connect_slot(cb2, "topic2")
+    bec_dispatcher.connect_slot(cb2, "topic3")
+    assert len(bec_dispatcher.client.connector._topics_cb) == 3
+    send_msg_event.set()
+    qtbot.wait(10)
+    assert cb1.call_count == 2
+    assert cb2.call_count == 2
+
+    bec_dispatcher.disconnect_all()
+
+    assert len(bec_dispatcher.client.connector._topics_cb) == 0
+
+
+@pytest.mark.parametrize(
+    "topics_msg_list",
+    [
+        (
+            ("topic1", dummy_msg),
+            ("topic2", dummy_msg),
+        )
+    ],
+)
+def test_dispatcher_disconnect_one(bec_dispatcher_w_connector, qtbot, send_msg_event):
+    # test for BEC issue #276
+    bec_dispatcher = bec_dispatcher_w_connector
+    cb1 = mock.Mock(spec=[])
+    cb2 = mock.Mock(spec=[])
+
+    bec_dispatcher.connect_slot(cb1, "topic1")
+    bec_dispatcher.connect_slot(cb2, "topic2")
+    assert len(bec_dispatcher.client.connector._topics_cb) == 2
+    bec_dispatcher.disconnect_slot(cb1, "topic1")
+    assert len(bec_dispatcher.client.connector._topics_cb) == 1
+
+    send_msg_event.set()
+    qtbot.wait(10)
+    assert cb1.call_count == 0
+    cb2.assert_called_once()
+
+
+@pytest.mark.parametrize("topics_msg_list", [(("topic1", dummy_msg),)])
+def test_dispatcher_2_cb_same_topic(bec_dispatcher_w_connector, qtbot, send_msg_event):
+    # test for BEC issue #276
+    bec_dispatcher = bec_dispatcher_w_connector
+    cb1 = mock.Mock(spec=[])
+    cb2 = mock.Mock(spec=[])
+
+    bec_dispatcher.connect_slot(cb1, "topic1")
+    bec_dispatcher.connect_slot(cb2, "topic1")
+    assert len(bec_dispatcher.client.connector._topics_cb) == 1
+    bec_dispatcher.disconnect_slot(cb1, "topic1")
+
+    send_msg_event.set()
+    qtbot.wait(10)
+    assert cb1.call_count == 0
+    cb2.assert_called_once()
+
+
+@pytest.mark.parametrize(
+    "topics_msg_list",
+    [
+        (
+            ("topic1", dummy_msg),
+            ("topic2", dummy_msg),
+        )
+    ],
+)
+def test_dispatcher_2_topic_same_cb(bec_dispatcher_w_connector, qtbot, send_msg_event):
+    # test for BEC issue #276
+    bec_dispatcher = bec_dispatcher_w_connector
+    cb1 = mock.Mock(spec=[])
+
+    bec_dispatcher.connect_slot(cb1, "topic1")
+    bec_dispatcher.connect_slot(cb1, "topic2")
+    assert len(bec_dispatcher.client.connector._topics_cb) == 2
+    bec_dispatcher.disconnect_slot(cb1, "topic1")
+    assert len(bec_dispatcher.client.connector._topics_cb) == 1
+
+    send_msg_event.set()
+    qtbot.wait(10)
+    cb1.assert_called_once()

bec_widgets-0.50.1/tests/unit_tests/test_bec_dispatcher.py

@@ -1,59 +0,0 @@
-# pylint: disable = no-name-in-module,missing-class-docstring, missing-module-docstring
-import time
-from unittest import mock
-
-import pytest
-import redis
-from bec_lib.connector import MessageObject
-from bec_lib.messages import ScanMessage
-from bec_lib.redis_connector import RedisConnector
-from bec_lib.serialization import MsgpackSerialization
-
-from bec_widgets.utils.bec_dispatcher import QtRedisConnector
-
-
-@pytest.fixture
-def bec_dispatcher_w_connector(bec_dispatcher, topics_msg_list):
-    def pubsub_msg_generator():
-        for topic, msg in topics_msg_list:
-            yield {"channel": topic.encode(), "pattern": None, "data": msg}
-        while True:
-            time.sleep(0.2)
-            yield StopIteration
-
-    with mock.patch("redis.Redis"):
-        pubsub = redis.Redis().pubsub()
-        messages = pubsub_msg_generator()
-        pubsub.get_message.side_effect = lambda timeout: next(messages)
-        connector = QtRedisConnector("localhost:1")
-        bec_dispatcher.client.connector = connector
-        yield bec_dispatcher
-
-
-dummy_msg = MsgpackSerialization.dumps(ScanMessage(point_id=0, scan_id="0", data={}))
-
-
-@pytest.mark.parametrize(
-    "topics_msg_list",
-    [
-        (
-            ("topic1", dummy_msg),
-            ("topic2", dummy_msg),
-            ("topic3", dummy_msg),
-        )
-    ],
-)
-def test_dispatcher_disconnect_all(bec_dispatcher_w_connector, qtbot):
-    bec_dispatcher = bec_dispatcher_w_connector
-    cb1 = mock.Mock(spec=[])
-    cb2 = mock.Mock(spec=[])
-
-    bec_dispatcher.connect_slot(cb1, "topic1")
-    bec_dispatcher.connect_slot(cb1, "topic2")
-    bec_dispatcher.connect_slot(cb2, "topic2")
-    bec_dispatcher.connect_slot(cb2, "topic3")
-    assert len(bec_dispatcher.client.connector._topics_cb) == 3
-
-    bec_dispatcher.disconnect_all()
-
-    assert len(bec_dispatcher.client.connector._topics_cb) == 0