plotly-extend-wrapper 1.3.0__py3-none-any.whl → 1.4.0__py3-none-any.whl

plotly_extend_wrapper/common.py

@@ -1,12 +1,22 @@
 from pathlib import Path
+from plotly.io import get_chrome
 
 
-def check_directory(file_p):
-    file_p = Path(file_p)
-    if file_p.suffix == "":
-        dir_p = file_p
+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_p.parent
+        dir_p = file_path.parent
     if not dir_p.is_dir():
-        dir_p.mkdir(parents=True)
-    return file_p.resolve()
+        dir_p.mkdir(parents=True, exist_ok=True)
+    return file_path.resolve()

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.3.0.dist-info → plotly_extend_wrapper-1.4.0.dist-info}/METADATA

@@ -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.4.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+plotly_extend_wrapper/__init__.py,sha256=qbQNutZVb9yrOGqDwDekSe3t1kkMyfWCQiZRrzogJgM,154
+plotly_extend_wrapper/common.py,sha256=HyApL_BOUrLbHIzp-k9Gu5W2DwVwu9-_fLs0qeQFjTA,605
+plotly_extend_wrapper/updater.py,sha256=Q-O5FC7z_y1Xel24rBaaiN7MPOQqOy5wG7bpth_VVts,2510
+plotly_extend_wrapper/wrapper.py,sha256=Tig9oWIcvmaplYXyI3G1M7Ppg626lZNhi-0OOKxF0Mw,15585
+plotly_extend_wrapper-1.4.0.dist-info/licenses/LICENSE,sha256=LanHfVWzsvc8f0WfJlk8s_qAhDW1RdNJMYDjDMJvl1Y,1070
+plotly_extend_wrapper-1.4.0.dist-info/METADATA,sha256=dC2dAzPpXJGMabYSrOky-0nOdstW0G9YaV_yQhQmj7M,2428
+plotly_extend_wrapper-1.4.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+plotly_extend_wrapper-1.4.0.dist-info/top_level.txt,sha256=w9ZAZejWegkpPPQUHPZLHVVmlsA3DEDU8yJaE-LadPQ,22
+plotly_extend_wrapper-1.4.0.dist-info/RECORD,,

{plotly_extend_wrapper-1.3.0.dist-info → plotly_extend_wrapper-1.4.0.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: setuptools (82.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
+

plotly_extend_wrapper-1.4.0.dist-info/top_level.txt

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

plotly_extend_wrapper-1.3.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-plotly_extend_wrapper/__init__.py,sha256=qbQNutZVb9yrOGqDwDekSe3t1kkMyfWCQiZRrzogJgM,154
-plotly_extend_wrapper/common.py,sha256=il-4w-f7gsgKuHKHyy-lAbema6-ADdRFdHXZNTYSdhk,262
-plotly_extend_wrapper/updater.py,sha256=Q-O5FC7z_y1Xel24rBaaiN7MPOQqOy5wG7bpth_VVts,2510
-plotly_extend_wrapper/wrapper.py,sha256=YA8sDVYGMTE8n5-q7tLlmfUGENG8qS9BfA3eSJu-VgY,13222
-plotly_extend_wrapper-1.3.0.dist-info/METADATA,sha256=UnUrBrGDM1W0jdl_8pI3UCGcB3zRhoghkICCH6QhPiU,1541
-plotly_extend_wrapper-1.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plotly_extend_wrapper-1.3.0.dist-info/licenses/LICENSE,sha256=LanHfVWzsvc8f0WfJlk8s_qAhDW1RdNJMYDjDMJvl1Y,1070
-plotly_extend_wrapper-1.3.0.dist-info/RECORD,,