PyPI - uplot-python - Versions diffs - 0.0.1__py3-none-any.whl → 1.0.0__py3-none-any.whl - Mend

uplot-python 0.0.1py3-none-any.whl → 1.0.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

uplot/__init__.py +7 -3
uplot/generate_html.py +42 -149
uplot/plot.py +12 -23
uplot/plot2.py +161 -0
uplot/utils.py +37 -0
uplot/{write_tmpfile.py → write_html_tempfile.py} +3 -3
{uplot_python-0.0.1.dist-info → uplot_python-1.0.0.dist-info}/METADATA +51 -2
uplot_python-1.0.0.dist-info/RECORD +16 -0
uplot_python-0.0.1.dist-info/RECORD +0 -14
/uplot/{uplot → static}/__init__.py +0 -0
/uplot/{uplot → static}/uPlot.iife.js +0 -0
/uplot/{uplot → static}/uPlot.min.css +0 -0
/uplot/{uplot → static}/uPlot.mousewheel.js +0 -0
{uplot_python-0.0.1.dist-info → uplot_python-1.0.0.dist-info}/LICENSE +0 -0
{uplot_python-0.0.1.dist-info → uplot_python-1.0.0.dist-info}/WHEEL +0 -0

uplot/__init__.py CHANGED Viewed

@@ -5,10 +5,14 @@
 # Copyright 2022 Stéphane Caron
 # Copyright 2023-2024 Inria
-"""Plot Python iterables with µPlot."""
+"""Python wrapper for μPlot time series."""
-__version__ = "0.0.1"
+__version__ = "1.0.0"
 from .plot import plot
+from .plot2 import plot2
-__all__ = ["plot"]
+__all__ = [
+    "plot",
+    "plot2",
+]

uplot/generate_html.py CHANGED Viewed

@@ -7,73 +7,50 @@
 """Generate an HTML page containing the output plot."""
+import json
+from datetime import datetime
 from importlib import resources
-from math import isnan
-from typing import Dict, Iterable, List
+from typing import List
 import numpy as np
-from numpy.typing import NDArray
-from .color_picker import ColorPicker
+from .utils import array2string, js
-def __ensure_floats(series: Iterable) -> List[float]:
-    return [float(x) for x in series]
-def __escape_null(series: Iterable) -> str:
-    """Escape undefined values in a series.
+def generate_html(opts: dict, data: List[np.ndarray], resize: bool) -> str:
+    """Generate plot in an HTML page.
     Args:
-        series: Series to filter.
-    Returns:
-        String representation of the series.
-    """
-    return (
-        "["
-        + ", ".join(
-            map(
-                lambda x: (
-                    str(int(x))
-                    if isinstance(x, bool)
-                    else (
-                        str(x)
-                        if isinstance(x, (int, float)) and not isnan(x)
-                        else x if isinstance(x, str) else "null"
-                    )
-                ),
-                series,
-            )
-        )
-        + "]"
-    )
-def generate_html(
-    opts: dict,
-    data: List[Iterable[float, int]],
-) -> str:
-    """Generate plot in an HTML page.
+        opts: uPlot option dictionary.
+        data: List of NumPy arrays, one for each series in the plot.
     Returns:
         HTML contents of the page.
     """
-    with resources.path("foxplot.uplot", "uPlot.min.css") as path:
+    with resources.path("uplot.static", "uPlot.min.css") as path:
         uplot_min_css = path
-    with resources.path("foxplot.uplot", "uPlot.iife.js") as path:
+    with resources.path("uplot.static", "uPlot.iife.js") as path:
         uplot_iife_js = path
-    with resources.path("foxplot.uplot", "uPlot.mousewheel.js") as path:
+    with resources.path("uplot.static", "uPlot.mousewheel.js") as path:
         uplot_mwheel_js = path
-    color_picker = ColorPicker()
-    right_axis_label = f" {right_axis_unit}" if right_axis_unit else ""
-    left_labels = list(left_axis.keys())
-    right_labels = list(right_axis.keys())
-    labels = left_labels + [r for r in right_labels if r not in left_labels]
-    series_from_label = {}
-    series_from_label.update(left_axis)
-    series_from_label.update(right_axis)
+    date = datetime.now().strftime("%Y%m%d-%H%M%S")
+    title = opts.get("title", f"Plot from {date}")
+    data_string = ""
+    for array in data:
+        data_string += f"""
+                {array2string(array)},"""
+    if "class" not in opts:
+        opts["class"] = "uplot-chart"
+    if resize:
+        opts["width"] = js("window.innerWidth - 20")
+        opts["height"] = js("window.innerHeight - 150")
+    opts_string = json.dumps(opts)
+    opts_string = opts_string.replace('"<script>', "")
+    opts_string = opts_string.replace('</script>"', "")
     html = f"""<!DOCTYPE html>
 <html lang="en">
     <head>
@@ -82,7 +59,7 @@ def generate_html(
         <meta name="viewport" content="width=device-width, initial-scale=1">
         <link rel="stylesheet" href="{uplot_min_css}">
         <style>
-            div.my-chart {{
+            div.uplot-chart {{
                 background-color: white;
                 padding: 10px 0px;  // appear in Right Click -> Take Screenshot
             }}
@@ -94,26 +71,22 @@ def generate_html(
         <script>
             const {{ linear, stepped, bars, spline, spline2 }} = uPlot.paths;
-            let data = ["""
-    for label in data.keys():
-        html += f"""
-                {__escape_null(data[label])},"""
-    html += """
+            let data = [{data_string}
             ];
-            const lineInterpolations = {
+            const lineInterpolations = {{
                 linear: 0,
                 stepAfter: 1,
                 stepBefore: 2,
                 spline: 3,
-            };
+            }};
-            const _stepBefore = stepped({align: -1});
-            const _stepAfter = stepped({align:  1});
+            const _stepBefore = stepped({{align: -1}});
+            const _stepAfter = stepped({{align:  1}});
             const _linear = linear();
             const _spline = spline();
-            function paths(u, seriesIdx, idx0, idx1, extendGap, buildClip) {
+            function paths(u, seriesIdx, idx0, idx1, extendGap, buildClip) {{
                 let s = u.series[seriesIdx];
                 let interp = s.lineInterpolation;
@@ -128,100 +101,20 @@ def generate_html(
                 return renderer(
                     u, seriesIdx, idx0, idx1, extendGap, buildClip
                 );
-            }
-            let opts = {"""
-    html += f"""
-                title: "{title}","""
-    html += """
-                id: "chart1",
-                class: "my-chart",
-                width: window.innerWidth - 20,
-                height: window.innerHeight - 150,
-                cursor: {
-                    drag: {
-                        x: true,
-                        y: true,
-                        uni: 50,
-                    }
-                },
-                plugins: [
-                    wheelZoomPlugin({factor: 0.75})
-                ],"""
-    html += f"""
-                scales: {{
-                    x: {{
-                        time: {"true" if timestamped else "false"},
-                    }},
-                }},
-                series: ["""
-    html += f"""
-                    {{
-                        value: (self, rawValue) => Number.parseFloat(rawValue -
-                        {times[0]}).toPrecision(4),
-                    }},"""
-    for label in labels:
-        html += f"""
-                    {{
-                        // initial toggled state (optional)
-                        show: true,
-                        spanGaps: false,
-                        // in-legend display
-                        label: "{label}","""
-        if label in right_labels:
-            html += f"""
-                        value: (self, rawValue) =>
-                            Number.parseFloat(rawValue).toPrecision(2) +
-                            "{right_axis_label}",
-                        scale: "{right_axis_unit}","""
-        else:  # label in left_labels
-            html += f"""
-                        value: (self, rawValue) =>
-                            Number.parseFloat(rawValue).toPrecision(2) +
-                            "{left_axis_label}","""
-        html += f"""
-                        // series style
-                        stroke: "{color_picker.get_next_color()}",
-                        width: 2 / devicePixelRatio,
-                        lineInterpolation: lineInterpolations.stepAfter,
-                        paths,
-                    }},"""
-    html += """
-                ],
-                axes: [
-                    {},
-                    {"""
-    html += f"""
-                        size: {60 + 10 * len({left_axis_label})},
-                        values: (u, vals, space) => vals.map(
-                            v => v + "{left_axis_label}"
-                        ),"""
-    html += """
-                    },
-                    {
-                        side: 1,"""
-    html += f"""
-                        scale: "{right_axis_unit}",
-                        size: {60 + 10 * len({right_axis_label})},
-                        values: (u, vals, space) => vals.map(
-                            v => v + "{right_axis_label}"
-                        ),"""
-    html += """
-                        grid: {show: false},
-                    },
-                ],
-            };
+            }}
-            let uplot = new uPlot(opts, data, document.body);
+            let opts = {opts_string};
+            let uplot = new uPlot(opts, data, document.body);"""
+    if resize:
+        html += """
-            // resize with window
             window.addEventListener("resize", e => {
                 uplot.setSize({
                     width: window.innerWidth - 20,
                     height: window.innerHeight - 150,
                 });
-            });
+            });"""
+    html += """
         </script>
     </body>
 </html>"""

uplot/plot.py CHANGED Viewed

@@ -4,33 +4,22 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright 2024 Inria
-"""Main class to manipulate dictionary-series data."""
+"""Main plot function."""
-import logging
-import sys
 import webbrowser
-from typing import BinaryIO, Dict, List, Optional, TextIO, Union
-import numpy as np
-from numpy.typing import NDArray
+from typing import Iterable, List
 from .generate_html import generate_html
-from .write_tmpfile import write_tmpfile
+from .write_html_tempfile import write_html_tempfile
+def plot(opts: dict, data: List[Iterable]) -> None:
+    """Plot function with the same API as uPlot's `plot`.
-def plot(
-    self,
-    opts: dict,
-    data: List[Iterable[float, int]],
-) -> None:
-    html = generate_html(
-        times,
-        left_series,
-        right_series,
-        title,
-        left_axis_unit,
-        right_axis_unit,
-        timestamped=self.__time is not None,
-    )
-    filename = write_tmpfile(html)
+    Args:
+        opts: Options dictionary, as expected by uPlot.
+        data: List of series, as expected by uPlot.
+    """
+    html = generate_html(opts, data, resize=False)
+    filename = write_html_tempfile(html)
     webbrowser.open_new_tab(filename)

uplot/plot2.py ADDED Viewed

@@ -0,0 +1,161 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2024 Inria
+"""Additional plot function."""
+import webbrowser
+from typing import List, Optional
+import numpy as np
+from .color_picker import ColorPicker
+from .exceptions import UplotException
+from .generate_html import generate_html
+from .utils import js
+from .write_html_tempfile import write_html_tempfile
+def prepare_data(x, left, right):
+    if isinstance(left, np.ndarray) and left.ndim == 1:
+        left = [left]
+    data = [x, *left]
+    if right:
+        data.extend(right)
+    return data
+def add_default_options(opts: dict) -> None:
+    if "cursor" not in opts:
+        opts["cursor"] = {
+            "drag": {
+                "x": True,
+                "y": True,
+                "uni": 50,
+            }
+        }
+    if "plugins" not in opts:
+        opts["plugins"] = [
+            js("wheelZoomPlugin({factor: 0.75})"),
+        ]
+def add_series(
+    opts: dict,
+    data: List[np.ndarray],
+    nb_left: int,
+    left_labels: Optional[List[str]],
+    right_labels: Optional[List[str]],
+) -> None:
+    if left_labels is not None and len(left_labels) < nb_left:
+        raise UplotException(
+            f"Not enough labels in left_labels ({len(left_labels)}) "
+            f"to label all {nb_left} left-axis series"
+        )
+    opts["series"] = [{}]
+    color_picker = ColorPicker()
+    for i, series in enumerate(data[1:]):
+        new_series = {
+            "show": True,
+            "spanGaps": False,
+            "stroke": color_picker.get_next_color(),
+            "width": js("2 / devicePixelRatio"),
+        }
+        def find_in_lists(
+            i: int,
+            left_list: Optional[List[str]],
+            right_list: Optional[List[str]],
+        ) -> Optional[str]:
+            return None
+        if left_labels is not None and i < nb_left:
+            new_series["label"] = left_labels[i]
+        if i >= nb_left:
+            if right_labels is not None:
+                new_series["label"] = right_labels[i - nb_left]
+            new_series["scale"] = "right_axis"
+        # scale = find_in_lists(i, left_scales, right_scales)
+        # if scale is not None:
+        #     new_series["scale"] = scale
+        new_series["value"] = js(
+            "(self, rawValue) => Number.parseFloat(rawValue).toPrecision(2)"
+        )
+        # Last, we hack the wrapper to append `paths` after "lineInterpolation"
+        new_series["lineInterpolation"] = js(
+            "lineInterpolations.stepAfter, paths"
+        )
+        opts["series"].append(new_series)
+def add_axes(opts: dict) -> None:
+    opts["axes"] = [
+        {},
+        {
+            "size": 60,
+        },
+        {
+            "side": 1,
+            "scale": "right_axis",
+            "size": 60,
+            "grid": {"show": False},
+        },
+    ]
+def plot2(
+    x: np.ndarray,
+    left: List[np.ndarray],
+    right: Optional[List[np.ndarray]] = None,
+    resize: bool = True,
+    title: Optional[str] = None,
+    timestamped: bool = False,
+    width: Optional[int] = None,
+    height: Optional[int] = None,
+    left_labels: Optional[List[str]] = None,
+    right_labels: Optional[List[str]] = None,
+    **kwargs,
+) -> None:
+    """Plot function with additional defaults and parameters.
+    Args:
+        x: Values for the x-axis.
+        left: Values for the left y-axis.
+        right: Values for the (optional) right y-axis.
+        resize: If set (default), scale plot to page width and height.
+        title: Plot title.
+        timestamped: If set, x-axis values are treated as timestamps.
+        width: Plot width in pixels.
+        height: Plot height in pixels.
+        kwargs: Other keyword arguments are forward to uPlot as options.
+    """
+    data = prepare_data(x, left, right)
+    # Prepare options
+    opts = kwargs.copy()
+    add_default_options(opts)
+    if "id" not in opts:
+        opts["id"] = "chart1"
+    if title is not None:
+        opts["title"] = title
+    if timestamped is not None:
+        opts["scales"] = {"x": {"time": timestamped}}
+    if width is not None:
+        opts["width"] = width
+    if height is not None:
+        opts["height"] = height
+    if "series" not in opts:
+        add_series(opts, data, len(left), left_labels, right_labels)
+    if "axes" not in opts:
+        add_axes(opts)
+    # Generate and open plot
+    html = generate_html(opts, data, resize=resize)
+    filename = write_html_tempfile(html)
+    webbrowser.open_new_tab(filename)

uplot/utils.py ADDED Viewed

@@ -0,0 +1,37 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2024 Inria
+import numpy as np
+def array2string(array: np.ndarray) -> str:
+    """Get string representation of a NumPy array suitable for uPlot.
+    Args:
+        array: NumPy array to convert to JavaScript.
+    Returns:
+        String representation of the array.
+    """
+    array_str = np.array2string(
+        array,
+        precision=64,
+        separator=",",
+        threshold=np.inf,
+    )
+    return array_str.replace("nan", "null")
+def js(code: str) -> str:
+    """Wrap a code string so that it is processed as output JavaScript.
+    Args:
+        code: Code string to wrap.
+    Returns:
+        Wrapped string.
+    """
+    return f"<script>{code}</script>"

uplot/{write_tmpfile.py → write_html_tempfile.py} RENAMED Viewed

@@ -11,14 +11,14 @@ import tempfile
 from datetime import datetime
-def write_tmpfile(html: str) -> str:
-    """Write output page.
+def write_html_tempfile(html: str) -> str:
+    """Write string to an HTML file.
     Args:
         html: HTML content.
     Returns:
-        Name of the output file (a temporary file).
+        Name of the output temporary file.
     """
     filename: str = ""
     with tempfile.NamedTemporaryFile(

{uplot_python-0.0.1.dist-info → uplot_python-1.0.0.dist-info}/METADATA RENAMED Viewed

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: uplot-python
-Version: 0.0.1
-Summary: Plot Python iterables with µPlot.
+Version: 1.0.0
+Summary: Python wrapper for μPlot time series.
 Keywords: json,time,series,plot
 Author-email: Stéphane Caron <stephane.caron@normalesup.org>
 Maintainer-email: Stéphane Caron <stephane.caron@normalesup.org>
@@ -29,3 +29,52 @@ Project-URL: Tracker, https://github.com/stephane-caron/uplot-python/issues
 Python wrapper for [μPlot](https://github.com/leeoniya/uPlot) 📈
+## Installation
+### From PyPI
+```console
+pip install uplot-python
+```
+## Usage
+The `plot` function has the same API as µPlot's `uPlot.plot`:
+```py
+import numpy as np
+import uplot
+t = np.linspace(0.0, 1.0, 10)
+data = [t, np.exp(0.42 * t)]
+opts = {
+    "width": 1920,
+    "height": 600,
+    "title": "Example with plot",
+    "series": [{}, { "stroke": "red", }, ],
+}
+uplot.plot(opts, data)
+```
+For convenience, the library also provides a `plot2` function with additional defaults aimed at time series and line plots, for an experience closer to `matplotlib.pyplot.plot`:
+```py
+import numpy as np
+import uplot
+t = np.linspace(0.0, 1.0, 10)
+uplot.plot2(
+    t,
+    [np.exp(0.1 * t), np.exp(-10.0 * t), np.cos(t)],
+    title="Example with plot2",
+    left_labels=["exp(A t)", "exp(-B t)", "cos(t)"],
+)
+```
+## See also
+- [µPlot](https://github.com/leeoniya/uPlot): A small (~45 KB min), fast chart for time series, lines, areas, ohlc & bars.
+- [Matplotlib](https://matplotlib.org/stable/): Comprehensive library for creating static, animated, and interactive visualizations.
+- [matplotlive](https://github.com/stephane-caron/matplotlive): Stream live plots to a Matplotlib figure.

uplot_python-1.0.0.dist-info/RECORD ADDED Viewed

@@ -0,0 +1,16 @@
+uplot/__init__.py,sha256=cNNmW1r6MVagQ85Otp-Ms55B63KoVTutayVYDDt4Q40,306
+uplot/color_picker.py,sha256=tBcc4t1gN2spSBqmy7gY827GvpzPE2u8N8-6xUMv-YY,962
+uplot/exceptions.py,sha256=iMQrMn8yzcU95-g0vL1Lg03M5FB8vo4ckJpZXEb0TyE,248
+uplot/generate_html.py,sha256=CiwaJZtIShSNAufidH74OCzdJB-7lrm9-f4MDi_AR60,3698
+uplot/plot.py,sha256=GugDtmx2nqcxmwZ20LEbaX06lX0Swvncb9-136tTXqM,654
+uplot/plot2.py,sha256=PmEsGyBEFD0vvvfvD5LYah-hV2Lp48saviqhkGqtWDE,4504
+uplot/utils.py,sha256=0cuQ8XWcDCm0hFvhtUHtt2OeLWf6ujwfSvKokTxuiCQ,775
+uplot/write_html_tempfile.py,sha256=gYbp-btAItW4CX1Wjt2ufhcptdlA0ckFK-xFXA92tGw,722
+uplot/static/__init__.py,sha256=1mykIjCDK2TC5EfbjCTNxfOtJx3P-hIFgbHQEtBfM_o,71
+uplot/static/uPlot.iife.js,sha256=ZVvIqjN4Hochxa9rWfFpnAPJvalRqnSmq1GKwgzEMm0,120184
+uplot/static/uPlot.min.css,sha256=PxIc1KmXtjTgeoh2WIUAGOR1wm8L3dh0EJqNOCwZ3oc,1839
+uplot/static/uPlot.mousewheel.js,sha256=p2CcCwxxafvNqXsxw-zrqUUogxZ1URZhxWK59B0-tgw,4543
+uplot_python-1.0.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+uplot_python-1.0.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+uplot_python-1.0.0.dist-info/METADATA,sha256=b9XQy0hZ17t7ks58s_wIYSOGBDqGwNJHGSIEHAOAh4g,2537
+uplot_python-1.0.0.dist-info/RECORD,,

uplot_python-0.0.1.dist-info/RECORD DELETED Viewed

@@ -1,14 +0,0 @@
-uplot/__init__.py,sha256=ltGGn3R24SRcO2DqcSLi8SQRCRDpO11k4h_FAzmeBWg,257
-uplot/color_picker.py,sha256=tBcc4t1gN2spSBqmy7gY827GvpzPE2u8N8-6xUMv-YY,962
-uplot/exceptions.py,sha256=iMQrMn8yzcU95-g0vL1Lg03M5FB8vo4ckJpZXEb0TyE,248
-uplot/generate_html.py,sha256=WJRV592DDT38VfghO03wLslptYko7brYm4_bZnoR7iM,7182
-uplot/plot.py,sha256=Fw2iIcH5QB_56WBJxUvef5cA4tI5MDTwir1lphlLrdw,771
-uplot/write_tmpfile.py,sha256=6M-GiNyHAV2vVD1H7SHjFITVFrRtwFgHGwcDRkxeeCA,714
-uplot/uplot/__init__.py,sha256=1mykIjCDK2TC5EfbjCTNxfOtJx3P-hIFgbHQEtBfM_o,71
-uplot/uplot/uPlot.iife.js,sha256=ZVvIqjN4Hochxa9rWfFpnAPJvalRqnSmq1GKwgzEMm0,120184
-uplot/uplot/uPlot.min.css,sha256=PxIc1KmXtjTgeoh2WIUAGOR1wm8L3dh0EJqNOCwZ3oc,1839
-uplot/uplot/uPlot.mousewheel.js,sha256=p2CcCwxxafvNqXsxw-zrqUUogxZ1URZhxWK59B0-tgw,4543
-uplot_python-0.0.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-uplot_python-0.0.1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-uplot_python-0.0.1.dist-info/METADATA,sha256=haZ0NwZTVvTdz6_2rXO91WJhb3irB-iAfqy29MK_oBQ,1342
-uplot_python-0.0.1.dist-info/RECORD,,

/uplot/{uplot → static}/__init__.py RENAMED Viewed

File without changes

/uplot/{uplot → static}/uPlot.iife.js RENAMED Viewed

File without changes

/uplot/{uplot → static}/uPlot.min.css RENAMED Viewed

File without changes

/uplot/{uplot → static}/uPlot.mousewheel.js RENAMED Viewed

File without changes

{uplot_python-0.0.1.dist-info → uplot_python-1.0.0.dist-info}/LICENSE RENAMED Viewed

File without changes

{uplot_python-0.0.1.dist-info → uplot_python-1.0.0.dist-info}/WHEEL RENAMED Viewed

File without changes

uplot-python 0.0.1__py3-none-any.whl → 1.0.0__py3-none-any.whl

uplot-python 0.0.1py3-none-any.whl → 1.0.0py3-none-any.whl