Module

environment.filters._numbers

Number and math filters for Kida templates.

Functions

_filter_abs 1 Any
Return absolute value.
def _filter_abs(value: Any) -> Any
Parameters
Name Type Description
value Any
Returns
Any
_filter_round 4 float
Round a number to a given precision.
def _filter_round(value: Any, precision: int = 0, method: str = 'common', *, strict: bool = False) -> float
Parameters
Name Type Description
value Any
precision int Default:0
method str Default:'common'
strict bool Default:False
Returns
float
_filter_decimal 3 str
Format a number with a fixed number of decimal places.
def _filter_decimal(value: Any, places: int = 2, *, strict: bool = False) -> str
Parameters
Name Type Description
value Any

Value to format.

places int

Number of decimal places.

Default:2
strict bool

If True, raise TemplateRuntimeError on conversion failure.

Default:False
Returns
str
_filter_filesizeformat 2 str
Format a file size as human-readable.
def _filter_filesizeformat(value: Any, binary: bool = False) -> str
Parameters
Name Type Description
value Any
binary bool Default:False
Returns
str
_filter_format_number 3 str
Format a number with thousands separators.
def _filter_format_number(value: Any, decimal_places: int = 0, *, strict: bool = False) -> str
Parameters
Name Type Description
value Any

Value to format.

decimal_places int

Number of decimal places.

Default:0
strict bool

If True, raise TemplateRuntimeError on conversion failure.

Default:False
Returns
str
_filter_commas 1 str
Format a number with commas as thousands separators. Alias for format_number w…
def _filter_commas(value: Any) -> str

Format a number with commas as thousands separators.

Alias for format_number without decimal places.

Parameters
Name Type Description
value Any
Returns
str
_filter_min 2 Any
Return minimum value.
def _filter_min(value: Any, attribute: str | None = None) -> Any
Parameters
Name Type Description
value Any
attribute str | None Default:None
Returns
Any
_filter_max 2 Any
Return maximum value.
def _filter_max(value: Any, attribute: str | None = None) -> Any
Parameters
Name Type Description
value Any
attribute str | None Default:None
Returns
Any
_filter_sum 3 Any
Return sum of values.
def _filter_sum(value: Any, attribute: str | None = None, start: int = 0) -> Any
Parameters
Name Type Description
value Any
attribute str | None Default:None
start int Default:0
Returns
Any