plotly-extend-wrapper 1.3.0__tar.gz → 1.4.0__tar.gz

{plotly_extend_wrapper-1.3.0 → plotly_extend_wrapper-1.4.0}/PKG-INFO

@@ -1,17 +1,20 @@
 Metadata-Version: 2.4
 Name: plotly-extend-wrapper
-Version: 1.3.0
+Version: 1.4.0
 Author-email: Laplusdestiny <prayonshootingstars@gmail.com>
-License-File: LICENSE
 Requires-Python: >=3.9
-Requires-Dist: kaleido==0.2.1
-Requires-Dist: nbformat>=4.2.0
-Requires-Dist: numpy>=1.24.0
-Requires-Dist: pandas>=2.0.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: plotly>=5.12.0
+Requires-Dist: kaleido>=0.2.1
 Requires-Dist: pyarrow>=10.0.0
+Requires-Dist: pandas>=2.0.0
 Requires-Dist: scipy>=1.8.0
-Description-Content-Type: text/markdown
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: nbformat>=4.2.0
+Provides-Extra: polars
+Requires-Dist: polars>=0.20.0; extra == "polars"
+Dynamic: license-file
 
 # plotly_extend_wrapper
 
@@ -22,7 +25,19 @@ Description-Content-Type: text/markdown
 
 Extended Python library for Plotly
 
-You can make plot simply
+- **Simple Interface**: Create complex visualizations with just a few lines of code
+- **Pandas Integration**: Seamless integration with pandas DataFrames
+- **Multiple Plot Types**: Support for various chart types including pie charts, sunburst diagrams, and 3D surfaces
+- **Customization**: Easy plot customization through a unified interface
+- **Automatic Layout**: Smart default settings for common plot configurations
+
+For detailed documentation and examples, visit our [Documentation](https://laplusdestiny.github.io/plotly_extend_wrapper/)
+
+## Install
+
+``` bash
+pip install plotly-extend-wrapper
+```
 
 ## Requirement
 
@@ -37,3 +52,9 @@ You can make plot simply
 If there are some bugs, please make issue to tell me!
 
 [![GitHub issues](https://img.shields.io/github/issues/Laplusdestiny/plotly_extend_wrapper?logo=github)](https://github.com/Laplusdestiny/plotly_extend_wrapper/issues)
+
+## License
+
+MIT License
+
+[![GitHub](https://img.shields.io/github/license/Laplusdestiny/plotly_extend_wrapper?logo=github)](https://github.com/Laplusdestiny/plotly_extend_wrapper?tab=MIT-1-ov-file#MIT-1-ov-file)

{plotly_extend_wrapper-1.3.0 → plotly_extend_wrapper-1.4.0}/README.md

@@ -7,7 +7,19 @@
 
 Extended Python library for Plotly
 
-You can make plot simply
+- **Simple Interface**: Create complex visualizations with just a few lines of code
+- **Pandas Integration**: Seamless integration with pandas DataFrames
+- **Multiple Plot Types**: Support for various chart types including pie charts, sunburst diagrams, and 3D surfaces
+- **Customization**: Easy plot customization through a unified interface
+- **Automatic Layout**: Smart default settings for common plot configurations
+
+For detailed documentation and examples, visit our [Documentation](https://laplusdestiny.github.io/plotly_extend_wrapper/)
+
+## Install
+
+``` bash
+pip install plotly-extend-wrapper
+```
 
 ## Requirement
 
@@ -22,3 +34,9 @@ You can make plot simply
 If there are some bugs, please make issue to tell me!
 
 [![GitHub issues](https://img.shields.io/github/issues/Laplusdestiny/plotly_extend_wrapper?logo=github)](https://github.com/Laplusdestiny/plotly_extend_wrapper/issues)
+
+## License
+
+MIT License
+
+[![GitHub](https://img.shields.io/github/license/Laplusdestiny/plotly_extend_wrapper?logo=github)](https://github.com/Laplusdestiny/plotly_extend_wrapper?tab=MIT-1-ov-file#MIT-1-ov-file)

plotly_extend_wrapper-1.4.0/plotly_extend_wrapper/common.py

@@ -0,0 +1,22 @@
+from pathlib import Path
+from plotly.io import get_chrome
+
+
+def check_directory(file_path):
+    """
+    Ensures that the directory for the given file path exists, creating it if necessary.
+
+    Args:
+        file_path (str or Path): The file path for which to check the directory.
+
+    Returns:
+        Path: The resolved absolute path of the given file path.
+    """
+    file_path = Path(file_path)
+    if not file_path.suffix:
+        dir_p = file_path
+    else:
+        dir_p = file_path.parent
+    if not dir_p.is_dir():
+        dir_p.mkdir(parents=True, exist_ok=True)
+    return file_path.resolve()

{plotly_extend_wrapper-1.3.0 → plotly_extend_wrapper-1.4.0}/plotly_extend_wrapper/wrapper.py

@@ -6,15 +6,52 @@ from plotly import graph_objects as go
 from scipy.interpolate import griddata
 import numpy as np
 from copy import deepcopy
+from typing import Union
 
+# Optional polars support
+try:
+    import polars as pl
+    POLARS_AVAILABLE = True
+except ImportError:
+    POLARS_AVAILABLE = False
+    pl = None
 
-def Plot_pie(data: pd.DataFrame, target: str, **kwargs):
+
+def _normalize_dataframe(data) -> pd.DataFrame:
+    """
+    Convert various DataFrame formats to pandas.DataFrame.
+
+    Supports pandas.DataFrame, polars.DataFrame, and polars.LazyFrame.
+
+    Parameters
+    ----------
+    data : pd.DataFrame, pl.DataFrame, or pl.LazyFrame
+        Input data frame
+
+    Returns
+    -------
+    pd.DataFrame
+        Normalized pandas DataFrame
+    """
+    if POLARS_AVAILABLE and pl is not None:
+        if isinstance(data, pl.LazyFrame):
+            return data.collect().to_pandas()
+        elif isinstance(data, pl.DataFrame):
+            return data.to_pandas()
+
+    if isinstance(data, pd.DataFrame):
+        return data
+
+    raise TypeError(f"Unsupported data type: {type(data)}. Expected pandas.DataFrame, polars.DataFrame, or polars.LazyFrame.")
+
+
+def Plot_pie(data: Union[pd.DataFrame, "pl.DataFrame", "pl.LazyFrame"], target: str, **kwargs):
     """Make pie plot
 
     Parameters
     ----------
-    data : pd.DataFrame
-        pandas.DataFrame included data to make pie chart
+    data : pd.DataFrame, pl.DataFrame, or pl.LazyFrame
+        DataFrame included data to make pie chart
     target : str
         String which column you would like to use for pie chart
 
@@ -23,17 +60,18 @@ def Plot_pie(data: pd.DataFrame, target: str, **kwargs):
     plotly.graph_objects
         Object of pie chart
     """
+    data = _normalize_dataframe(data)
     vc = data[target].value_counts().reset_index(name="count")
     return px.pie(vc, names=target, values="count", **kwargs)
 
 
-def Plot_sunburst(data: pd.DataFrame, groups: list, **kwargs):
+def Plot_sunburst(data: Union[pd.DataFrame, "pl.DataFrame", "pl.LazyFrame"], groups: list, **kwargs):
     """Make sunburst plot
 
     Parameters
     ----------
-    data : pd.DataFrame
-        pandas.DataFrame included data to make sunburst chart
+    data : pd.DataFrame, pl.DataFrame, or pl.LazyFrame
+        DataFrame included data to make sunburst chart
     groups : list
         Strings list of group
         Changed when you replace the order
@@ -43,6 +81,7 @@ def Plot_sunburst(data: pd.DataFrame, groups: list, **kwargs):
     plotly.graph_objects
         Object of sunburst chart
     """
+    data = _normalize_dataframe(data)
     vc = data.value_counts(subset=groups).reset_index(name="count")
     return px.sunburst(vc, path=groups, values="count", **kwargs)
 
@@ -69,8 +108,8 @@ class Plot_bubble_chart:
 
         Parameters
         ----------
-        df : pandas.DataFrame
-            pandas.DataFrame included data to make plot
+        df : pandas.DataFrame, pl.DataFrame, or pl.LazyFrame
+            DataFrame included data to make plot
         x : str
             X-axis column's name
         y : str
@@ -92,6 +131,7 @@ class Plot_bubble_chart:
         offset : int, optional
             Offset value for bubble size, by default 0
         """
+        df = _normalize_dataframe(df)
         self.df = df.copy()
         self.x = x
         self.y = y
@@ -188,7 +228,7 @@ class Plot_bubble_chart:
 
 
 def Plot_line(
-    df: pd.DataFrame,
+    df: Union[pd.DataFrame, "pl.DataFrame", "pl.LazyFrame"],
     x: str,
     y: list,
     secondary_y: list,
@@ -210,7 +250,7 @@ def Plot_line(
 
     Parameters
     ----------
-    df : pd.DataFrame
+    df : pd.DataFrame, pl.DataFrame, or pl.LazyFrame
         Original dataframe
     x : str
         X-axis column name
@@ -252,6 +292,8 @@ def Plot_line(
 
     random.seed(42)
 
+    df = _normalize_dataframe(df)
+
     def pick_color():
         return ["#" + "".join([random.choice("0123456789ABCDEF") for j in range(6)])][0]
 
@@ -402,7 +444,7 @@ def Plot_bubble_chart_with_line(
 
 
 def Plot_surface(
-    df: pd.DataFrame,
+    df: Union[pd.DataFrame, "pl.DataFrame", "pl.LazyFrame"],
     x: str,
     y: str,
     z: str,
@@ -414,6 +456,26 @@ def Plot_surface(
     width=None,
     **kwargs,
 ):
+    """
+    Generates a 3D surface plot using Plotly.
+
+    Parameters:
+    df (pd.DataFrame, pl.DataFrame, or pl.LazyFrame): The input data frame containing the data to plot.
+    x (str): The column name for the x-axis.
+    y (str): The column name for the y-axis.
+    z (str): The column name for the z-axis.
+    fill_value (int, optional): The value to fill missing data in the pivot table. Default is 0.
+    smoothing (bool, optional): Whether to apply smoothing to the data. Default is False.
+    smooth_point_num (int, optional): The number of points to use for smoothing. Default is 100.
+    title (str, optional): The title of the plot. Default is None.
+    height (int, optional): The height of the plot. Default is None.
+    width (int, optional): The width of the plot. Default is None.
+    **kwargs: Additional keyword arguments to pass to the plot.
+
+    Returns:
+    plotly.graph_objs._figure.Figure: The generated 3D surface plot.
+    """
+
     def smooth_df(x: np.ndarray, y: np.ndarray, z: np.ndarray, num: int):
         xi = np.linspace(x.min(), x.max(), num)
         yi = np.linspace(y.min(), y.max(), num)
@@ -423,6 +485,8 @@ def Plot_surface(
         zi = np.nan_to_num(zi)
         return xi, yi, zi
 
+    df = _normalize_dataframe(df)
+
     if smoothing:
         X = df[x].values
         Y = df[y].values
@@ -430,7 +494,8 @@ def Plot_surface(
         X, Y, Z = smooth_df(X, Y, Z, smooth_point_num)
     else:
         pivot_df = pd.pivot_table(
-            df, index=x, columns=y, values=z, fill_value=fill_value)
+            df, index=x, columns=y, values=z, fill_value=fill_value
+        )
 
         X = pivot_df.columns.values
         Y = pivot_df.index.values
@@ -440,7 +505,7 @@ def Plot_surface(
     layout = go.Layout(
         title=title,
         scene=dict(
-            xaxis=dict(title=y),    # need to be replaced
+            xaxis=dict(title=y),  # need to be replaced
             yaxis=dict(title=x),
             zaxis=dict(title=z),
         ),

plotly_extend_wrapper-1.4.0/plotly_extend_wrapper.egg-info/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: plotly-extend-wrapper
+Version: 1.4.0
+Author-email: Laplusdestiny <prayonshootingstars@gmail.com>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: plotly>=5.12.0
+Requires-Dist: kaleido>=0.2.1
+Requires-Dist: pyarrow>=10.0.0
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: scipy>=1.8.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: nbformat>=4.2.0
+Provides-Extra: polars
+Requires-Dist: polars>=0.20.0; extra == "polars"
+Dynamic: license-file
+
+# plotly_extend_wrapper
+
+[![GitHub last commit (branch)](https://img.shields.io/github/last-commit/Laplusdestiny/plotly_extend_wrapper/main?logo=github)](https://github.com/Laplusdestiny/plotly_extend_wrapper/commits/main/)
+[![Codecov](https://img.shields.io/codecov/c/gh/Laplusdestiny/plotly_extend_wrapper?style=flat&logo=codecov)](https://app.codecov.io/gh/Laplusdestiny/plotly_extend_wrapper)
+[![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/Laplusdestiny/plotly_extend_wrapper?logo=github)](https://github.com/Laplusdestiny/plotly_extend_wrapper/releases)
+[![PyPI - Version](https://img.shields.io/pypi/v/plotly_extend_wrapper?logo=pypi)](https://pypi.org/project/plotly-extend-wrapper/)
+
+Extended Python library for Plotly
+
+- **Simple Interface**: Create complex visualizations with just a few lines of code
+- **Pandas Integration**: Seamless integration with pandas DataFrames
+- **Multiple Plot Types**: Support for various chart types including pie charts, sunburst diagrams, and 3D surfaces
+- **Customization**: Easy plot customization through a unified interface
+- **Automatic Layout**: Smart default settings for common plot configurations
+
+For detailed documentation and examples, visit our [Documentation](https://laplusdestiny.github.io/plotly_extend_wrapper/)
+
+## Install
+
+``` bash
+pip install plotly-extend-wrapper
+```
+
+## Requirement
+
+- Python >= 3.9
+- Plotly >= 5.0.0
+- kaleido = 0.2.1
+- pandas >= 2.2.0
+- scipy >= 1.12.0
+
+## Issue
+
+If there are some bugs, please make issue to tell me!
+
+[![GitHub issues](https://img.shields.io/github/issues/Laplusdestiny/plotly_extend_wrapper?logo=github)](https://github.com/Laplusdestiny/plotly_extend_wrapper/issues)
+
+## License
+
+MIT License
+
+[![GitHub](https://img.shields.io/github/license/Laplusdestiny/plotly_extend_wrapper?logo=github)](https://github.com/Laplusdestiny/plotly_extend_wrapper?tab=MIT-1-ov-file#MIT-1-ov-file)

plotly_extend_wrapper-1.4.0/plotly_extend_wrapper.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+pyproject.toml
+plotly_extend_wrapper/__init__.py
+plotly_extend_wrapper/common.py
+plotly_extend_wrapper/updater.py
+plotly_extend_wrapper/wrapper.py
+plotly_extend_wrapper.egg-info/PKG-INFO
+plotly_extend_wrapper.egg-info/SOURCES.txt
+plotly_extend_wrapper.egg-info/dependency_links.txt
+plotly_extend_wrapper.egg-info/requires.txt
+plotly_extend_wrapper.egg-info/top_level.txt
+test/test_common.py
+test/test_updater.py
+test/test_wrapper.py
+test/test_wrapper_polars.py

plotly_extend_wrapper-1.4.0/plotly_extend_wrapper.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

plotly_extend_wrapper-1.4.0/plotly_extend_wrapper.egg-info/requires.txt

@@ -0,0 +1,10 @@
+plotly>=5.12.0
+kaleido>=0.2.1
+pyarrow>=10.0.0
+pandas>=2.0.0
+scipy>=1.8.0
+numpy>=1.24.0
+nbformat>=4.2.0
+
+[polars]
+polars>=0.20.0

plotly_extend_wrapper-1.4.0/plotly_extend_wrapper.egg-info/top_level.txt

@@ -0,0 +1 @@
+plotly_extend_wrapper

plotly_extend_wrapper-1.4.0/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "plotly-extend-wrapper"
+version = "1.4.0"
+authors = [{ name = "Laplusdestiny", email = "prayonshootingstars@gmail.com" }]
+dependencies = [
+    "plotly>=5.12.0",
+    "kaleido>=0.2.1",
+    "pyarrow>=10.0.0",
+    "pandas>=2.0.0",
+    "scipy>=1.8.0",
+    "numpy>=1.24.0",
+    "nbformat>=4.2.0",
+]
+readme = "README.md"
+requires-python = ">= 3.9"
+
+[project.optional-dependencies]
+polars = ["polars>=0.20.0"]
+
+[dependency-groups]
+dev = [
+    "build>=1.4.0",
+    "furo>=2025.12.19",
+    "ipykernel>=6.31.0",
+    "myst-parser>=3.0.1",
+    "polars>=0.20.0",
+    "pytest>=8.4.2",
+    "pytest-cov>=7.0.0",
+    "scikit-learn>=1.6.1",
+    "sphinx>=7.4.7",
+    "twine>=6.2.0",
+    "wheel>=0.46.3",
+]

plotly_extend_wrapper-1.4.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

plotly_extend_wrapper-1.4.0/test/test_common.py

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+from plotly_extend_wrapper.common import check_directory
+
+
+def test_create_directory(tmp_path):
+    test_path = tmp_path / "test_dir/test_file.txt"
+    result = check_directory(test_path)
+    assert (tmp_path / "test_dir").is_dir()
+    assert result == test_path.resolve()
+
+
+def test_existing_directory(tmp_path):
+    test_path = tmp_path / "existing_dir/test_file.txt"
+    (tmp_path / "existing_dir").mkdir(parents=True, exist_ok=True)
+    result = check_directory(test_path)
+    assert (tmp_path / "existing_dir").is_dir()
+    assert result == test_path.resolve()
+
+
+def test_directory_path(tmp_path):
+    test_path = tmp_path / "new_dir"
+    result = check_directory(test_path)
+    assert test_path.is_dir()
+    assert result == test_path.resolve()
+
+
+def test_check_directory_file_with_suffix(tmp_path):
+    """Test check_directory with file path that has suffix"""
+    test_file = tmp_path / "subdir" / "test.txt"
+    result = check_directory(test_file)
+
+    # Directory should be created
+    assert test_file.parent.is_dir()
+    assert result == test_file.resolve()
+
+
+def test_check_directory_nested_path(tmp_path):
+    """Test check_directory with deeply nested path"""
+    test_path = tmp_path / "level1" / "level2" / "level3" / "file.csv"
+    result = check_directory(test_path)
+
+    # All directories should be created
+    assert test_path.parent.is_dir()
+    assert (tmp_path / "level1").is_dir()
+    assert (tmp_path / "level1" / "level2").is_dir()
+    assert result == test_path.resolve()
+
+
+def test_check_directory_returns_absolute_path(tmp_path):
+    """Test that check_directory returns absolute path"""
+    test_path = tmp_path / "test_dir"
+    result = check_directory(test_path)
+
+    assert result.is_absolute()
+    assert result == test_path.resolve()

{plotly_extend_wrapper-1.3.0 → plotly_extend_wrapper-1.4.0}/test/test_updater.py

@@ -103,4 +103,55 @@ def test_SetLegendPosition():
     updater.update(legend_position="v")
     new_plot = updater()
 
-    assert new_plot.layout.legend["orientation"] == "v"
+    assert new_plot.layout.legend["orientation"] == "v"
+
+
+def test_GetPlot():
+    plot = MakeTimeSeriesData()
+    updater = Update_plotly_object(plot)
+    result = updater.get_plot()
+
+    assert result is updater.po
+
+
+def test_UpdateWithLegendFalse():
+    """Test that legend_position is not applied when legend is False"""
+    plot = MakeTimeSeriesData()
+    updater = Update_plotly_object(plot)
+    updater.update(legend=False, legend_position="h")
+    new_plot = updater()
+
+    # Should apply legend=False but not legend_position
+    assert new_plot.layout.showlegend == False
+
+
+def test_UpdateWithLegendTrue():
+    """Test that legend_position is applied when legend is True"""
+    plot = MakeTimeSeriesData()
+    updater = Update_plotly_object(plot)
+    updater.update(legend=True, legend_position="h")
+    new_plot = updater()
+
+    assert new_plot.layout.showlegend == True
+    assert new_plot.layout.legend["orientation"] == "h"
+
+
+def test_UpdateNoneValues():
+    """Test that None values don't update anything"""
+    plot = MakeTimeSeriesData()
+    original_height = plot.layout.height
+    original_width = plot.layout.width
+
+    updater = Update_plotly_object(plot)
+    updater.update(
+        xaxis_title=None,
+        yaxis_title=None,
+        height=None,
+        width=None,
+        marker_size=None,
+    )
+    new_plot = updater()
+
+    # Layout should remain unchanged for None values
+    assert new_plot.layout.height == original_height
+    assert new_plot.layout.width == original_width