maidr 1.4.10__py3-none-any.whl → 1.6.0__py3-none-any.whl

maidr/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.4.10"
+__version__ = "1.6.0"
 
 from .api import close, render, save_html, show, stacked
 from .core import Maidr

maidr/core/maidr.py

@@ -7,6 +7,8 @@ import os
 import tempfile
 import uuid
 import webbrowser
+import subprocess
+from pathlib import Path
 from typing import Any, Literal, cast
 
 import matplotlib.pyplot as plt
@@ -137,7 +139,48 @@ class Maidr:
         html_file_path = self.save_html(
             temp_file_path
         )  # This will use use_iframe=False
-        webbrowser.open(f"file://{html_file_path}")
+        if Environment.is_wsl():
+            wsl_distro_name = Environment.get_wsl_distro_name()
+
+            # Validate that WSL distro name is available
+            if not wsl_distro_name:
+                raise ValueError(
+                    "WSL_DISTRO_NAME environment variable is not set or is empty. "
+                    "Cannot construct WSL file URL. Please ensure you are running in a WSL environment."
+                )
+
+            # Ensure html_file_path is an absolute POSIX path for proper WSL URL construction
+            html_file_path = Path(html_file_path).resolve().as_posix()
+
+            url = f"file://wsl$/{wsl_distro_name}{html_file_path}"
+
+            # Try to open the file in Windows using explorer.exe with robust path detection
+            explorer_path = Environment.find_explorer_path()
+            if explorer_path:
+                try:
+                    result = subprocess.run(
+                        [explorer_path, url],
+                        capture_output=True,
+                        text=True,
+                        timeout=10
+                    )
+
+                    if result.returncode == 0:
+                        return
+                    else:
+                        # Fall back to webbrowser.open() if explorer.exe fails
+                        webbrowser.open(url)
+
+                except subprocess.TimeoutExpired:
+                    webbrowser.open(url)
+                except Exception:
+                    # Fall back to webbrowser.open() if explorer.exe fails
+                    webbrowser.open(url)
+            else:
+                webbrowser.open(url)
+
+        else:
+            webbrowser.open(f"file://{html_file_path}")
 
     def _create_html_tag(self, use_iframe: bool = True) -> Tag:
         """Create the MAIDR HTML using HTML tags."""
@@ -311,7 +354,7 @@ class Maidr:
         # Render the plot inside an iframe if in a Jupyter notebook, Google Colab
         # or VSCode notebook. No need for iframe if this is a Quarto document.
         # For TypeScript we will use iframe by default for now
-        if use_iframe and (Environment.is_notebook() or Environment.is_shiny()):
+        if use_iframe and (Environment.is_flask() or Environment.is_notebook() or Environment.is_shiny()):
             unique_id = "iframe_" + Maidr._unique_id()
 
             def generate_iframe_script(unique_id: str) -> str:

maidr/util/environment.py

@@ -1,11 +1,51 @@
 import json
 import os
+import subprocess
 import sys
+from typing import Union
 
 
 class Environment:
     _engine = "ts"
 
+    @staticmethod
+    def is_flask() -> bool:
+        """
+        Check if the current environment is a Flask application.
+
+        This method detects Flask applications by checking if Flask's app context
+        is available using `flask.has_app_context()`. The app context is Flask's
+        way of tracking the current application state and is only available when
+        code is running within a Flask application.
+
+        Returns
+        -------
+        bool
+            True if the environment is a Flask application, False otherwise.
+
+        Examples
+        --------
+        >>> from maidr.util.environment import Environment
+        >>> Environment.is_flask()
+        False  # When not in a Flask app
+        """
+        try:
+            # Import Flask's has_app_context function
+            from flask import has_app_context
+
+            # has_app_context() returns True only when code is running within
+            # a Flask application context. This is Flask's built-in mechanism
+            # for detecting if the current execution environment is a Flask app.
+            #
+            # The app context is automatically created by Flask when:
+            # - A Flask app is running (app.run())
+            # - Code is executed within a Flask request context
+            # - The app context is manually pushed
+            return has_app_context()
+        except ImportError:
+            # Flask is not installed, so we're definitely not in a Flask app
+            return False
+
     @staticmethod
     def is_interactive_shell() -> bool:
         """Return True if the environment is an interactive shell."""
@@ -61,6 +101,93 @@ class Environment:
                 return False
         except ImportError:
             return False
+    @staticmethod
+    def is_wsl() -> bool:
+        """
+        Check if the current environment is WSL (Windows Subsystem for Linux).
+
+        This method detects WSL environments by reading the `/proc/version` file
+        and checking for 'microsoft' or 'wsl' keywords in the version string.
+        WSL environments typically contain these identifiers in their kernel version.
+
+        Returns
+        -------
+        bool
+            True if the environment is WSL, False otherwise.
+
+        Examples
+        --------
+        >>> from maidr.util.environment import Environment
+        >>> Environment.is_wsl()
+        False  # When not in WSL
+        """
+        try:
+            with open('/proc/version', 'r') as f:
+                version_info = f.read().lower()
+                if 'microsoft' in version_info or 'wsl' in version_info:
+                    return True
+        except FileNotFoundError:
+            pass
+        return False
+
+    @staticmethod
+    def get_wsl_distro_name() -> str:
+        """
+        Get the WSL distribution name from environment variables.
+
+        This method retrieves the WSL distribution name from the `WSL_DISTRO_NAME`
+        environment variable, which is automatically set by WSL when running
+        in a WSL environment.
+
+        Returns
+        -------
+        str
+            The WSL distribution name (e.g., 'Ubuntu-20.04', 'Debian') if set,
+            otherwise an empty string.
+
+        Examples
+        --------
+        >>> from maidr.util.environment import Environment
+        >>> Environment.get_wsl_distro_name()
+        ''  # When not in WSL or WSL_DISTRO_NAME not set
+        """
+        return os.environ.get('WSL_DISTRO_NAME', '')
+
+    @staticmethod
+    def find_explorer_path() -> Union[str, None]:
+        """
+        Find the correct path to explorer.exe in WSL environment.
+
+        This method checks if explorer.exe is available in the PATH
+        and returns the path if found.
+
+        Returns
+        -------
+        str | None
+            The path to explorer.exe if found, None otherwise.
+
+        Examples
+        --------
+        >>> from maidr.util.environment import Environment
+        >>> Environment.find_explorer_path()
+        '/mnt/c/Windows/explorer.exe'  # When found
+        """
+        # Check if explorer.exe is in PATH
+        try:
+            result = subprocess.run(
+                ['which', 'explorer.exe'],
+                capture_output=True,
+                text=True,
+                timeout=5
+            )
+            if result.returncode == 0:
+                return result.stdout.strip()
+        except Exception:
+            pass
+
+        return None
+
+
 
     @staticmethod
     def get_renderer() -> str:

{maidr-1.4.10.dist-info → maidr-1.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maidr
-Version: 1.4.10
+Version: 1.6.0
 Summary: Multimodal Access and Interactive Data Representations
 Project-URL: Homepage, https://xability.github.io/py-maidr
 Project-URL: Repository, https://github.com/xability/py-maidr
@@ -34,12 +34,14 @@ Provides-Extra: jupyter
 Requires-Dist: ipykernel>=6.0.0; extra == 'jupyter'
 Requires-Dist: jupyter<2,>=1.0.0; extra == 'jupyter'
 Provides-Extra: test
+Requires-Dist: flask>=3.0.0; extra == 'test'
 Requires-Dist: jupyter<2,>=1.0.0; extra == 'test'
 Requires-Dist: matplotlib>=3.8; extra == 'test'
 Requires-Dist: pytest-mock<4,>=3.12.0; extra == 'test'
 Requires-Dist: pytest<8,>=7.3.2; extra == 'test'
 Requires-Dist: seaborn>=0.12; extra == 'test'
 Provides-Extra: visualization
+Requires-Dist: flask>=3.0.0; extra == 'visualization'
 Requires-Dist: matplotlib>=3.8; extra == 'visualization'
 Requires-Dist: seaborn>=0.12; extra == 'visualization'
 Requires-Dist: statsmodels>=0.14.4; extra == 'visualization'

{maidr-1.4.10.dist-info → maidr-1.6.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
-maidr/__init__.py,sha256=EYV2pThkXEDNDVeWxbEJNzphGq2yMnSr1bl4DYIP_cI,416
+maidr/__init__.py,sha256=bvyrTCLC6rRb_Iu5wCMtnDYCY0tbaZ--c21hFuNMICE,415
 maidr/api.py,sha256=gRNLXqUWpFGdD-I7Nu6J0_LeEni9KRAr0TBHwHaDAsc,1928
 maidr/core/__init__.py,sha256=WgxLpSEYMc4k3OyEOf1shOxfEq0ASzppEIZYmE91ThQ,25
 maidr/core/context_manager.py,sha256=6cT7ZGOApSpC-SLD2XZWWU_H08i-nfv-JUlzXOtvWYw,3374
 maidr/core/figure_manager.py,sha256=jXs-Prkeru1Pahj21hjh8BAwXM9ZFUZ3GFfKUfIRX_M,4117
-maidr/core/maidr.py,sha256=tELie62HFSzZXjMosvVhinqQMzb1G25Odrxb7RBL694,14089
+maidr/core/maidr.py,sha256=1f3H6E2gXTWTdO_vNmiGmPq1dDn-Q96wjirkosxIgPg,15802
 maidr/core/enum/__init__.py,sha256=9ee78L0dlxEx4ulUGVlD-J23UcUZmrGu0rXms54up3c,93
 maidr/core/enum/library.py,sha256=e8ujT_L-McJWfoVJd1ty9K_2bwITnf1j0GPLsnAcHes,104
 maidr/core/enum/maidr_key.py,sha256=ljG0omqzd8K8Yk213N7i7PXGvG-IOlnE5v7o6RoGJzc,795
@@ -41,7 +41,7 @@ maidr/patch/regplot.py,sha256=k86ekd0E4XJ_L1u85zObuDnxuXlM83z7tKtyXRTj2rI,3240
 maidr/patch/scatterplot.py,sha256=kln6zZwjVsdQzICalo-RnBOJrx1BnIB2xYUwItHvSNY,525
 maidr/util/__init__.py,sha256=eRJZfRpDX-n7UoV3JXw_9Lbfu_qNl_D0W1UTvLL-Iv4,81
 maidr/util/dedup_utils.py,sha256=RpgPL5p-3oULUHaTCZJaQKhPHfyPkvBLHMt8lAGpJ5A,438
-maidr/util/environment.py,sha256=-2LyZUpHojBCMEbkr_xkcC-_IDqtGDALB8683v7kTdI,5253
+maidr/util/environment.py,sha256=SSfxzjmY2ZVA98B-IVql8n9AX3d6h2f7_R4t3_53dYI,9452
 maidr/util/mplfinance_utils.py,sha256=aWNRkNS2IAF4YYEF9w7CcmcKWMGg3KkYJAv0xL8KcyY,14417
 maidr/util/plot_detection.py,sha256=bgLHoDcHSRwOiyKzUK3EqGwdAIhF44ocHW5ox6xYGZw,3883
 maidr/util/regression_line_utils.py,sha256=yFKr-H0whT_su2YVZwNksBLp5EC5s77sr6HUFgNcsyY,2329
@@ -51,7 +51,7 @@ maidr/util/mixin/extractor_mixin.py,sha256=oHtwpmS5kARvaLrSO3DKTPQxyFUw9nOcKN7rz
 maidr/util/mixin/merger_mixin.py,sha256=V0qLw_6DUB7X6CQ3BCMpsCQX_ZuwAhoSTm_E4xAJFKM,712
 maidr/widget/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maidr/widget/shiny.py,sha256=wrrw2KAIpE_A6CNQGBtNHauR1DjenA_n47qlFXX9_rk,745
-maidr-1.4.10.dist-info/METADATA,sha256=xoaRoRcpbRdP37x78jYL6TnQ927PW8J4NitwTzK2WQ4,3095
-maidr-1.4.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-maidr-1.4.10.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-maidr-1.4.10.dist-info/RECORD,,
+maidr-1.6.0.dist-info/METADATA,sha256=e3l2lyk61dpyniYkOGEIO2Ycyt10LWgPfM-z6OR8fYU,3193
+maidr-1.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+maidr-1.6.0.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+maidr-1.6.0.dist-info/RECORD,,