flatbread 0.1.2__tar.gz → 0.1.4__tar.gz

{flatbread-0.1.2 → flatbread-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flatbread
-Version: 0.1.2
+Version: 0.1.4
 Summary: Pandas extension for aggregation and tabular display
 Project-URL: Homepage, https://github.com/lcvriend/flatbread
 Author-email: "L.C. Vriend" <vanboefer@gmail.com>

{flatbread-0.1.2 → flatbread-0.1.4}/flatbread/accessors/dataframe.py

@@ -65,6 +65,7 @@ class PitaFrame(PitaDisplayMixin):
         axis: int = 0,
         level: int|str|list[int|str] = 0,
         label: str = None,
+        include_level_name: bool = False,
         ignore_keys: str|list[str]|None = None,
         _fill: str = '',
     ) -> pd.DataFrame:
@@ -99,6 +100,7 @@ class PitaFrame(PitaDisplayMixin):
             axis = axis,
             level = level,
             label = label,
+            include_level_name = include_level_name,
             ignore_keys = ignore_keys,
             _fill = _fill,
         )
@@ -252,6 +254,7 @@ class PitaFrame(PitaDisplayMixin):
         axis: int = 2,
         level: int|str|list[int|str] = 0,
         label: str|None = None,
+        include_level_name: bool = False,
         ignore_keys: str|list[str]|None = None,
         _fill: str = '',
     ) -> pd.DataFrame:
@@ -279,6 +282,7 @@ class PitaFrame(PitaDisplayMixin):
             axis = axis,
             level = level,
             label = label,
+            include_level_name = include_level_name,
             ignore_keys = ignore_keys,
             _fill = _fill,
         )

{flatbread-0.1.2 → flatbread-0.1.4}/flatbread/accessors/series.py

@@ -60,6 +60,7 @@ class PitaSeries(PitaDisplayMixin):
         aggfunc: str|Callable,
         level: int|str|list[int|str] = 0,
         label: str = None,
+        include_level_name: bool = False,
         ignore_keys: str|list[str]|None = None,
         _fill: str = '',
     ) -> pd.Series:
@@ -91,6 +92,7 @@ class PitaSeries(PitaDisplayMixin):
             aggfunc,
             level = level,
             label = label,
+            include_level_name = include_level_name,
             ignore_keys = ignore_keys,
             _fill = _fill,
         )
@@ -256,6 +258,7 @@ class PitaSeries(PitaDisplayMixin):
         self,
         level: int|str|list[int|str] = 0,
         label: str|None = None,
+        include_level_name: bool = False,
         ignore_keys: str|list[str]|None = None,
         _fill: str = '',
     ) -> pd.Series:
@@ -280,6 +283,7 @@ class PitaSeries(PitaDisplayMixin):
             self._obj,
             level = level,
             label = label,
+            include_level_name = include_level_name,
             ignore_keys = ignore_keys,
             _fill = _fill,
         )

{flatbread-0.1.2 → flatbread-0.1.4}/flatbread/agg/aggregation.py

@@ -109,6 +109,7 @@ def add_subagg(
     *args,
     level: int|str|list[int|str] = 0,
     label: str|None = None,
+    include_level_name: bool = False,
     ignore_keys: str|list[str]|None = None,
     **kwargs,
 ):
@@ -123,6 +124,7 @@ def _(
     *args,
     level: int|str|list[int|str] = 0,
     label: str|None = None,
+    include_level_name: bool = False,
     ignore_keys: str|list[str]|None = None,
     _fill = '',
     **kwargs,
@@ -134,6 +136,7 @@ def _(
         *args,
         level = level,
         label = label,
+        include_level_name = include_level_name,
         ignore_keys = ignore_keys,
         _fill = _fill,
         **kwargs,
@@ -150,6 +153,7 @@ def _(
     axis: int = 0,
     level: int|str|list[int|str] = 0,
     label: str|None = None,
+    include_level_name: bool = False,
     ignore_keys: str|list[str]|None = None,
     _fill = '',
     **kwargs,
@@ -161,6 +165,7 @@ def _(
         *args,
         level = level,
         label = label,
+        include_level_name = include_level_name,
         ignore_keys = ignore_keys,
         _fill = _fill,
         **kwargs,
@@ -176,6 +181,7 @@ def _subagg_implementation(
     *args,
     level: int|str|list[int|str] = 0,
     label: str|None = None,
+    include_level_name: bool = False,
     ignore_keys: str|list[str]|None = None,
     _fill = '',
     **kwargs,
@@ -196,8 +202,19 @@ def _subagg_implementation(
         for levels, group in groups:
             # create key
             levels = (levels,) if pd.api.types.is_scalar(levels) else levels
+
+            # format label with level name if requested
+            current_label = label
+            if include_level_name:
+                # get level name
+                if isinstance(level, (int, str)):
+                    level_name = names[level] if isinstance(level, int) else level
+                    current_label = f"{label} {level_name}"
+                elif isinstance(levels[-1], str):
+                    current_label = f"{label} {levels[-1]}"
+
             padding = [_fill] * (len(names) - len(levels) - 1)
-            key = list(levels) + [label] + padding
+            key = list(levels) + [current_label] + padding
 
             # ignore totals and subtotal rows when aggregating
             rows = chaining.get_data_mask(group.index, ignore_keys)

{flatbread-0.1.2 → flatbread-0.1.4}/flatbread/agg/totals.py

@@ -95,6 +95,7 @@ def add_subtotals(
 def _(
     data: pd.Series,
     level: int|str|list[int|str] = 0,
+    include_level_name: bool = False,
     label: str = 'Subtotals',
     ignore_keys: str|list[str]|None = 'Totals',
     _fill: str|None = '',
@@ -104,6 +105,7 @@ def _(
         'sum',
         level = level,
         label = label,
+        include_level_name = include_level_name,
         ignore_keys = ignore_keys,
         _fill = _fill,
     )
@@ -118,6 +120,7 @@ def _(
     axis: int = 0,
     level: int|str|list[int|str] = 0,
     label: str = 'Subtotals',
+    include_level_name: bool = False,
     ignore_keys: str|list[str]|None = 'Totals',
     _fill: str = '',
 ) -> pd.DataFrame:
@@ -128,6 +131,7 @@ def _(
             axis = axis,
             level = level,
             label = label,
+            include_level_name = include_level_name,
             ignore_keys = ignore_keys,
             _fill = _fill,
         )
@@ -139,6 +143,7 @@ def _(
                 axis = 0,
                 level = level,
                 label = label,
+                include_level_name = include_level_name,
                 ignore_keys = ignore_keys,
                 _fill = _fill,
             )
@@ -147,6 +152,7 @@ def _(
                 axis = 1,
                 level = level,
                 label = label,
+                include_level_name = include_level_name,
                 ignore_keys = ignore_keys,
                 _fill = _fill,
             )

{flatbread-0.1.2 → flatbread-0.1.4}/flatbread/chaining.py

@@ -13,18 +13,38 @@ def get_data_mask(index, ignore_keys):
     index (pd.Index):
         The index used for determining if a row/column contains data or not.
     ignore_keys (list[str]):
-        List of index keys indicating that a row/column is *not* a data column. If the index is a MultiIndex then a row/column will be ignored if the key is in the keys of the index, else a row/column will be ignored if it is equal to the key in the index.
+        List of index keys indicating that a row/column is *not* a data column. If the index is a MultiIndex then a row/column will be ignored if the key is in the keys of the index, else a row/column will be ignored if it is equal to or a prefix of the key in the index.
 
     Returns
     -------
     pd.Index:
         Boolean index indicating which rows/columns refer to data.
     """
+    if ignore_keys is None:
+        return pd.Series(True, index=index)
+
+    # Convert single string to list
+    if isinstance(ignore_keys, str):
+        ignore_keys = [ignore_keys]
+
+    def should_keep(value):
+        # direct match
+        if value in ignore_keys:
+            return False
+
+        # check for prefix
+        if isinstance(value, str):
+            for key in ignore_keys:
+                if isinstance(key, str) and value.startswith(key):
+                    return False
+        return True
+
     if isinstance(index, pd.MultiIndex):
-        ignored = index.map(lambda i: all(key not in i for key in ignore_keys))
+        result = [all(should_keep(el) for el in idx) for idx in index]
     else:
-        ignored = index.map(lambda i: all(key != i for key in ignore_keys))
-    return ignored
+        result = [should_keep(idx) for idx in index]
+
+    return pd.Series(result, index=index)
 
 
 def persist_ignored(component: str, label: str) -> Callable:

{flatbread-0.1.2 → flatbread-0.1.4}/flatbread/config/config.defaults.json

@@ -5,6 +5,7 @@
     },
     "subtotals": {
         "label": "Subtotals",
+        "include_level_name": false,
         "ignore_keys": ["Totals"]
     },
     "percentages": {
@@ -13,5 +14,14 @@
         "ndigits": -1,
         "base": 1
     },
-    "locale": null
+    "locale": null,
+    "format_presets": {
+        "currency_eur": {
+            "dtypes": ["float", "int"],
+            "options": {
+                "style": "currency",
+                "currency": "EUR"
+            }
+        }
+    }
 }

{flatbread-0.1.2 → flatbread-0.1.4}/flatbread/render/constants.py

@@ -2,6 +2,19 @@
 from flatbread import DEFAULTS
 
 
+USER_PRESETS = DEFAULTS.get("format_presets", {})
+USER_PRESETS_BY_DTYPE = {
+    dtype: set()
+    for dtype in ["float", "int", "datetime", "str", "category"]
+}
+
+for preset_name, preset_config in USER_PRESETS.items():
+    preset_dtypes = preset_config.get("dtypes", ["float", "int"])  # Default to numeric
+    for dtype in preset_dtypes:
+        if dtype in USER_PRESETS_BY_DTYPE:
+            USER_PRESETS_BY_DTYPE[dtype].add(preset_name)
+
+
 SMART_FORMATS = {
     'percentages': {
         'labels': [DEFAULTS['percentages']['label_pct']],
@@ -43,7 +56,7 @@ NUMBER_PRESETS = {"default", "currency", "percentage", "compact", "diffs"}
 DATE_PRESETS = {"default", "date", "datetime"}
 
 DTYPE_TO_PRESETS = {
-    "float": NUMBER_PRESETS,
-    "int": NUMBER_PRESETS,
-    "datetime": DATE_PRESETS
+    "float": NUMBER_PRESETS.union(USER_PRESETS_BY_DTYPE["float"]),
+    "int": NUMBER_PRESETS.union(USER_PRESETS_BY_DTYPE["int"]),
+    "datetime": DATE_PRESETS.union(USER_PRESETS_BY_DTYPE["datetime"]),
 }

{flatbread-0.1.2 → flatbread-0.1.4}/flatbread/render/display.py

@@ -147,6 +147,52 @@ class PitaDisplayMixin:
         self._table_spec_builder.set_formats(formats)
         return self
 
+    def list_format_presets(self, dtype: str = None) -> dict[str, dict]:
+        """List available format presets, optionally filtered by data type
+
+        Parameters
+        ----------
+        dtype : str, optional
+            Filter presets by data type compatibility. Options: 'float', 'int',
+            'datetime', 'str', 'category'.
+
+        Returns
+        -------
+        dict
+            Dictionary of preset names and their configurations
+        """
+        from flatbread.render.constants import USER_PRESETS, DTYPE_TO_PRESETS
+
+        # Define built-in presets with their configurations
+        built_in = {
+            "default": {"notation": "standard"},
+            "currency": {"style": "currency", "currency": "USD"},
+            "percentage": {"style": "percent"},
+            "compact": {"notation": "compact"},
+            "date": {"dateStyle": "short"},
+            "datetime": {"dateStyle": "short", "timeStyle": "short"}
+        }
+
+        # Extract user preset options
+        user_options = {
+            name: config.get("options", {})
+            for name, config in USER_PRESETS.items()
+        }
+
+        # Combine built-in and user presets
+        all_presets = {**built_in, **user_options}
+
+        # Filter by dtype if specified
+        if dtype:
+            if dtype not in DTYPE_TO_PRESETS:
+                valid_dtypes = ", ".join(sorted(DTYPE_TO_PRESETS.keys()))
+                raise ValueError(f"Invalid dtype '{dtype}'. Valid options are: {valid_dtypes}")
+
+            valid_presets = DTYPE_TO_PRESETS.get(dtype, set())
+            return {k: v for k, v in all_presets.items() if k in valid_presets}
+
+        return all_presets
+
     def _repr_html_(self) -> str:
         """Generate HTML representation for Jupyter display"""
         spec = self._table_spec_builder.get_spec_as_json()

{flatbread-0.1.2 → flatbread-0.1.4}/flatbread/render/tablespec.py

@@ -94,17 +94,51 @@ class TableSpecBuilder:
                     return format_type['options']
         return None
 
-    def set_format(self, column: str, format_spec: ColumnFormat) -> None:
+    def set_format(self, column: str, format_spec: str | dict[str, Any]) -> None:
+        """Set format options for a column
+
+        Parameters
+        ----------
+        column : str
+            Column to format
+        format_spec : str | dict
+            Either a preset name (e.g. 'currency') or format options dict
+        """
+        from flatbread.render.constants import USER_PRESETS, DTYPE_TO_PRESETS, DEFAULT_DTYPES
+
         if isinstance(format_spec, str):
+            # Check if it's a user-defined preset
+            if format_spec in USER_PRESETS:
+                pandas_dtype = str(self._data[column].dtype)
+                simple_dtype = DEFAULT_DTYPES.get(pandas_dtype, 'str')
+
+                # Get allowed dtypes for this preset
+                preset_config = USER_PRESETS[format_spec]
+                allowed_dtypes = preset_config.get("dtypes", ["float", "int"])
+
+                if simple_dtype in allowed_dtypes:
+                    self._format_options[column] = preset_config.get("options", {})
+                    return
+                else:
+                    raise ValueError(
+                        f"Preset '{format_spec}' is not compatible with column '{column}' "
+                        f"of dtype {pandas_dtype} (mapped to {simple_dtype}). "
+                        f"This preset supports: {', '.join(allowed_dtypes)}"
+                    )
+
+            # Handle built-in presets
             pandas_dtype = str(self._data[column].dtype)
             simple_dtype = DEFAULT_DTYPES.get(pandas_dtype, 'str')
             valid_presets = DTYPE_TO_PRESETS.get(simple_dtype, set())
+
             if format_spec not in valid_presets:
                 valid = ", ".join(sorted(valid_presets))
                 raise ValueError(
                     f"Invalid preset '{format_spec}' for dtype {pandas_dtype} "
                     f"(mapped to {simple_dtype}). Valid presets are: {valid}"
                 )
+
+        # If we reached here, either format_spec is a dict or a valid built-in preset
         self._format_options[column] = format_spec
 
     def set_formats(self, formats: FormatSpec) -> None:
@@ -112,11 +146,15 @@ class TableSpecBuilder:
 
         Parameters
         ----------
-        formats : dict, list or callable
-            Either dict mapping column names to format specs,
-            a list of length columns,
-            or function that takes DataFrame and returns such dict
+        formats : str, dict, list or callable
+            - If string: apply the same format preset to all columns
+            - If dict: mapping column names to format specs
+            - If list: format specs in same order as columns
+            - If callable: function that takes DataFrame and returns a dict
         """
+        if isinstance(formats, str):
+            formats = {column: formats for column in self._data.columns}
+
         if callable(formats):
             formats = formats(self._data)
 

{flatbread-0.1.2 → flatbread-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "flatbread"
-version = "0.1.2"
+version = "0.1.4"
 description = "Pandas extension for aggregation and tabular display"
 readme = "readme.md"
 requires-python = ">=3.10"