interactive-figure 0.3.4__py3-none-any.whl → 0.3.6__py3-none-any.whl

interactive_figure/__about__.py

@@ -1 +1 @@
-__version__ = "0.3.4"
+__version__ = "0.3.6"

interactive_figure/interactive_figure.py

@@ -7,6 +7,7 @@ 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):
@@ -15,14 +16,14 @@ def create(aspect_ratio="auto", hide_toolbar=False, **kwargs):
     Parameters
     ----------
     aspect_ratio : str, optional
-        aspect ratio of the Axes, by default "auto"
+        aspect ratio of the Axes, default "auto".
     hide_toolbar : bool, optional
-        whether to hide the toolbar, by default False
+        whether to hide the toolbar, default False.
 
-    remaining arguments will be sent to the figure upon creation
+    Remaining arguments will be sent to the figure upon creation.
 
     Raises
-    ------
+    ----------
     RuntimeError
         if multiple interactive figures are created.
     """
@@ -57,10 +58,12 @@ 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("Error: you cannot create multiple interactive figures at the same time.")
+
 
 def draw():
     """Draw contents of the figure."""
@@ -75,10 +78,15 @@ def draw():
 
 
 def clear(hide_labels=False, set_limits=True):
-    """Reset contents and layout of the figure. 
-    
-    *set_limits* will set the Axes limits to 
-    [0, 100]. *hide_labels* will remove all labels."""
+    """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.
+    """
     _check_exists()
 
     ax = _state.ax
@@ -104,13 +112,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. 
@@ -160,7 +168,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
@@ -172,7 +180,7 @@ def get_last_key_press():
     Returns
     -------
     str | None
-        The last key that was pressed
+        The last key that was pressed.
     """
     _check_exists()
 
@@ -190,7 +198,7 @@ def get_last_mouse_press():
     Returns
     -------
     int | None
-        The identifier of the last mouse button that was pressed
+        The identifier of the last mouse button that was pressed.
     """
     _check_exists()
 
@@ -208,7 +216,7 @@ def get_last_mouse_pos():
     Returns
     -------
     (x: float, y: float) | (None, None)
-        The last registered mouse position after any interaction
+        The last registered mouse position after any interaction.
     """
     _check_exists()
 
@@ -224,16 +232,16 @@ def wait(timeout):
     Parameters
     ----------
     timeout : float
-        Number of seconds to wait for
+        Number of seconds to wait for.
     """
     _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()
 
 
-# PRIVATE METHODS
+# HIDDEN METHODS
 
 
 def _get_state():
@@ -263,6 +271,7 @@ def _state_reset_fig():
     """Reset figure information."""
     _state.fig = None
     _state.ax = None
+    _state.closed_using_ui = True
 
 
 def _state_reset_press():
@@ -301,6 +310,23 @@ 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,
@@ -309,4 +335,5 @@ _state = SimpleNamespace(
     last_mousepress=None,
     last_mouse_x=None,
     last_mouse_y=None,
+    closed_using_ui=True
 )

{interactive_figure-0.3.4.dist-info → interactive_figure-0.3.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: interactive-figure
-Version: 0.3.4
+Version: 0.3.6
 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
@@ -63,6 +63,9 @@ hatch shell
 hatch version fix
 hatch build -c
 ./generate_docs.sh
+
+# Publish
+hatch publish
 ```
 
 ## Links

interactive_figure-0.3.6.dist-info/RECORD

@@ -0,0 +1,7 @@
+interactive_figure/__about__.py,sha256=rshQ1apZMMdkI5bameILs0GVFulDBuEpfDswTVoETqk,23
+interactive_figure/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+interactive_figure/interactive_figure.py,sha256=1vAsDyZj4D5Prdp8HXtx8JCa7Q-3mzkiaLXZo1gbCwE,9047
+interactive_figure-0.3.6.dist-info/METADATA,sha256=aprlOHFNqf1hSv7VSMt1-9Z1h-_CdNfhNpnV0VXr0kw,2438
+interactive_figure-0.3.6.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+interactive_figure-0.3.6.dist-info/licenses/LICENSE.txt,sha256=R6IpPdPKA5nLHPKRXIhlFHLE59dMUtve0qeXhZPr0Hk,1043
+interactive_figure-0.3.6.dist-info/RECORD,,

interactive_figure-0.3.4.dist-info/RECORD

@@ -1,7 +0,0 @@
-interactive_figure/__about__.py,sha256=EVh84K2XkED4bsPB10qR4q6SCbIp-6LdYq5IuJweVoo,23
-interactive_figure/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-interactive_figure/interactive_figure.py,sha256=l3AWVe6oQePBCcv3kGb5qEV_qxHWiuZeXyrxd5OlZTk,8318
-interactive_figure-0.3.4.dist-info/METADATA,sha256=Yx_G-2KYRrZ0IcVf1ZO1zewjlEZG66a02eVbOJJAQvQ,2413
-interactive_figure-0.3.4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-interactive_figure-0.3.4.dist-info/licenses/LICENSE.txt,sha256=R6IpPdPKA5nLHPKRXIhlFHLE59dMUtve0qeXhZPr0Hk,1043
-interactive_figure-0.3.4.dist-info/RECORD,,