maidr 0.22.0__py3-none-any.whl → 0.22.2__py3-none-any.whl

maidr/__init__.py

@@ -1,6 +1,6 @@
-__version__ = "0.22.0"
+__version__ = "0.22.2"
 
-from .api import close, render, save_html, set_engine, show, stacked
+from .api import close, render, save_html, show, stacked
 from .core import Maidr
 from .core.enum import PlotType
 from .patch import (

maidr/api.py

@@ -53,7 +53,3 @@ def stacked(plot: Axes | BarContainer) -> Maidr:
 def close(plot: Any) -> None:
     ax = FigureManager.get_axes(plot)
     FigureManager.destroy(ax.get_figure())
-
-
-def set_engine(engine: Literal["js", "ts"] = "js"):
-    Environment._set_engine(engine=engine)

maidr/core/maidr.py

@@ -11,7 +11,6 @@ from typing import Any, Literal
 from htmltools import HTML, HTMLDocument, Tag, tags
 from lxml import etree
 from matplotlib.figure import Figure
-from matplotlib.patches import Rectangle
 
 from maidr.core.context_manager import HighlightContextManager
 from maidr.core.enum.maidr_key import MaidrKey
@@ -142,19 +141,6 @@ class Maidr:
 
     def _flatten_maidr(self) -> dict | list[dict]:
         """Return a single plot schema or a list of schemas from the Maidr instance."""
-        # To support legacy JS Engine we will just return the format in this way
-        # but soon enough this should be deprecated and when we will completely
-        # transition to TypeScript :)
-        engine = Environment.get_engine()
-        if engine == "js":
-            if self.plot_type in (PlotType.LINE, PlotType.DODGED, PlotType.STACKED):
-                self._plots = [self._plots[0]]
-            maidr = [plot.schema for plot in self._plots]
-
-            return maidr if len(maidr) != 1 else maidr[0]
-
-        # Now let's start building the maidr object for the newer TypeScript engine
-
         if self.plot_type in (PlotType.DODGED, PlotType.STACKED):
             self._plots = [self._plots[0]]
 
@@ -251,27 +237,10 @@ class Maidr:
     @staticmethod
     def _inject_plot(plot: HTML, maidr: str, maidr_id) -> Tag:
         """Embed the plot and associated MAIDR scripts into the HTML structure."""
-
-        engine = Environment.get_engine()
-
         # MAIDR_TS_CDN_URL = "http://localhost:8080/maidr.js"  # DEMO URL
         MAIDR_TS_CDN_URL = "https://cdn.jsdelivr.net/npm/maidr-ts/dist/maidr.js"
 
-        maidr_js_script = f"""
-            if (!document.querySelector('script[src="https://cdn.jsdelivr.net/npm/maidr/dist/maidr.min.js"]')) {{
-                var script = document.createElement('script');
-                script.type = 'text/javascript';
-                script.src = 'https://cdn.jsdelivr.net/npm/maidr/dist/maidr.min.js';
-                script.addEventListener('load', function() {{
-                    window.init("{maidr_id}");
-                }});
-                document.head.appendChild(script);
-            }} else {{
-                window.init("{maidr_id}");
-            }}
-        """
-
-        maidr_ts_script = f"""
+        script = f"""
             if (!document.querySelector('script[src="{MAIDR_TS_CDN_URL}"]'))
             {{
                 var script = document.createElement('script');
@@ -288,8 +257,6 @@ class Maidr:
             }}
         """
 
-        script = maidr_js_script if engine == "js" else maidr_ts_script
-
         base_html = tags.div(
             tags.link(
                 rel="stylesheet",
@@ -299,14 +266,12 @@ class Maidr:
             tags.div(plot),
         )
 
-        is_quarto = os.getenv("IS_QUARTO") == "True"
+        # is_quarto = os.getenv("IS_QUARTO") == "True"
 
         # 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 (Environment.is_notebook() and not is_quarto) or (
-            engine == "ts" and Environment.is_notebook()
-        ):
+        if Environment.is_notebook() or Environment.is_shiny():
             unique_id = "iframe_" + Maidr._unique_id()
 
             def generate_iframe_script(unique_id: str) -> str:

maidr/core/plot/barplot.py

@@ -3,10 +3,9 @@ from __future__ import annotations
 from matplotlib.axes import Axes
 from matplotlib.container import BarContainer
 
-from maidr.core.enum import MaidrKey, PlotType
+from maidr.core.enum import PlotType
 from maidr.core.plot import MaidrPlot
 from maidr.exception import ExtractionError
-from maidr.util.environment import Environment
 from maidr.util.mixin import (
     ContainerExtractorMixin,
     DictMergerMixin,
@@ -18,35 +17,20 @@ class BarPlot(MaidrPlot, ContainerExtractorMixin, LevelExtractorMixin, DictMerge
     def __init__(self, ax: Axes) -> None:
         super().__init__(ax, PlotType.BAR)
 
-    def _extract_axes_data(self) -> dict:
-        engine = Environment.get_engine()
-
-        base_schema = super()._extract_axes_data()
-        bar_ax_schema = {}
-        if engine == "js":
-            bar_ax_schema = {
-                MaidrKey.X: {
-                    MaidrKey.LEVEL: self.extract_level(self.ax),
-                },
-            }
-        return self.merge_dict(base_schema, bar_ax_schema)
-
     def _extract_plot_data(self) -> list:
-        engine = Environment.get_engine()
         plot = self.extract_container(self.ax, BarContainer, include_all=True)
         data = self._extract_bar_container_data(plot)
         levels = self.extract_level(self.ax)
-        if engine == "ts":
-            formatted_data = []
-            combined_data = list(
-                zip(levels, data) if plot[0].orientation == "vertical" else zip(data, levels)  # type: ignore
-            )
-            if combined_data:  # type: ignore
-                for x, y in combined_data:  # type: ignore
-                    formatted_data.append({"x": x, "y": y})
-                return formatted_data
-            if len(formatted_data) == 0:
-                raise ExtractionError(self.type, plot)
+        formatted_data = []
+        combined_data = list(
+            zip(levels, data) if plot[0].orientation == "vertical" else zip(data, levels)  # type: ignore
+        )
+        if combined_data:  # type: ignore
+            for x, y in combined_data:  # type: ignore
+                formatted_data.append({"x": x, "y": y})
+            return formatted_data
+        if len(formatted_data) == 0:
+            raise ExtractionError(self.type, plot)
         if data is None:
             raise ExtractionError(self.type, plot)
 

maidr/core/plot/lineplot.py

@@ -7,7 +7,6 @@ from maidr.core.enum.maidr_key import MaidrKey
 from maidr.core.enum.plot_type import PlotType
 from maidr.core.plot.maidr_plot import MaidrPlot
 from maidr.exception.extraction_error import ExtractionError
-from maidr.util.environment import Environment
 from maidr.util.mixin.extractor_mixin import LineExtractorMixin
 
 
@@ -43,20 +42,11 @@ class MultiLinePlot(MaidrPlot, LineExtractorMixin):
         super().__init__(ax, PlotType.LINE)
 
     def _get_selector(self) -> Union[str, List[str]]:
-        if Environment.get_engine() == "js":
-            return "g[maidr='true'] > path"
         return ["g[maidr='true'] > path"]
 
     def _extract_plot_data(self) -> list[dict]:
         plot = self.extract_lines(self.ax)
         data = self._extract_line_data(plot)
-        engine = Environment.get_engine()
-        if engine == "js":
-            if len(data) > 1:
-                raise Exception(
-                    "MultiLine Plot not supported in JS. Use TypeScript Engine for this plot!"
-                )
-            data = data[0]
 
         if data is None:
             raise ExtractionError(self.type, plot)
@@ -94,11 +84,15 @@ class MultiLinePlot(MaidrPlot, LineExtractorMixin):
             self._elements.append(line)
 
             # Extract data from this line
+
+            label: str = line.get_label()  # type: ignore
             line_data = [
                 {
                     MaidrKey.X: float(x),
                     MaidrKey.Y: float(y),
-                    MaidrKey.FILL: line.get_label(),
+                    # Replace labels starting with '_child' with an empty string to exclude
+                    # internal or non-relevant labels from being used as identifiers.
+                    MaidrKey.FILL: (label if not label.startswith("_child") else ""),
                 }
                 for x, y in line.get_xydata()  # type: ignore
             ]

maidr/core/plot/maidr_plot.py

@@ -5,7 +5,6 @@ from abc import ABC, abstractmethod
 from matplotlib.axes import Axes
 
 from maidr.core.enum import MaidrKey, PlotType
-from maidr.util.environment import Environment
 
 
 class MaidrPlot(ABC):
@@ -26,7 +25,8 @@ class MaidrPlot(ABC):
     type : PlotType
         The specific type of the plot.
     _schema : dict
-        A dictionary containing structured data about the plot, including type, title, axes labels, and data.
+        A dictionary containing structured data about the plot, including type, title,
+        axes labels, and data.
 
     Methods
     -------
@@ -70,17 +70,7 @@ class MaidrPlot(ABC):
 
     def _extract_axes_data(self) -> dict:
         """Extract the plot's axes data"""
-        engine = Environment.get_engine()
-        if engine == "ts":
-            return {MaidrKey.X: self.ax.get_xlabel(), MaidrKey.Y: self.ax.get_ylabel()}
-        return {
-            MaidrKey.X: {
-                MaidrKey.LABEL: self.ax.get_xlabel(),
-            },
-            MaidrKey.Y: {
-                MaidrKey.LABEL: self.ax.get_ylabel(),
-            },
-        }
+        return {MaidrKey.X: self.ax.get_xlabel(), MaidrKey.Y: self.ax.get_ylabel()}
 
     @abstractmethod
     def _extract_plot_data(self) -> list | dict:

maidr/core/plot/scatterplot.py

@@ -7,7 +7,6 @@ from matplotlib.collections import PathCollection
 from maidr.core.enum import MaidrKey, PlotType
 from maidr.core.plot import MaidrPlot
 from maidr.exception import ExtractionError
-from maidr.util.environment import Environment
 from maidr.util.mixin import CollectionExtractorMixin
 
 
@@ -16,8 +15,6 @@ class ScatterPlot(MaidrPlot, CollectionExtractorMixin):
         super().__init__(ax, PlotType.SCATTER)
 
     def _get_selector(self) -> str | list[str]:
-        if Environment.get_engine() == "js":
-            return "g[maidr='true'] > use"
         return ["g[maidr='true'] > g > use"]
 
     def _extract_plot_data(self) -> list[dict]:

maidr/patch/barplot.py

@@ -64,6 +64,9 @@ def bar(
             align == "edge"
         ):
             plot_type = PlotType.DODGED
+    if "dodge" in kwargs:
+        plot_type = PlotType.DODGED
+
     return common(plot_type, wrapped, instance, args, kwargs)
 
 

maidr/util/environment.py

@@ -1,21 +1,10 @@
 import json
 import os
-from typing import Literal
 
 
 class Environment:
     _engine = "ts"
 
-    @classmethod
-    def _set_engine(cls, engine: Literal["js", "ts"]) -> None:
-        """Set the engine to use for the MAIDR instance."""
-        cls._engine = engine
-
-    @classmethod
-    def get_engine(cls) -> str:
-        """Get the engine to use for the MAIDR instance."""
-        return cls._engine
-
     @staticmethod
     def is_interactive_shell() -> bool:
         """Return True if the environment is an interactive shell."""
@@ -42,6 +31,16 @@ class Environment:
         except ImportError:
             return False
 
+    @staticmethod
+    def is_shiny() -> bool:
+        """Return True if the environment is a Shiny app."""
+        try:
+            import shiny
+
+            return shiny.__name__ == "shiny"
+        except ImportError:
+            return False
+
     @staticmethod
     def is_vscode_notebook() -> bool:
         """Return True if the environment is a VSCode notebook."""

{maidr-0.22.0.dist-info → maidr-0.22.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: maidr
-Version: 0.22.0
+Version: 0.22.2
 Summary: Multimodal Access and Interactive Data Representations
 License: GPL-3.0-or-later
 Keywords: accessibility,visualization,sonification,braille,tactile,multimodal,data representation,blind,low vision,visual impairments

{maidr-0.22.0.dist-info → maidr-0.22.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
-maidr/__init__.py,sha256=2VBiSAduUh4hV98_OTtLEKhjtiMBHaxFnsoQzpCEkVU,369
-maidr/api.py,sha256=nor5zAtz82RX2zTmfRGRIEz269mqEPGawZ9GMijbcfs,1818
+maidr/__init__.py,sha256=rqvpwh77dvV86dbscY3OPvc7wX6V9xQbgjk-zwRTriI,357
+maidr/api.py,sha256=GNyYSF8jEOsqCY4ZWLw3hh6RmRDewkWh6DJbzWfEwOA,1721
 maidr/core/__init__.py,sha256=WgxLpSEYMc4k3OyEOf1shOxfEq0ASzppEIZYmE91ThQ,25
 maidr/core/context_manager.py,sha256=6cT7ZGOApSpC-SLD2XZWWU_H08i-nfv-JUlzXOtvWYw,3374
 maidr/core/enum/__init__.py,sha256=9ee78L0dlxEx4ulUGVlD-J23UcUZmrGu0rXms54up3c,93
@@ -7,21 +7,21 @@ maidr/core/enum/library.py,sha256=e8ujT_L-McJWfoVJd1ty9K_2bwITnf1j0GPLsnAcHes,10
 maidr/core/enum/maidr_key.py,sha256=WLLn2kSkUp4KzhMIiV6U6H5JCYuS1QjbXmR5EiyGy2E,759
 maidr/core/enum/plot_type.py,sha256=pyfyIwlq3taqe2Z1sVUSbMsTp5QTvYBlZXsMMMclEVM,293
 maidr/core/figure_manager.py,sha256=e6nI5pGqH0NM3yzt2jeiae4lrBlIOhkDN92GZJ3MNmk,3988
-maidr/core/maidr.py,sha256=VYiHLGTH1tR1Ua6BC2nPMxK_FqqVr_oyndOX88s5XVc,14011
+maidr/core/maidr.py,sha256=w27bsjX42uGZofaCDtMlZGNPYVMvg0mKU7r0xQFDeTY,12560
 maidr/core/plot/__init__.py,sha256=xDIpRGM-4DfaSSL3nKcXrjdMecCHJ6en4K4nA_fPefQ,83
-maidr/core/plot/barplot.py,sha256=0w-HAGi4wqB9c8qaMIv-KcjFHs99m74Tcn3fD7m1DxA,2555
+maidr/core/plot/barplot.py,sha256=a5dOAaWqfbllLBN4U8JjPWSbONGqM8QUTTmUSccMd6U,1981
 maidr/core/plot/boxplot.py,sha256=WuHrUy6CFZRBfVDjl9MU262mfLFR6DWF_2h4zN3wcMI,5881
 maidr/core/plot/grouped_barplot.py,sha256=6D7KT1pjf7XP4XRERmRHYpXY83VikyGcGp-37qQZPEU,2101
 maidr/core/plot/heatmap.py,sha256=yMS-31tS2GW4peds9LtZesMxmmTV_YfqYO5M_t5KasQ,2521
 maidr/core/plot/histogram.py,sha256=QV5W-6ZJQQcZsrM91JJBX-ONktJzH7yg_et5_bBPfQQ,1525
-maidr/core/plot/lineplot.py,sha256=kPLX0MBmz_Q1FKTMkoELaMSVWPWcDtxp-_VRDmGb4Pg,3447
-maidr/core/plot/maidr_plot.py,sha256=k1-MifHMwDjD-TNQn5DIJ-ShtUiQgjxo7NjMIxGaW9Q,3303
+maidr/core/plot/lineplot.py,sha256=NEsnreoJ2Qe7fcY7iPHbrJ7UgL1DnGyMmL_4fNcMaQI,3309
+maidr/core/plot/maidr_plot.py,sha256=D-LVQEZEVR6JNcv9FrnYYVIKniSWJjvD8UczbgTeGhE,2974
 maidr/core/plot/maidr_plot_factory.py,sha256=QGcHK_oquY_M2_KJVEtc5-rBAD-gm7KI1kSD7cduHzg,1691
-maidr/core/plot/scatterplot.py,sha256=TNnd1dGCiE-qxQI30oHstF0jju50_uR08CDr-Ep4ahU,1392
+maidr/core/plot/scatterplot.py,sha256=o0i0uS-wXK9ZrENxneoHbh3-u-2goRONp19Yu9QLsaY,1257
 maidr/exception/__init__.py,sha256=PzaXoYBhyZxMDcJkuxJugDx7jZeseI0El6LpxIwXyG4,46
 maidr/exception/extraction_error.py,sha256=rd37Oxa9gn2OWFWt9AOH5fv0hNd3sAWGvpDMFBuJY2I,607
 maidr/patch/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-maidr/patch/barplot.py,sha256=iCoYaqlHou6_rSnbjfZwpRU8ENnYcfQ9JCdUxhrSgCA,2416
+maidr/patch/barplot.py,sha256=nxgBWBMUyf3eAW56CN5EKYYy3vsTgEPRlcvNYS3-WiU,2479
 maidr/patch/boxplot.py,sha256=Mcz94pSf7PT3SyRsI8TDrIKVdEmiiUQouXvd05mtnfw,2846
 maidr/patch/clear.py,sha256=2Sc4CIt5jRGkew3TxFsBZm-uowC9yDSxtraEcXZjmGw,396
 maidr/patch/common.py,sha256=bRe4jruUvCIwp1t1E8Q3OuQ0eEyHgpMjXVpsPBZj4C8,843
@@ -31,13 +31,13 @@ maidr/patch/histogram.py,sha256=tnyKkTMuzDXdyQBywhpHZgH3i2mXzOCSyfUSRM0tfUg,1315
 maidr/patch/lineplot.py,sha256=_EyqOp8BcO-kGq9sn8PyNQ8-Bz0FsnHAufXRkTGQzBw,1025
 maidr/patch/scatterplot.py,sha256=kln6zZwjVsdQzICalo-RnBOJrx1BnIB2xYUwItHvSNY,525
 maidr/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-maidr/util/environment.py,sha256=VSDzKybCiRmUiP_SpBswVh0g78kl0FE2LhXIB8kXh_s,4554
+maidr/util/environment.py,sha256=NJzbcFUCIk7OF29eIae8jyHax9p8fQgFLmxM6Af0fUY,4465
 maidr/util/mixin/__init__.py,sha256=aGJZNhtWh77yIVPc7ipIZm1OajigjMtCWYKPuDWTC-c,217
 maidr/util/mixin/extractor_mixin.py,sha256=AjpgCo_dgASdTwFumfgDOoVCVioxDDoqFWphaBj5gz4,4764
 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-0.22.0.dist-info/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-maidr-0.22.0.dist-info/METADATA,sha256=9gGDataWifBMLjLjpKqeQd2j1K-YRIKKU4UZOTQMvrY,2688
-maidr-0.22.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-maidr-0.22.0.dist-info/RECORD,,
+maidr-0.22.2.dist-info/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+maidr-0.22.2.dist-info/METADATA,sha256=0icmzAmbYyHT8FgQOVqcv6E_7dSN0M-_egxRyrLUpQI,2688
+maidr-0.22.2.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+maidr-0.22.2.dist-info/RECORD,,