interactive-figure 0.3.5__py3-none-any.whl → 0.4.0__py3-none-any.whl

interactive_figure/__about__.py

@@ -1 +1 @@
-__version__ = "0.3.5"
+__version__ = "0.4.0"

interactive_figure/interactive_figure.py

@@ -7,19 +7,20 @@ Source: https://github.com/teuncm/interactive-figure
 
 import matplotlib.pyplot as plt
 from types import SimpleNamespace
+import sys
 
 
-def create(aspect_ratio="auto", hide_toolbar=False, **kwargs):
+def create(hide_labels=False, hide_toolbar=False, **kwargs):
     """Create the interactive figure.
 
     Parameters
     ----------
-    aspect_ratio : str, optional
-        aspect ratio of the Axes, default "auto".
+    hide_labels : bool, optional
+        remove all labels from the figure (makes rendering *much* faster).
     hide_toolbar : bool, optional
         whether to hide the toolbar, default False.
 
-    Remaining arguments will be sent to the figure upon creation.
+    Remaining keyword arguments will be sent to the figure upon creation.
 
     Raises
     ----------
@@ -30,6 +31,9 @@ def create(aspect_ratio="auto", hide_toolbar=False, **kwargs):
         if hide_toolbar:
             plt.rcParams["toolbar"] = "None"
 
+        if hide_labels:
+            _state.hide_labels = True
+
         # Disable interactive mode for explicit control over drawing. See:
         # https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.isinteractive.html#matplotlib.pyplot.isinteractive
         plt.ioff()
@@ -38,7 +42,6 @@ def create(aspect_ratio="auto", hide_toolbar=False, **kwargs):
         fig.canvas.manager.set_window_title("Interactive Figure")
         # Create drawable axis.
         _state.ax = ax = plt.gca()
-        ax.set_aspect(aspect_ratio)
 
         # Show figure but allow the main thread to continue.
         plt.show(block=False)
@@ -57,10 +60,11 @@ def create(aspect_ratio="auto", hide_toolbar=False, **kwargs):
         fig.canvas.mpl_disconnect(fig.canvas.manager.button_press_handler_id)
         fig.canvas.mpl_connect("key_press_event", _key_press_handler)
         fig.canvas.mpl_connect("button_press_event", _button_press_handler)
+        fig.canvas.mpl_connect("close_event", _close_handler)
 
-        print("Successfully created the interactive figure.")
+        print("Interactive figure: created")
     else:
-        raise RuntimeError("Error: you cannot create multiple interactive figures.")
+        raise RuntimeError("Interactive figure: ERROR - you cannot create multiple figures")
 
 
 def draw():
@@ -75,26 +79,17 @@ def draw():
     canvas.flush_events()
 
 
-def clear(hide_labels=False, set_limits=True):
-    """Reset contents and layout of the figure.
-
-    Parameters
-    ----------
-    set_limits : bool, optional
-        set the Axes limits to [0, 100].
-    hide_labels : bool, optional
-        remove all labels from the figure.
-    """
+def clear():
+    """Reset contents and layout of the figure."""
     _check_exists()
 
     ax = _state.ax
     ax.clear()
 
-    if set_limits:
-        ax.set_xlim([0, 100])
-        ax.set_ylim([0, 100])
+    ax.set_xlim([0, 100])
+    ax.set_ylim([0, 100])
 
-    if hide_labels:
+    if _state.hide_labels:
         ax.set_xticks([])
         ax.set_yticks([])
 
@@ -110,13 +105,13 @@ def close():
     """Close the figure."""
     _check_exists()
 
+    _state.closed_using_ui = False
     plt.close(_state.fig)
 
+    # Handle proper closure so that the figure can be reused.
     _state_reset_fig()
     _state_reset_press()
 
-    print("Successfully closed the interactive figure.")
-
 
 def wait_for_interaction(timeout=-1):
     """Wait for interaction. 
@@ -166,7 +161,7 @@ def wait_for_interaction(timeout=-1):
     interaction_type = None if event is None else event.name == "key_press_event"
 
     if interaction_type is None:
-        # No button was pressed, so reset the state.
+        # No button was pressed, so reset the press state.
         _state_reset_press()
 
     return interaction_type
@@ -235,7 +230,7 @@ def wait(timeout):
     _check_exists()
 
     _state.fig.canvas.start_event_loop(timeout=timeout)
-    # No button was pressed, so reset the state.
+    # Reset the press state.
     _state_reset_press()
 
 
@@ -262,13 +257,15 @@ def _check_exists():
         If the figure is not available
     """
     if _state.fig is None:
-        raise RuntimeError("Error: the interactive figure is not available.")
+        raise RuntimeError("Interactive figure: ERROR - figure is not available")
 
 
 def _state_reset_fig():
     """Reset figure information."""
     _state.fig = None
     _state.ax = None
+    _state.hide_labels = False
+    _state.closed_using_ui = True
 
 
 def _state_reset_press():
@@ -307,10 +304,29 @@ def _button_press_handler(event):
     _state.last_mouse_y = event.ydata
 
 
+def _close_handler(event):
+    """Exit when the user presses the red x to close the figure
+    to prevent an infinite event loop.
+    
+    Parameters
+    ----------
+    event
+        The event object that was generated internally
+    """
+    print("Interactive figure: closed")
+
+    # Triggered if the UI ('the red x') is used to close the figure.
+    if _state.closed_using_ui:
+        print("Interactive figure: exited script")       
+        sys.exit(0)
+
+
 # Namespace to track the internal state of the interactive figure.
 _state = SimpleNamespace(
     fig=None,
     ax=None,
+    hide_labels=False,
+    closed_using_ui=True,
     last_keypress=None,
     last_mousepress=None,
     last_mouse_x=None,

{interactive_figure-0.3.5.dist-info → interactive_figure-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: interactive-figure
-Version: 0.3.5
+Version: 0.4.0
 Summary: Create interactive Matplotlib figures!
 Project-URL: Documentation, https://teuncm.github.io/interactive-figure/autoapi/interactive_figure/interactive_figure/index.html
 Project-URL: Issues, https://github.com/teuncm/interactive-figure/issues

interactive_figure-0.4.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+interactive_figure/__about__.py,sha256=Vx47i8QNeXJNuUzstqWuU6eCWE5xtaY0kgN-Gm_d_gE,23
+interactive_figure/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+interactive_figure/interactive_figure.py,sha256=EY2rRb0Aq7PAgarTlxVg3A4rHKcNizTVjXsvPRm2sGc,8911
+interactive_figure-0.4.0.dist-info/METADATA,sha256=8SjDmwJW0emC8m3XhQRcRRpl7BLai1_qRieT514-Vrk,2438
+interactive_figure-0.4.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+interactive_figure-0.4.0.dist-info/licenses/LICENSE.txt,sha256=R6IpPdPKA5nLHPKRXIhlFHLE59dMUtve0qeXhZPr0Hk,1043
+interactive_figure-0.4.0.dist-info/RECORD,,

interactive_figure-0.3.5.dist-info/RECORD

@@ -1,7 +0,0 @@
-interactive_figure/__about__.py,sha256=hu_23GWCWpKjdw97-0y_O7JlxUWN4apUKOL4q5xXd7Q,23
-interactive_figure/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-interactive_figure/interactive_figure.py,sha256=hvQX5OACBYoz5EK9Wd3aOZm6I79ia6PGg69CtkPl_Mo,8410
-interactive_figure-0.3.5.dist-info/METADATA,sha256=WYQ6OrtTdjiUS3npBEhymGvE5Fc2Pc7PxLBPGCYr-4U,2438
-interactive_figure-0.3.5.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-interactive_figure-0.3.5.dist-info/licenses/LICENSE.txt,sha256=R6IpPdPKA5nLHPKRXIhlFHLE59dMUtve0qeXhZPr0Hk,1043
-interactive_figure-0.3.5.dist-info/RECORD,,