alifestd_topological_sensitivity_warned_polars

alifestd_topological_sensitivity_warned_polars(*, insert: bool, delete: bool, update: bool) → Callable

Decorator that emits a topological sensitivity warning before the wrapped function executes.

The first positional argument of the decorated function must be the phylogeny dataframe (polars).

The decorated function gains two additional keyword arguments:

• ignore_topological_sensitivity (bool, default False): If True, suppress the topological sensitivity warning.

• drop_topological_sensitivity (bool, default False): If True, drop topology-sensitive columns from the result and suppress the warning.

Parameters

insertbool

Whether the operation inserts new nodes.

deletebool

Whether the operation deletes nodes.

updatebool

Whether the operation updates ancestor relationships.

Returns

typing.Callable

A decorator that wraps a function with topological sensitivity warning logic.

See Also

alifestd_topological_sensitivity_warned :

Pandas-based implementation.

alifestd_warn_topological_sensitivity_polars :

Underlying warning function.