interactive-pipe 0.8.3__tar.gz → 0.8.4__tar.gz

{interactive_pipe-0.8.3/src/interactive_pipe.egg-info → interactive_pipe-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: interactive_pipe
-Version: 0.8.3
+Version: 0.8.4
 Summary: Library to create flexible interactive image processing pipelines and automatically add a graphical user interface without knowing anything about GUI coding!
 Author-email: Balthazar Neveu <balthazarneveu@gmail.com>
 Project-URL: Homepage, https://github.com/balthazarneveu/interactive_pipe
@@ -106,7 +106,7 @@ pip install -e ".[full]"
 
 ## :scroll:  Features
 
-**Version 0.8.3**
+**Version 0.8.4**
 - Modular multi-image processing filters
 - Declarative: Easily make graphical user interface without having to learn anything about pyQt or matplotlib
 - Support in jupyter notebooks
@@ -117,6 +117,7 @@ pip install -e ".[full]"
 - :new: gradio backend (+allows sharing with others). 
 - :new: Audio support in Gradio (live audio or display several players by returning 1D numpy arrays)
 - :new: Circular sliders for Qt Backend
+- :new: Text prompt (`free_text=("Hello world!", None),`)
 
 
 

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "interactive_pipe"
-version = "0.8.3"
+version = "0.8.4"
 authors = [
   { name="Balthazar Neveu", email="balthazarneveu@gmail.com" },
 ]

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4}/readme.md

@@ -62,7 +62,7 @@ pip install -e ".[full]"
 
 ## :scroll:  Features
 
-**Version 0.8.3**
+**Version 0.8.4**
 - Modular multi-image processing filters
 - Declarative: Easily make graphical user interface without having to learn anything about pyQt or matplotlib
 - Support in jupyter notebooks
@@ -73,6 +73,7 @@ pip install -e ".[full]"
 - :new: gradio backend (+allows sharing with others). 
 - :new: Audio support in Gradio (live audio or display several players by returning 1D numpy arrays)
 - :new: Circular sliders for Qt Backend
+- :new: Text prompt (`free_text=("Hello world!", None),`)
 
 
 

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4}/src/interactive_pipe/__init__.py

@@ -1,6 +1,6 @@
-__version__ = "0.8.3"
+__version__ = "0.8.4"
 from interactive_pipe.helper.pipeline_decorator import pipeline, interactive_pipeline
-from interactive_pipe.headless.control import Control, CircularControl
+from interactive_pipe.headless.control import Control, CircularControl, TextPrompt
 from interactive_pipe.data_objects.curves import Curve, SingleCurve
 from interactive_pipe.data_objects.image import Image
 from interactive_pipe.headless.keyboard import KeyboardControl

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4}/src/interactive_pipe/graphical/gradio_control.py

@@ -29,7 +29,7 @@ class ControlFactory:
             bool: TickBoxControl,
             int: IntSliderControl,
             float: FloatSliderControl,
-            str: DropdownMenuControl if control.icons is None else IconButtonsControl
+            str: PromptControl if control.value_range is None else (DropdownMenuControl if control.icons is None else IconButtonsControl),
         }
 
         if control_type not in control_class_map:
@@ -90,15 +90,17 @@ class DropdownMenuControl(BaseControl):
             raise ValueError("Invalid control type")
 
     def create(self) -> gr.Dropdown:
-        # Create a horizontal layout to hold the dropdown menu
         self.control_widget = gr.Dropdown(label=self.name, choices=self.ctrl.value_range, value=self.ctrl.value)
         return self.control_widget
 
-    def reset(self):
-        index = self.control_widget.findText(self.ctrl.value)
-        if index >= 0:
-            self.control_widget.setCurrentIndex(index)
-        self.control_widget.setCurrentIndex(index)
+
+class PromptControl(BaseControl):
+    def check_control_type(self):
+        assert self.ctrl._type == str
+
+    def create(self) -> gr.Text:
+        self.control_widget = gr.Text(label=self.name, value=self.ctrl.value)
+        return self.control_widget
 
 
 class IconButtonsControl(BaseControl):

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4}/src/interactive_pipe/graphical/mpl_control.py

@@ -1,4 +1,4 @@
-from matplotlib.widgets import Slider, CheckButtons, RadioButtons
+from matplotlib.widgets import Slider, CheckButtons, RadioButtons, TextBox
 from interactive_pipe.headless.control import Control
 import logging
 
@@ -58,6 +58,7 @@ class BoolCheckButtonMatplotlibControl(BaseControl):
 class StringRadioButtonMatplotlibControl(BaseControl):
     def check_control_type(self):
         assert self.ctrl._type == str
+        assert self.ctrl.value_range is not None
 
     def create(self):
         options = self.ctrl.value_range
@@ -68,6 +69,26 @@ class StringRadioButtonMatplotlibControl(BaseControl):
         return radio
 
 
+
+class PromptMatplotlibControl(BaseControl):
+    def check_control_type(self):
+        assert self.ctrl._type == str
+        assert self.ctrl.value_range is None
+
+    def create(self):
+        # Create a prompt for text input
+        self.text_box = TextBox(self.ax_control, 'Input', initial=self.ctrl.value)
+
+        # Function to handle the update when text is entered
+        def submit(text):
+            self.update_func(self.name, text)
+
+        # Connect the submission of the text box to the submit function
+        self.text_box.on_submit(submit)
+
+        return self.text_box
+
+
 class ControlFactory:
     @staticmethod
     def create_control(control: Control, update_func, ax_control=None):
@@ -77,7 +98,7 @@ class ControlFactory:
             bool: BoolCheckButtonMatplotlibControl,
             int: IntSliderMatplotlibControl,
             float: FloatSliderMatplotlibControl,
-            str: StringRadioButtonMatplotlibControl,
+            str: PromptMatplotlibControl if control.value_range is None else StringRadioButtonMatplotlibControl,
         }
 
         if control_type not in control_class_map:

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4}/src/interactive_pipe/graphical/mpl_gui.py

@@ -147,7 +147,7 @@ class MainWindow(MatplotlibWindow):
                 self.main_gui.bind_keyboard_slider(
                     ctrl, self.key_update_parameter)
                 continue
-            if ctrl._type == bool or ctrl._type == str:
+            if ctrl._type == bool or (ctrl._type == str and ctrl.value_range is not None):
                 x_start = 0.01
                 width = 0.08
                 number_of_items = (1 if ctrl._type ==
@@ -155,10 +155,12 @@ class MainWindow(MatplotlibWindow):
                 height = 0.02 * number_of_items
                 y_start = self.next_slider_position - height
                 self.next_slider_position -= self.spacer + height
-            elif ctrl._type == float or ctrl._type == int:
+            elif ctrl._type == float or ctrl._type == int or (ctrl._type == str and ctrl.value_range is None):
                 x_start = 0.25
                 width = 0.65
                 height = 0.02
+                if ctrl._type == str:
+                    height = 0.05
                 y_start = self.next_button_position - height
                 self.next_button_position -= self.spacer + height
             if not dry_run:

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4}/src/interactive_pipe/graphical/qt_control.py

@@ -30,6 +30,7 @@ if not PYQTVERSION:
     except ImportError:
         logging.warning("Cannot import PySide")
 
+
 class BaseControl(QWidget):
     def __init__(self, name, ctrl: Control, update_func, silent=False):
         super().__init__()
@@ -58,7 +59,8 @@ class ControlFactory:
             bool: TickBoxControl,
             int: IntSliderControl,
             float: FloatSliderControl,
-            str: DropdownMenuControl if control.icons is None else IconButtonsControl
+            str: PromptControl if control.value_range is None else (
+                DropdownMenuControl if control.icons is None else IconButtonsControl)
         }
 
         if control_type not in control_class_map:
@@ -96,7 +98,7 @@ class IntSliderControl(BaseControl):
             else:
                 slider_class = QSlider
                 slider = slider_class(Qt.Orientation.Horizontal, self)
-                
+
         slider.setRange(self.ctrl.value_range[0],  self.ctrl.value_range[1])
         slider.setValue(self.ctrl.value_default)
         slider.setSingleStep(1)
@@ -222,6 +224,39 @@ class DropdownMenuControl(BaseControl):
         self.control_widget.setCurrentIndex(index)
 
 
+class PromptControl(BaseControl):
+    def check_control_type(self):
+        assert self.ctrl._type == str
+        assert self.ctrl.value_range is None
+
+    def create(self):
+        # Create a horizontal layout to hold the text prompt
+        hbox = QHBoxLayout()
+
+        # Create the line edit (text input field)
+        self.control_widget = QLineEdit(self)
+
+        # Set the initial value of the text field if it's provided
+        if self.ctrl.value:
+            self.control_widget.setText(self.ctrl.value)
+
+        # Connect the textChanged signal to the update function if needed
+        self.control_widget.textChanged.connect(partial(self.update_func, self.name))
+
+        # Add the text input field to the horizontal layout
+        hbox.addWidget(self.control_widget)
+
+        # Add a label to the layout
+        label = QLabel(self.name, self)
+        hbox.addWidget(label)
+
+        return hbox
+
+    def reset(self):
+        # Reset the text field to the initial value
+        self.control_widget.setText(self.ctrl.value)
+
+
 class TickBoxControl(BaseControl):
     def check_control_type(self):
         assert self.ctrl._type == bool

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4}/src/interactive_pipe/graphical/qt_gui.py

@@ -387,7 +387,10 @@ class MainWindow(QWidget, InteractivePipeWindow):
     def update_parameter(self, idx, value):
         """Required implementation for graphical controllers update"""
         if self.ctrl[idx]._type == str:
-            self.ctrl[idx].update(self.ctrl[idx].value_range[value])
+            if self.ctrl[idx].value_range is None:
+                self.ctrl[idx].update(value)
+            else:
+                self.ctrl[idx].update(self.ctrl[idx].value_range[value])
         elif self.ctrl[idx]._type == bool:
             self.ctrl[idx].update(bool(value))
         elif self.ctrl[idx]._type == float:

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4}/src/interactive_pipe/headless/control.py

@@ -51,15 +51,19 @@ class Control():
                 assert value_default >= value_range[0] and value_default <= value_range[1]
         elif isinstance(value_default, str):
             # similar to an enum
-            assert value_range
-            assert isinstance(value_range, list) or isinstance(
-                value_range, tuple)
-            for choice in value_range:
-                assert isinstance(choice, str)
-            assert value_default in value_range, f"{value_default} shall be in {value_range}"
-            self._type = str
-            if self.step is None:
-                step = 1
+            if value_range is None:
+                logging.debug("string prompt only - no range")
+                self._type = str
+            else:
+                assert value_range
+                assert isinstance(value_range, list) or isinstance(
+                    value_range, tuple)
+                for choice in value_range:
+                    assert isinstance(choice, str)
+                assert value_default in value_range, f"{value_default} shall be in {value_range}"
+                self._type = str
+                if self.step is None:
+                    step = 1
         else:
             raise TypeError("Wrong value type")
         self.value_range = value_range
@@ -94,7 +98,7 @@ class Control():
         assert isinstance(value, self._type), f"{type(value)} != {self._type}"
         if isinstance(value, float) or isinstance(value, int) and self.value_range:
             return max(self.value_range[0], min(value, self.value_range[1]))
-        elif self._type == str:
+        elif self._type == str and self.value_range is not None:
             assert value in self.value_range, f"{value} shall be in {self.value_range}"
             return value
         else:
@@ -150,10 +154,19 @@ class CircularControl(Control):
     Replace a slider by a circular slider
     """
 
-    def __init__(self, value_default: Union[int, float, bool, str], value_range: List[Union[int, float, str]] = None, modulo=True, name=None, step=None, filter_to_connect: Optional[FilterCore] = None, parameter_name_to_connect: Optional[str] = None) -> None:
+    def __init__(self, value_default: Union[int, float], value_range: List[Union[int, float]] = None, modulo=True, name=None, step=None, filter_to_connect: Optional[FilterCore] = None, parameter_name_to_connect: Optional[str] = None) -> None:
         super().__init__(value_default=value_default, value_range=value_range, name=name, step=step,
                          filter_to_connect=filter_to_connect, parameter_name_to_connect=parameter_name_to_connect, icons=None)
         self.modulo = modulo
 
     def __repr__(self) -> str:
         return super().__repr__() + f"| modulo:{self.modulo}"
+
+
+class TextPrompt(Control):
+    def __init__(self, value_default: str, name=None, filter_to_connect: Optional[FilterCore] = None, parameter_name_to_connect: Optional[str] = None) -> None:
+        super().__init__(value_default=value_default, value_range=None, name=name, step=None,
+                         filter_to_connect=filter_to_connect, parameter_name_to_connect=parameter_name_to_connect, icons=None)
+
+    def __repr__(self) -> str:
+        return super().__repr__()

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4}/src/interactive_pipe/helper/control_abbreviation.py

@@ -126,11 +126,14 @@ def control_from_tuple(short_params: Tuple, param_name: str = None) -> Union[Con
             assert len(
                 short_params) >= 2, f"providing a value range is mandatory like (min, max) or (min, max, step)"
             value_range = short_params[start]
-            assert isinstance(value_range, list) or isinstance(
-                value_range, tuple), f"value range should be a tuple or a list, provided {value_range}"
-            if (isinstance(value_default, float) or isinstance(value_default, int)) and len(value_range) >= 3:
-                step = value_range[2]
-                value_range = value_range[:2]
+            if value_range is None:
+                pass
+            else:
+                assert isinstance(value_range, list) or isinstance(
+                    value_range, tuple), f"value range should be a tuple or a list, provided {value_range}"
+                if (isinstance(value_default, float) or isinstance(value_default, int)) and len(value_range) >= 3:
+                    step = value_range[2]
+                    value_range = value_range[:2]
         else:
             # ["cat", "dog", "tree"] -> default value = "cat"
             # [-10, 10, 1] -> default val = average(-10, 10), step=1

{interactive_pipe-0.8.3 → interactive_pipe-0.8.4/src/interactive_pipe.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: interactive_pipe
-Version: 0.8.3
+Version: 0.8.4
 Summary: Library to create flexible interactive image processing pipelines and automatically add a graphical user interface without knowing anything about GUI coding!
 Author-email: Balthazar Neveu <balthazarneveu@gmail.com>
 Project-URL: Homepage, https://github.com/balthazarneveu/interactive_pipe
@@ -106,7 +106,7 @@ pip install -e ".[full]"
 
 ## :scroll:  Features
 
-**Version 0.8.3**
+**Version 0.8.4**
 - Modular multi-image processing filters
 - Declarative: Easily make graphical user interface without having to learn anything about pyQt or matplotlib
 - Support in jupyter notebooks
@@ -117,6 +117,7 @@ pip install -e ".[full]"
 - :new: gradio backend (+allows sharing with others). 
 - :new: Audio support in Gradio (live audio or display several players by returning 1D numpy arrays)
 - :new: Circular sliders for Qt Backend
+- :new: Text prompt (`free_text=("Hello world!", None),`)