bec-widgets 0.109.0__py3-none-any.whl → 0.109.1__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v0.109.1 (2024-09-09)
+
+### Fix
+
+* fix: refactor textbox widget, remove inheritance, adhere to bec style; closes #324 ([`b0d786b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b0d786b991677c0846a0c6ba3f2252d48d94ccaa))
+
 ## v0.109.0 (2024-09-06)
 
 ### Feature
@@ -154,12 +160,6 @@
 
 * docs(becwidget): improvements to the bec widget base class docs; fixed type hint import for sphinx ([`99d5e8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/99d5e8e71c7f89a53d7967126f4056dde005534c))
 
-### Feature
-
-* feat(theme): added theme handler to bec widget base class; added tests ([`7fb938a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7fb938a8506685278ee5eeb6fe9a03f74b713cf8))
-
 ### Fix
 
 * fix(pyqt slot): removed slot decorator to avoid problems with pyqt6 ([`6c1f89a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6c1f89ad39b7240ab1d1c1123422b99ae195bf01))
-
-## v0.99.15 (2024-08-31)

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.109.0
+Version: 0.109.1
 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/cli/client.py

@@ -2914,31 +2914,21 @@ class StopButton(RPCBase):
 
 class TextBox(RPCBase):
     @rpc_call
-    def set_color(self, background_color: str, font_color: str) -> None:
+    def set_plain_text(self, text: str) -> None:
         """
-        Set the background color of the widget.
-
-        Args:
-            background_color (str): The color to set the background in HEX.
-            font_color (str): The color to set the font in HEX.
-        """
-
-    @rpc_call
-    def set_text(self, text: str) -> None:
-        """
-        Set the text of the widget.
+        Set the plain text of the widget.
 
         Args:
             text (str): The text to set.
         """
 
     @rpc_call
-    def set_font_size(self, size: int) -> None:
+    def set_html_text(self, text: str) -> None:
         """
-        Set the font size of the text in the widget.
+        Set the HTML text of the widget.
 
         Args:
-            size (int): The font size to set.
+            text (str): The text to set.
         """
 
 

bec_widgets/widgets/text_box/text_box.py

@@ -1,39 +1,47 @@
+"""Module for a text box widget that displays text in plain and HTML format and adheres to the BECWidget interface & style."""
+
 import re
+from html.parser import HTMLParser
 
-from pydantic import Field, field_validator
-from qtpy.QtWidgets import QTextEdit
+from bec_lib.logger import bec_logger
+from pydantic import Field
+from qtpy.QtCore import Property, Slot
+from qtpy.QtWidgets import QTextEdit, QVBoxLayout, QWidget
 
 from bec_widgets.utils.bec_connector import ConnectionConfig
 from bec_widgets.utils.bec_widget import BECWidget
-from bec_widgets.utils.colors import Colors
+
+logger = bec_logger.logger
+
+DEFAULT_TEXT = "<h1>Welcome to the BEC Widget TextBox</h1><p>A widget that allows user to display text in plain and HTML format.</p><p>This is an example of displaying HTML text.</p>"
 
 
 class TextBoxConfig(ConnectionConfig):
+    """Configuration for the TextBox widget.
 
-    theme: str = Field("dark", description="The theme of the figure widget.")
-    font_color: str = Field("#FFF", description="The font color of the text")
-    background_color: str = Field("#000", description="The background color of the widget.")
-    font_size: int = Field(16, description="The font size of the text in the widget.")
-    text: str = Field("", description="The text to display in the widget.")
+    Args:
+        text (str, optional): The text to display in the widget. Defaults to None.
+        is_html (bool, optional): Whether the text is in HTML format or not. Defaults to False.
+    """
 
-    @classmethod
-    @field_validator("theme")
-    def validate_theme(cls, v):
-        """Validate the theme of the figure widget."""
-        if v not in ["dark", "light"]:
-            raise ValueError("Theme must be either 'dark' or 'light'")
-        return v
+    text: str | None = Field(None, description="The text to display in the widget.")
+    is_html: bool = Field(False, description="Whether the text is in HTML format or not.")
 
-    _validate_font_color = field_validator("font_color")(Colors.validate_color)
-    _validate_background_color = field_validator("background_color")(Colors.validate_color)
 
+class TextBox(BECWidget, QWidget):
+    """A widget that displays text in plain and HTML format
 
-class TextBox(BECWidget, QTextEdit):
+    Args:
+        parent (QWidget, optional): The parent widget. Defaults to None.
+        client ([type], optional): The client to use. Defaults to None.
+        config ([type], optional): The config to use. Defaults to None.
+        gui_id ([type], optional): The gui_id to use. Defaults to None.
+    """
 
-    USER_ACCESS = ["set_color", "set_text", "set_font_size"]
+    USER_ACCESS = ["set_plain_text", "set_html_text"]
     ICON_NAME = "chat"
 
-    def __init__(self, parent=None, text: str = "", client=None, config=None, gui_id=None):
+    def __init__(self, parent=None, client=None, config=None, gui_id=None):
         if config is None:
             config = TextBoxConfig(widget_class=self.__class__.__name__)
         else:
@@ -41,80 +49,79 @@ class TextBox(BECWidget, QTextEdit):
                 config = TextBoxConfig(**config)
             self.config = config
         super().__init__(client=client, config=config, gui_id=gui_id)
-        QTextEdit.__init__(self, parent=parent)
-
+        QWidget.__init__(self, parent)
+        self.layout = QVBoxLayout(self)
+        self.text_box_text_edit = QTextEdit(parent=self)
+        self.layout.addWidget(self.text_box_text_edit)
+        self.setLayout(self.layout)
+        self.layout.setContentsMargins(0, 0, 0, 0)
         self.config = config
-        self.setReadOnly(True)
-        self.setGeometry(self.rect())
-        self.set_color(self.config.background_color, self.config.font_color)
-        if not text:
-            text = "<h1>Welcome to the BEC Widget TextBox</h1><p>A widget that allows user to display text in plain and HTML format.</p><p>This is an example of displaying HTML text.</p>"
-        self.set_text(text)
-
-    def change_theme(self) -> None:
-        """
-        Change the theme of the figure widget.
-        """
-        if self.config.theme == "dark":
-            theme = "light"
-            font_color = "#000"
-            background_color = "#FFF"
+        self.text_box_text_edit.setReadOnly(True)
+        if self.config.text is not None:
+            if self.config.is_html:
+                self.set_html_text(self.config.text)
+            else:
+                self.set_plain_text(self.config.text)
         else:
-            theme = "dark"
-            font_color = "#FFF"
-            background_color = "#000"
-        self.config.theme = theme
-        self.set_color(background_color, font_color)
+            self.set_html_text(DEFAULT_TEXT)
 
-    def set_color(self, background_color: str, font_color: str) -> None:
-        """Set the background color of the widget.
+    @Slot(str)
+    def set_plain_text(self, text: str) -> None:
+        """Set the plain text of the widget.
 
         Args:
-            background_color (str): The color to set the background in HEX.
-            font_color (str): The color to set the font in HEX.
-
+            text (str): The text to set.
         """
-        self.config.background_color = background_color
-        self.config.font_color = font_color
-        self._update_stylesheet()
+        self.text_box_text_edit.setPlainText(text)
+        self.config.text = text
+        self.config.is_html = False
 
-    def set_font_size(self, size: int) -> None:
-        """Set the font size of the text in the widget.
+    @Slot(str)
+    def set_html_text(self, text: str) -> None:
+        """Set the HTML text of the widget.
 
         Args:
-            size (int): The font size to set.
+            text (str): The text to set.
         """
-        self.config.font_size = size
-        self._update_stylesheet()
+        self.text_box_text_edit.setHtml(text)
+        self.config.text = text
+        self.config.is_html = True
 
-    def _update_stylesheet(self):
-        """Update the stylesheet of the widget."""
-        self.setStyleSheet(
-            f"background-color: {self.config.background_color}; color: {self.config.font_color}; font-size: {self.config.font_size}px"
-        )
+    @Property(str)
+    def plain_text(self) -> str:
+        """Get the text of the widget.
 
-    def set_text(self, text: str) -> None:
+        Returns:
+            str: The text of the widget.
+        """
+        return self.text_box_text_edit.toPlainText()
+
+    @plain_text.setter
+    def plain_text(self, text: str) -> None:
         """Set the text of the widget.
 
         Args:
             text (str): The text to set.
         """
-        if self.is_html(text):
-            self.setHtml(text)
-        else:
-            self.setPlainText(text)
-        self.config.text = text
-
-    def is_html(self, text: str) -> bool:
-        """Check if the text contains HTML tags.
+        self.set_plain_text(text)
 
-        Args:
-            text (str): The text to check.
+    @Property(str)
+    def html_text(self) -> str:
+        """Get the HTML text of the widget.
 
         Returns:
-            bool: True if the text contains HTML tags, False otherwise.
+            str: The HTML text of the widget.
         """
-        return bool(re.search(r"<[a-zA-Z/][^>]*>", text))
+        return self.text_box_text_edit.toHtml()
+
+    @html_text.setter
+    def html_text(self, text: str) -> None:
+        """Set the HTML text of the widget.
+
+        Args:
+            text (str): The HTML text to set.
+        """
+        self.set_html_text(text)
 
 
 if __name__ == "__main__":
@@ -123,7 +130,6 @@ if __name__ == "__main__":
     from qtpy.QtWidgets import QApplication
 
     app = QApplication(sys.argv)
-
     widget = TextBox()
     widget.show()
     sys.exit(app.exec())

{bec_widgets-0.109.0.dist-info → bec_widgets-0.109.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.109.0
+Version: 0.109.1
 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-0.109.0.dist-info → bec_widgets-0.109.1.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=Dc1iDjsc72UxdUtihx4uSZU0lrTQeR8hZwGx1MQBfKE,8432
 .pylintrc,sha256=eeY8YwSI74oFfq6IYIbCqnx3Vk8ZncKaatv96n_Y8Rs,18544
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=bgDc0rOOjtX6B9h8AhdM62BYiL3g22MWq3A5H-O3QMM,7258
+CHANGELOG.md,sha256=83toIm-bLOmMXqLc9D_TuEkaAmajXcVh2gp_jSZ0N1o,7266
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=1CGyi--Q2TVQN36On9aWRM3ZgGhJTV-2DTyeuyRwIdw,1334
+PKG-INFO,sha256=zZkCksUj3vS0F-9_qaUXWatTcIGMUxtUYALlYIAmQeo,1334
 README.md,sha256=Od69x-RS85Hph0-WwWACwal4yUd67XkEn4APEfHhHFw,2649
-pyproject.toml,sha256=IM5KF7HZkkzb-e_nVkRg72j5C4OvcTooeYqd1mB8ddM,2544
+pyproject.toml,sha256=Acf6n5A69AFyAgZ3AJrP3hmbHsi7XEZNGXe0ic-zuDE,2544
 .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
@@ -22,7 +22,7 @@ bec_widgets/assets/status_icons/running.svg,sha256=nlc6rKh_f-uOxQSk0BkBNyWnPAJU5
 bec_widgets/assets/status_icons/warning.svg,sha256=CNx88p9kbDG51s9ztKf-cfYan4JdDBbk3-IFKfOOFlI,364
 bec_widgets/cli/__init__.py,sha256=d0Q6Fn44e7wFfLabDOBxpcJ1DPKWlFunGYDUBmO-4hA,22
 bec_widgets/cli/auto_updates.py,sha256=DwzRChcFIWPH2kCYvp8H7dXvyYSKGYv6LwCmK2sDR2E,5676
-bec_widgets/cli/client.py,sha256=aG1m5xXbIsn0Cq7isrUgyA_l4yLFgbKsmmiXye6yPp8,81550
+bec_widgets/cli/client.py,sha256=_sgO24vbZnc-dRPZjH_sDfvYHHvR-OeYkQmr_oGuSbU,81230
 bec_widgets/cli/client_utils.py,sha256=EdDfo3uuYAWtZiDGGu3_GPnl94FSLkNG2N_4I9FNfMc,11809
 bec_widgets/cli/generate_cli.py,sha256=zRhhcErjHqnNymoxu9oqeUZUfwLX84De1RIeGiZGUyY,6602
 bec_widgets/cli/rpc_register.py,sha256=QxXUZu5XNg00Yf5O3UHWOXg3-f_pzKjjoZYMOa-MOJc,2216
@@ -226,7 +226,7 @@ bec_widgets/widgets/stop_button/stop_button.pyproject,sha256=Cc_xbv-zfzNVpsdg_1Q
 bec_widgets/widgets/stop_button/stop_button_plugin.py,sha256=VT-WVLq89fw7PwML7JDMCF1bqfopLCZIgMA4yetl65M,1365
 bec_widgets/widgets/text_box/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/text_box/register_text_box.py,sha256=UwrmCoYjAAtJJK8BwC0P_wSb-lOlOvxPe3-Bemg_9nw,459
-bec_widgets/widgets/text_box/text_box.py,sha256=urkHtDQBSf4ws5BcpYIe5cfj-r-GXQOngcGUVYWvgRo,4297
+bec_widgets/widgets/text_box/text_box.py,sha256=S1VQwTkZje2x4iwjTEzd6zPP_wcHtIcx8o9KuCtsSbY,4247
 bec_widgets/widgets/text_box/text_box.pyproject,sha256=XohO1BIe2hrpU-z_KHKRgjcUkXru7jeFte31j2TPbNk,26
 bec_widgets/widgets/text_box/text_box_plugin.py,sha256=rjRxqqovggpiI3gfQrXU-uc7TEjugIameQBrFD6s9hY,1302
 bec_widgets/widgets/toggle/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -255,8 +255,8 @@ bec_widgets/widgets/website/register_website_widget.py,sha256=LIQJpV9uqcBiPR9cEA
 bec_widgets/widgets/website/website.py,sha256=42pncCc_zI2eqeMArIurVmPUukRo5bTxa2h1Skah-io,3012
 bec_widgets/widgets/website/website_widget.pyproject,sha256=scOiV3cV1_BjbzpPzy2N8rIJL5P2qIZz8ObTJ-Uvdtg,25
 bec_widgets/widgets/website/website_widget_plugin.py,sha256=pz38_C2cZ0yvPPS02wdIPcmhFo_yiwUhflsASocAPQQ,1341
-bec_widgets-0.109.0.dist-info/METADATA,sha256=1CGyi--Q2TVQN36On9aWRM3ZgGhJTV-2DTyeuyRwIdw,1334
-bec_widgets-0.109.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-bec_widgets-0.109.0.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
-bec_widgets-0.109.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.109.0.dist-info/RECORD,,
+bec_widgets-0.109.1.dist-info/METADATA,sha256=zZkCksUj3vS0F-9_qaUXWatTcIGMUxtUYALlYIAmQeo,1334
+bec_widgets-0.109.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+bec_widgets-0.109.1.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
+bec_widgets-0.109.1.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.109.1.dist-info/RECORD,,

pyproject.toml

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