pandas-plots 0.8.7__py3-none-any.whl → 0.8.8__py3-none-any.whl

pandas_plots/tbl.py

@@ -4,20 +4,18 @@ warnings.filterwarnings("ignore")
 
 import math
 import os
-from typing import Literal
+from typing import Literal, get_args
 
 import numpy as np
 import pandas as pd
 import plotly.express as px
 from plotly.subplots import make_subplots
 from scipy import stats
-
 # pd.options.mode.chained_assignment = None
-from . import txt
 
-# ! check pandas version
-assert pd.__version__ > "2.0.0", "pandas version must be >= 2.0.0"
+from . import txt
 
+AGG_FUNC=Literal["sum", "mean", "median", "min", "max", "std", "var", "skew", "kurt"]
 
 def describe_df(
     df: pd.DataFrame,
@@ -189,8 +187,9 @@ def pivot_df(
     data_bar_axis: Literal["x", "y", "xy", None] = "xy",
     pct_axis: Literal["x", "xy", None] = "xy",
     precision: int = 0,
-    show_total: bool = True,
     heatmap_axis: Literal["x", "y", "xy", None] = None,
+    total_mode: AGG_FUNC = "sum",
+    total_axis: Literal["x", "y", "xy", None] = "xy",
 ) -> pd.DataFrame:
     """
     A function to pivot a DataFrame based on specified parameters and return the result as a new DataFrame.
@@ -204,8 +203,9 @@ def pivot_df(
         data_bar_axis (Literal["x", "y", "xy", None], optional): The axis for displaying data bars. Defaults to "xy".
         pct_axis (Literal["x", "xy", None], optional): The axis for displaying percentages. Defaults to None.
         precision (int, optional): The precision for displaying values. Defaults to 0.
-        show_total (bool, optional): Whether to show totals in the result. Defaults to False.
         heatmap_axis (Literal["x","y","xy", None], optional): The axis for displaying heatmaps. Defaults to None.
+        total_mode (Literal["sum", "mean", "median", "min", "max", "std", "var", "skew", "kurt"], optional): The aggregation mode for displaying totals. Defaults to "sum".
+        total_axis (Literal["x", "y", "xy", None], optional): The axis for displaying totals. Defaults to "xy".
 
     Returns:
         pd.DataFrame: The pivoted DataFrame.
@@ -224,6 +224,10 @@ def pivot_df(
     if not pd.api.types.is_numeric_dtype(df.iloc[:, 2]):
         print("❌ 3rd column must be numeric")
         return
+    
+    if total_mode and total_mode not in get_args(AGG_FUNC):
+        print(f"❌ total_mode '{total_mode}' not supported")
+        return
 
     df = df.copy()
 
@@ -273,7 +277,8 @@ def pivot_df(
 
     return show_num_df(
         df,
-        show_total=show_total,
+        total_mode=total_mode,
+        total_axis=total_axis,
         data_bar_axis=data_bar_axis,
         pct_axis=pct_axis,
         swap=swap,
@@ -284,10 +289,8 @@ def pivot_df(
 
 def show_num_df(
     df,
-    show_total: bool = False,
-    total_mode: Literal[
-        "sum", "mean", "median", "min", "max", "std", "var", "skew", "kurt"
-    ] = "sum",
+    total_mode: AGG_FUNC = "sum",
+    total_axis: Literal["x", "y", "xy", None] = "xy",
     heatmap_axis: Literal["x", "y", "xy", None] = None,
     data_bar_axis: Literal["x", "y", "xy", None] = None,
     pct_axis: Literal["x", "xy", None] = None,
@@ -299,8 +302,9 @@ def show_num_df(
 
     Parameters:
     - df: the DataFrame to display
-    - show_total: a boolean indicating whether to show totals
     - total_mode: a Literal indicating the mode for aggregating totals ["sum", "mean", "median", "min", "max", "std", "var", "skew", "kurt"]
+    - total_axis (Literal["x", "y", "xy", None], optional): The axis for displaying totals. Defaults to "xy".
+    
     - heatmap_axis (Literal["x","y","xy", None], optional): The axis for displaying heatmaps. Defaults to None.
     - data_bar_axis: a Literal indicating the axis for applying data bar coloring ["x","y","xy", None]
     - pct_axis: a Literal indicating the directions for displaying percentages ["x","xy", None]. "x" means sum up pct per column
@@ -322,18 +326,8 @@ def show_num_df(
         print(f"❌ axis not supported")
         return
 
-    if total_mode and total_mode not in [
-        "sum",
-        "mean",
-        "median",
-        "min",
-        "max",
-        "std",
-        "var",
-        "skew",
-        "kurt",
-    ]:
-        print(f"❌ total mode '{total_mode}' not supported")
+    if total_mode and total_mode not in get_args(AGG_FUNC):
+        print(f"❌ total_mode '{total_mode}' not supported")
         return
 
     theme = os.getenv("THEME") or "light"
@@ -341,15 +335,16 @@ def show_num_df(
     # * copy df, do not reference original
     df_ = df.copy() if not swap else df.T.copy()
 
-    # * alter _df, add totals
-    if show_total:
+    # * alter df_, add totals
+    if total_mode and total_axis in ['x','xy']:
         df_.loc["Total"] = df_.agg(total_mode, axis=0)
+    if total_mode and total_axis in ['y','xy']:
         df_.loc[:, "Total"] = df_.agg(total_mode, axis=1)
 
     # * derive style
     out = df_.style
 
-    color_highlight = "lightblue" if theme == "light" else "darkgrey"
+    color_highlight = "lightblue" if theme == "light" else "#666666"
     color_zeros = "grey" if theme == "light" else "grey"
     color_pct = "grey" if theme == "light" else "yellow"
     color_values = "black" if theme == "light" else "white"
@@ -378,7 +373,7 @@ def show_num_df(
     # * build pct formatting
     if pct_axis == "x":
         # * totals on either axis influence the sum
-        divider = 2 if show_total else 1
+        divider = 2 if total_axis in ['x','xy'] else 1
         # * cell formatting to each column instead of altering values w/ df.apply
         # * uses dictionary comprehension, and a lambda function with two input variables
         col_sums = df_.sum() / divider
@@ -395,7 +390,7 @@ def show_num_df(
     #     }
 
     elif pct_axis == "xy":
-        divider = 4 if show_total else 1
+        divider = 4 if total_axis == 'xy' else 2 if total_axis in ['x','y'] else 1
         n = df_.sum().sum() / divider
         formatter = {
             col: lambda x, col=col: format_cell(x, n, pct_axis) for col in df_.columns

{pandas_plots-0.8.7.dist-info → pandas_plots-0.8.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pandas-plots
-Version: 0.8.7
+Version: 0.8.8
 Summary: A collection of helper for table handling and vizualization
 Home-page: https://github.com/smeisegeier/pandas-plots
 Author: smeisegeier

{pandas_plots-0.8.7.dist-info → pandas_plots-0.8.8.dist-info}/RECORD

@@ -1,11 +1,11 @@
 pandas_plots/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pandas_plots/pls.py,sha256=CUh2lskJ6eLO_ccAg_UXXpRoWvZ7-Q3xKcUSEnKhK9U,23349
 pandas_plots/sql.py,sha256=SHrmwhmzq0QYygvaoKwv7neiwf_Rv87VmdUkADYPdR8,2485
-pandas_plots/tbl.py,sha256=WQ5SoNazLejLr88d1Sj8Ee4AHKyAwMeNZIBUe56suho,15605
+pandas_plots/tbl.py,sha256=-Clf01gUetNw3KieqjpFRL0-2MJpIB3mfKU36Tzeij0,16027
 pandas_plots/txt.py,sha256=LnW9OF3mSX2fp9JajefF3Mz3LuCA8MaqlFZYjT_jaQw,1537
 pandas_plots/ven.py,sha256=nDKS7cTIHOJhIXKnAxAkEoqPgVZCUPJld5CvSiB2JC4,11721
-pandas_plots-0.8.7.dist-info/LICENSE,sha256=6KQ5KVAAhRaB-JJKpX4cefKvRZRgI7GUPc92_2d31XY,1051
-pandas_plots-0.8.7.dist-info/METADATA,sha256=Tyi_1lPEXYj0tmYs8pO6WRn-DMEXdeR_Zi_8ch7XFTY,5478
-pandas_plots-0.8.7.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-pandas_plots-0.8.7.dist-info/top_level.txt,sha256=XnaNuIHBqMmCeh_U7nKOYTwFue_SIA0wxuDgdPmnnSk,13
-pandas_plots-0.8.7.dist-info/RECORD,,
+pandas_plots-0.8.8.dist-info/LICENSE,sha256=6KQ5KVAAhRaB-JJKpX4cefKvRZRgI7GUPc92_2d31XY,1051
+pandas_plots-0.8.8.dist-info/METADATA,sha256=1r7P6xc2coVUrwDz8b0e5cEwJVw7T38jFnxEnrmZwJE,5478
+pandas_plots-0.8.8.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+pandas_plots-0.8.8.dist-info/top_level.txt,sha256=XnaNuIHBqMmCeh_U7nKOYTwFue_SIA0wxuDgdPmnnSk,13
+pandas_plots-0.8.8.dist-info/RECORD,,