holoviz-utils 0.6.0

A Python package for HoloViz utilities

holoviz-utils

A Python package for HoloViz utilities.

Installation

pip install -e .

For development:

pip install -e ".[dev]"

Usage

import holoviz_utils

Caption templates

DataPresentation renders the __doc__ of its components — and its title / introduction / conclusion params — as live captions. Any {...} token is substituted against current parameter values and re-rendered automatically whenever a referenced value changes.

A token is {[func(]param[keys][:fmt])} (only param is required):

• param — a parameter name, resolved on the presentation or any reachable sub-object (a DataCombiner, a layer, a colormap, …).
• [keys] — index/key lookups. A quoted key (['label']) is literal; an unquoted key ([highlight_name]) is another param ref whose value is used as the key — this is how you turn a code into a display name.
• func(...) — an optional whitelisted function (len, sum, min, max, abs, round, sorted, int, float, str, bool).
• :fmt — an optional Python format spec (:0.1f, :,, %Y-%m-%d, …).

A token that resolves to None renders as unknown.

# highlight_name == "Q"; cmap_var_styles == {"Q": {"label": "Discharge (m³/s)"}, ...}
dgl.__doc__ = (
    "Time-series for the {cmap_var_styles[highlight_name]['label']} at the "
    "{click_state['properties']['S6_SB_NAME']} sub-basin."
)
# -> "Time-series for the Discharge (m³/s) at the <name> sub-basin."

"{len(subbasins)} sub-basins selected"   # -> "3 sub-basins selected"
"mean = {max(scores['a']):0.2f}"          # -> "mean = 12.34"

To add a code -> display mapping, just expose it as a parameter and reference {table[code_param]['field']} — no derived params or manual watchers needed. See DataPresentation.update_doc for the full reference.

Development

Run tests:

pytest

License

MIT