syd 1.2.0__py3-none-any.whl → 1.2.2__py3-none-any.whl

syd/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.2.0"
+__version__ = "1.2.2"
 
 from .viewer import make_viewer, Viewer
 from .support import show_open_servers, close_servers

syd/flask_deployment/deployer.py

@@ -252,6 +252,7 @@ class FlaskDeployer:
                 with plot_context():
                     # Use the viewer's plot method with its current state
                     fig = self.viewer.plot(self.viewer.state)
+                    self.viewer._figure = fig
                     if not isinstance(fig, mpl.figure.Figure):
                         raise TypeError(
                             f"viewer.plot() must return a matplotlib Figure, but got {type(fig)}"
@@ -310,6 +311,7 @@ class FlaskDeployer:
                     return jsonify({"error": f"Parameter '{name}' not found"}), 404
 
                 parameter = self.viewer.parameters[name]
+                replot = True
 
                 # Optionally suppress warnings during updates
                 with warnings.catch_warnings():
@@ -323,6 +325,7 @@ class FlaskDeployer:
                         if isinstance(parameter, ButtonAction) and parameter.callback:
                             # Pass the current state dictionary to the callback
                             parameter.callback(self.viewer.state)
+                            replot = parameter.replot
                         else:
                             app.logger.warning(
                                 f"Received action request for non-action parameter: {name}"
@@ -351,7 +354,12 @@ class FlaskDeployer:
                     for name, param in self.viewer.parameters.items()
                 }
                 return jsonify(
-                    {"success": True, "state": final_state, "params": final_param_info}
+                    {
+                        "success": True,
+                        "state": final_state,
+                        "params": final_param_info,
+                        "replot": replot,
+                    }
                 )
 
             except Exception as e:

syd/flask_deployment/static/js/modules/api.js

@@ -48,7 +48,7 @@ export async function updateParameterOnServer(name, value, action = false) {
         if (!response.ok) {
             throw new Error(`HTTP error! status: ${response.status}`);
         }
-        return await response.json(); // Return the server response (likely includes updated state)
+        return await response.json(); // Return the server response
     } catch (error) {
         console.error('Error updating parameter:', error);
         updateStatus('Error updating parameter');
@@ -76,8 +76,9 @@ export function handleButtonClick(name) {
             } else {
                 // Update state with any changes from callbacks
                 updateStateFromServer(data.state, data.params);
-                // Update plot if needed (plot.js handles this now)
-                updatePlot();
+                if (data.replot) {
+                    updatePlot();
+                }
                 updateStatus('Ready!');
             }
         })

syd/notebook_deployment/deployer.py

@@ -244,15 +244,18 @@ class NotebookDeployer:
                     # If the component is an action, call the callback
                     parameter = self.viewer.parameters[name]
                     parameter.callback(self.viewer.state)
+                    replot = parameter.replot
                 else:
                     # Otherwise, update the parameter value
                     self.viewer.set_parameter_value(name, component.value)
+                    replot = True
 
                 # Update any components that changed due to dependencies
                 self.sync_components_with_state()
 
                 # Update the plot
-                self.update_plot()
+                if replot:
+                    self.update_plot()
 
     def sync_components_with_state(self, exclude: Optional[str] = None) -> None:
         """Sync component values with viewer state."""
@@ -270,6 +273,7 @@ class NotebookDeployer:
 
         with plot_context():
             figure = self.viewer.plot(state)
+            self.viewer._figure = figure
 
         # Update components if plot function updated a parameter
         self.sync_components_with_state()
@@ -296,7 +300,13 @@ class NotebookDeployer:
                     display(figure.canvas)
 
                 else:
-                    raise ValueError(f"Unsupported backend type: {self.backend_type}")
+                    display(figure)
+                    plt.close(figure)
+                    print(
+                        f"Backend type: ({self.backend_type}) is not explicitly supported."
+                        "If you encounter weird behavior, try restarting with '%matplotlib inline' or '%matplotlib widget'."
+                        "And please report this issue on github please :)."
+                    )
 
             if store_figure:
                 self._last_figure = figure

syd/parameters.py

@@ -1305,12 +1305,15 @@ class ButtonAction(Parameter[None]):
         Text to display on the button (default is the button's name)
     callback : callable
         Function to execute when the button is clicked
+    replot : bool, optional
+        Whether to replot the figure after the callback is called.
+        (default: True)
 
     Examples
     --------
     >>> def print_hello():
     ...     print("Hello!")
-    >>> button = ButtonAction("greeting", label="Say Hello", callback=print_hello)
+    >>> button = ButtonAction("greeting", label="Say Hello", callback=print_hello, replot=False)
     >>> button.callback()  # Simulates clicking the button
     Hello!
     >>> # Update the button's label and callback
@@ -1323,14 +1326,14 @@ class ButtonAction(Parameter[None]):
     Notes
     -----
     Unlike other Parameter types, ButtonAction:
-    - Has no value (always None)
-    - Is marked as an action (_is_action = True)
+    - Has no value (always None, therefore cannot be updated through the value property
     - Executes code directly rather than storing state
-    - Cannot be updated through the value property
+    - Has an option to turn off replotting after the callback is called for cases where you want to access the last figure only.
     """
 
     label: str
     callback: Callable
+    replot: bool
     value: None = field(default=None, repr=False)
     _is_action: bool = field(default=True, repr=False)
 
@@ -1339,6 +1342,7 @@ class ButtonAction(Parameter[None]):
         name: str,
         label: Union[str, NoInitialValue],
         callback: Callable,
+        replot: bool = True,
     ):
         """
         Initialize a button.
@@ -1351,12 +1355,16 @@ class ButtonAction(Parameter[None]):
             Text to display on the button (default is the button's name)
         callback : callable
             Function to execute when the button is clicked
+        replot : bool, optional
+            Whether to replot the figure after the callback is called.
+            (default: True)
         """
         self.name = name
         if isinstance(label, NoInitialValue):
             label = name
         self.label = label
         self.callback = callback
+        self.replot = replot
         self._value = None
 
     def _validate(self, new_value: Any) -> None:
@@ -1371,6 +1379,12 @@ class ButtonAction(Parameter[None]):
                 type(self).__name__,
                 f"Callback {self.callback} is not callable",
             )
+        if not isinstance(self.replot, bool):
+            raise ParameterUpdateError(
+                self.name,
+                type(self).__name__,
+                f"Replet must be a boolean, got {type(self.replot)}",
+            )
         try:
             str(self.label)
         except Exception:

syd/support.py

@@ -1,5 +1,5 @@
 from abc import ABCMeta
-from typing import Any, List
+from typing import Any, List, Union
 from warnings import warn
 from contextlib import contextmanager
 import matplotlib.pyplot as plt
@@ -12,7 +12,7 @@ def show_open_servers():
     print(server_manager.servers)
 
 
-def close_servers(port: int | None = None):
+def close_servers(port: Union[int, None] = None):
     """Close any Flask servers running on a given port (or all of them).
 
     Parameters

syd/viewer.py

@@ -157,12 +157,14 @@ class Viewer:
     >>> viewer = MyViewer()
     >>> viewer.add_float('x', value=1.0, min=0, max=10)
     >>> viewer.on_change('x', viewer.update_based_on_x)
+    >>> viewer.show()
     """
 
     parameters: Dict[str, Parameter]
     callbacks: Dict[str, List[Callable]]
     _app_deployed: bool
     _in_callbacks: bool
+    _figure: Figure
 
     def __new__(cls, *args, **kwargs):
         instance = super().__new__(cls)
@@ -170,6 +172,7 @@ class Viewer:
         instance.callbacks = {}
         instance._app_deployed = False
         instance._in_callbacks = False
+        instance._figure = None
         return instance
 
     @property
@@ -196,6 +199,13 @@ class Viewer:
             if not param._is_action
         }
 
+    @property
+    def figure(self) -> Figure:
+        """
+        Get the last opened figure. Returns None if no figure has been opened yet.
+        """
+        return self._figure
+
     def plot(self, state: Dict[str, Any]) -> Figure:
         """Create and return a matplotlib figure.
 
@@ -942,6 +952,7 @@ class Viewer:
         *,
         label: Union[str, NoInitialValue] = NO_INITIAL_VALUE,
         callback: Callable[[], None],
+        replot: bool = True,
     ) -> None:
         """
         Add a button parameter to the viewer.
@@ -959,16 +970,24 @@ class Viewer:
             If not provided, the parameter's label will be set to the name.
         callback : callable
             Function to call when the button is clicked (takes state as a single argument)
+        replot : bool, optional
+            Whether to replot the figure after the callback is called.
+            (default: True)
 
         Examples
         --------
-        >>> def reset_plot(state):
-        ...     print("Resetting plot...")
-        >>> viewer.add_button('reset', label='Reset Plot', callback=reset_plot)
+        >>> def save_figure(state):
+        ...     print("Saving figure...")
+        ...     viewer.figure.savefig('last_figure.png')
+        >>> viewer.add_button('save', label='Save Figure', callback=save_figure, replot=False)
 
         >>> def print_plot_info(state):
         ...     print(f"Current plot info: {state['plot_info']}")
-        >>> viewer.add_button('print_info', label='Print Plot Info', callback=print_plot_info)
+        >>> viewer.add_button('print_info', label='Print Plot Info', callback=print_plot_info, replot=False)
+
+        >>> def reset_plot(state):
+        ...     print("Resetting plot...")
+        >>> viewer.add_button('reset', label='Reset Plot', callback=reset_plot)
         """
         try:
             callback = self._prepare_function(
@@ -976,7 +995,7 @@ class Viewer:
                 context="Setting button callback:",
             )
 
-            new_param = ActionType.button.value(name, label, callback)
+            new_param = ActionType.button.value(name, label, callback, replot)
         except Exception as e:
             raise ParameterAddError(name, "button", str(e)) from e
         else:
@@ -1398,6 +1417,7 @@ class Viewer:
         *,
         label: Union[str, NoUpdate] = NO_UPDATE,
         callback: Union[Callable[[], None], NoUpdate] = NO_UPDATE,
+        replot: Union[bool, NoUpdate] = NO_UPDATE,
     ) -> None:
         """
         Update a button parameter's label and/or callback function.
@@ -1413,6 +1433,9 @@ class Viewer:
             New text to display on the button (if not provided, no change)
         callback : Union[callable, NoUpdate], optional
             New function to call when clicked (if not provided, no change)
+        replot : Union[bool, NoUpdate], optional
+            Whether to replot the figure after the callback is called.
+            (default: True)
 
         Examples
         --------
@@ -1420,7 +1443,8 @@ class Viewer:
         ...     print("New action...")
         >>> viewer.update_button('reset',
         ...                     label='New Action!',
-        ...                     callback=new_callback)
+        ...                     callback=new_callback,
+        ...                     replot=False)
         """
         updates = {}
         if not label == NO_UPDATE:
@@ -1439,5 +1463,7 @@ class Viewer:
                 ) from e
             else:
                 updates["callback"] = callback
+        if not replot == NO_UPDATE:
+            updates["replot"] = replot
         if updates:
             self.parameters[name].update(updates)

{syd-1.2.0.dist-info → syd-1.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: syd
-Version: 1.2.0
+Version: 1.2.2
 Summary: A Python package for making GUIs for data science easy.
 Project-URL: Homepage, https://github.com/landoskape/syd
 Author-email: Andrew Landau <andrew+tyler+landau+getridofthisanddtheplusses@gmail.com>

{syd-1.2.0.dist-info → syd-1.2.2.dist-info}/RECORD

@@ -1,16 +1,16 @@
-syd/__init__.py,sha256=ln2sVWmAbfLzF0oqYPE0g2TYdIqms9_Va984I0eBfiU,117
-syd/parameters.py,sha256=dlnYOVsi1CDtC2toVECf0kNBRipVrtUjr6XVX86b5MA,42886
-syd/support.py,sha256=WVvcKKHWChZWJewc9-vwSChGwmzXobxU5pNmrjrsC3k,6770
-syd/viewer.py,sha256=c53tJlnbnTCGDJEYhiuKZ76tU7Dcd7S8VWY_1O8aAN0,51692
+syd/__init__.py,sha256=mg2549tBmySVzaA-BQPGC2aEUzur6Cw_ppeM_najE8g,117
+syd/parameters.py,sha256=lzCHSMGYEdQ_FMbcXnntdPF1XvCm7fybB6CNy3TFn04,43543
+syd/support.py,sha256=LoHOsTN0byyDxk9uibjM0BKnI-vAJ4aU-tWILMCXz1Y,6783
+syd/viewer.py,sha256=d1-uca7WPEoH8InDUg1osK5uQU6RQ0QXydwS_81EME0,52681
 syd/flask_deployment/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-syd/flask_deployment/deployer.py,sha256=8W51sUZx7iUtFTseNacRa2XOgQVOGGR96nBf8NZS2Qg,29287
+syd/flask_deployment/deployer.py,sha256=GruWJ3pA6NI8tmMavQo4Sl8_jvZbFi1k8LGPPd2JkmU,29554
 syd/flask_deployment/testing_principles.md,sha256=GyULM97sDeie8h3tSPoduOckdMNGyWuwm1RdHo5jzK0,10130
 syd/flask_deployment/static/__init__.py,sha256=ieWE8NKR-APw7h4Ge0ooZGk6wZrneSSs_1cMyTPbQSA,65
 syd/flask_deployment/static/css/styles.css,sha256=GQgIPbWMdfTgU-HN80FCObA8bd1FPiwa1Dq0yRANsPc,5944
 syd/flask_deployment/static/css/viewer.css,sha256=rViWJ4w6vahuOr0RIpowgJfg7HN4TzMAuYrQmqhi1V0,805
 syd/flask_deployment/static/js/old_viewer.js,sha256=aIh0gxrwMWUYVge4taj0pucg2RiCcWVuV9ekBvUVsPU,40594
 syd/flask_deployment/static/js/viewer.js,sha256=D-I0hUZQPMSIgB9b8taWNVIsBBUeK1VpLjWI1KtOgSo,2672
-syd/flask_deployment/static/js/modules/api.js,sha256=WTx4SRIzsCLyB0yD94j836KR4npJPEJdW9pNKw5gsHc,3160
+syd/flask_deployment/static/js/modules/api.js,sha256=4qZW9DKH-IqslOKj4ypV5Vju9wr9Qfhckf7BQGk1KqM,3117
 syd/flask_deployment/static/js/modules/config.js,sha256=XxvyNhOUoyXXcacmhNzawKZiy9Q473sY98y7WipofLs,850
 syd/flask_deployment/static/js/modules/plot.js,sha256=dHZAaw_hjrrMa1IGet8HhYJvB0Ze3KoFjmB6duuhFhg,2622
 syd/flask_deployment/static/js/modules/state.js,sha256=-sfQ9ppDgr0p3XO5_oN3g-waf1-j0iwSfSSGS_lIK70,3133
@@ -20,9 +20,9 @@ syd/flask_deployment/static/js/modules/utils.js,sha256=xqIBRvTrZCnm65xZ9R6mqeHFn
 syd/flask_deployment/templates/__init__.py,sha256=ieWE8NKR-APw7h4Ge0ooZGk6wZrneSSs_1cMyTPbQSA,65
 syd/flask_deployment/templates/index.html,sha256=OmGaEdEPZ_ALPq7ZHk47jw-ZX9pOUUk57M3gXT0V1Lk,1608
 syd/notebook_deployment/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-syd/notebook_deployment/deployer.py,sha256=ELtYiR6ac8Rg0I1Hh8_K-w5j_oZIAXf-nDazWvbD3Uc,12225
+syd/notebook_deployment/deployer.py,sha256=ovuFvj5_qXB5WToNhCxrEHmPuKYypIeLqrUg0KjovQs,12706
 syd/notebook_deployment/widgets.py,sha256=ptys7exVA6NCF4eCRZMTPJblT0ZbtPdN4o2A0Yh5Cfc,20781
-syd-1.2.0.dist-info/METADATA,sha256=_5dekAuzzkgmS8UjpD42Bu6dVRKfM2Jyimuv8LudNHM,14934
-syd-1.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-syd-1.2.0.dist-info/licenses/LICENSE,sha256=YF6QR6Vjxcg5b_sYIyqkME7FZYau5TfEUGTG-0JeRK0,35129
-syd-1.2.0.dist-info/RECORD,,
+syd-1.2.2.dist-info/METADATA,sha256=ZkI2pU-Mc190FwszroKAWFgai0ZnAtpMXa_Z8s3Yfts,14934
+syd-1.2.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+syd-1.2.2.dist-info/licenses/LICENSE,sha256=YF6QR6Vjxcg5b_sYIyqkME7FZYau5TfEUGTG-0JeRK0,35129
+syd-1.2.2.dist-info/RECORD,,