Module

rendering.template_functions.math_functions

Math functions for templates.

Provides 6 essential mathematical operations for calculations in templates.

View source
7 Functions

Functions

register
Register math functions with Jinja2 environment.
2 None 
def register(env: Environment, site: Site) -> None

Register math functions with Jinja2 environment.

Parameters 2

Name Type Default Description
env Environment —
site Site —
percentage
Calculate percentage.
3 str 
def percentage(part: Number, total: Number, decimals: int = 0) -> str

Calculate percentage.

Parameters 3

Name Type Default Description
part Number —

Part value
total Number —

Total value
decimals int 0

Number of decimal places (default: 0)

Returns

str —

Formatted percentage string with % sign

times
Multiply value by multiplier.
2 Number 
def times(value: Number, multiplier: Number) -> Number

Multiply value by multiplier.

Parameters 2

Name Type Default Description
value Number —

Value to multiply
multiplier Number —

Multiplier

Returns

Number —

Product

divided_by
Divide value by divisor.
2 Number 
def divided_by(value: Number, divisor: Number) -> Number

Divide value by divisor.

Parameters 2

Name Type Default Description
value Number —

Value to divide
divisor Number —

Divisor

Returns

Number —

Quotient (0 if divisor is 0)

ceil_filter
Round up to nearest integer.
1 int 
def ceil_filter(value: Number) -> int

Round up to nearest integer.

Parameters 1

Name Type Default Description
value Number —

Value to round

Returns

int —

Ceiling value

floor_filter
Round down to nearest integer.
1 int 
def floor_filter(value: Number) -> int

Round down to nearest integer.

Parameters 1

Name Type Default Description
value Number —

Value to round

Returns

int —

Floor value

round_filter
Round to specified decimal places.
2 Number 
def round_filter(value: Number, decimals: int = 0) -> Number

Round to specified decimal places.

Parameters 2

Name Type Default Description
value Number —

Value to round
decimals int 0

Number of decimal places (default: 0)

Returns

Number —

Rounded value