Builtin

liquid2.builtin.register_default_tags_and_filters

register_default_tags_and_filters(env: Environment) -> None

Register standard tags and filters with an environment.

liquid2.builtin.BaseTranslateFilter

Base class for the default translation filters.

PARAMETER	DESCRIPTION
translations_var	The name of a render context variable that resolves to a gettext Translations class. Defaults to "translations". TYPE: str DEFAULT: 'translations'
default_translations	A fallback translations class to use if translations_var can not be resolves. Defaults to NullTranslations. TYPE: Translations | None DEFAULT: None
message_interpolation	If True (default), perform printf-style string interpolation on the translated message, using keyword arguments passed to the filter function. TYPE: bool DEFAULT: True
auto_escape_message	If True and the current environment has auto_escape set to True, the filter's left value will be escaped before translation. Defaults to False. TYPE: bool DEFAULT: False

format_message

format_message(
    context: RenderContext,
    message_text: str,
    message_vars: dict[str, Any],
) -> str

Return the message string formatted with the given message variables.

liquid2.builtin.Currency

A Liquid filter for formatting currency values.

PARAMETER	DESCRIPTION
currency_code_var	The name of a render context variable that resolves to the current currency code. Defaults to "currency_code". TYPE: str DEFAULT: 'currency_code'
default_currency_code	A fallback currency code if currency_code_var can not be resolved. Defaults to "USD". TYPE: str DEFAULT: 'USD'
locale_var	The name of a render context variable that resolves to the current locale. Defaults to "locale". TYPE: str DEFAULT: 'locale'
default_locale	A fallback locale to use if locale_var can not be resolved. Defaults to "en_US". DEFAULT: 'en_US'
format_var	The name of a render context variable that resolves to the current currency format string. Defaults to "currency_format". TYPE: str DEFAULT: 'currency_format'
default_format	A fallback currency format that is used if format_var can not be resolved. Defaults to None, which means the standard format for the current locale will be used. TYPE: str | None DEFAULT: None
currency_digits	Indicates if the format should override locale specific trailing digit behavior. Defaults to False. TYPE: bool DEFAULT: True
input_locale_var	The name of a render context variable that resolves to a locale suitable for parsing input strings to decimals. Defaults to "input_locale". TYPE: str DEFAULT: 'input_locale'
default_input_locale	A fallback locale to use if input_locale_var can not be resolved. Defaults to "en_US". TYPE: str DEFAULT: 'en_US'

__call__

__call__(
    left: object,
    *,
    context: RenderContext,
    group_separator: bool = True
) -> str

Apply the filter and return the result.

liquid2.builtin.DateTime

A Liquid filter for formatting datetime objects.

PARAMETER	DESCRIPTION
timezone_var	The name of a render context variable that resolves to a timezone. Defaults to "timezone". TYPE: str DEFAULT: 'timezone'
default_timezone	A fallback timezone to use if timezone_var can not be resolved. Defaults to "UTC". TYPE: str DEFAULT: 'UTC'
locale_var	The name of a render context variable that resolves to the current locale. Defaults to "locale". TYPE: str DEFAULT: 'locale'
default_locale	A fallback locale to use if locale_var can not be resolved. Defaults to "en_US". TYPE: str DEFAULT: 'en_US'
format_var	The name of a render context variable that resolves to the current datetime format string. Defaults to "datetime_format". TYPE: str DEFAULT: 'datetime_format'
default_format	A fallback datetime format that is used if format_var can not be resolved. Defaults to "medium". TYPE: str DEFAULT: 'medium'
input_timezone_var	The name of a render context variable that resolves to a timezone for parsing datetimes entered as strings. Defaults to "input_timezone". TYPE: str DEFAULT: 'input_timezone'
default_input_timezone	A fallback timezone to use if input_timezone_var can not be resolved. Defaults to "UTC". TYPE: str DEFAULT: 'UTC'

__call__

__call__(
    left: object,
    *,
    context: RenderContext,
    format: str | None = None
) -> str

Apply the filter and return the result.

liquid2.builtin.GetText

Bases: BaseTranslateFilter, TranslatableFilter

A Liquid filter equivalent of gettext.gettext.

liquid2.builtin.JSON

Serialize an object to a JSON formatted string.

PARAMETER	DESCRIPTION
default	A function passed to json.dumps. This function is called in the event that the JSONEncoder does not know how to serialize an object. Defaults to None. TYPE: Callable[[Any], Any] | None DEFAULT: None

__call__

__call__(left: object, indent: object | None = None) -> str

Apply this filter to left and return the result.

liquid2.builtin.NGetText

Bases: BaseTranslateFilter, TranslatableFilter

A Liquid filter equivalent of gettext.ngettext.

__call__

__call__(
    __left: object,
    __plural: str,
    __count: object,
    *,
    context: RenderContext,
    **kwargs: Any
) -> str

Apply the filter and return the result.

liquid2.builtin.NPGetText

Bases: BaseTranslateFilter, TranslatableFilter

A Liquid filter equivalent of gettext.npgettext.

liquid2.builtin.Number

A Liquid filter for formatting decimal values.

PARAMETER	DESCRIPTION
decimal_quantization_var	The name of a render context variable that resolves to the decimal quantization to be used. Defaults to "decimal_quantization". TYPE: str DEFAULT: 'decimal_quantization'
default_decimal_quantization	A fallback decimal quantization if decimal_quantization_var can not be resolved. Defaults to False. TYPE: bool DEFAULT: False
locale_var	The name of a render context variable that resolves to the current locale. Defaults to "locale". TYPE: str DEFAULT: 'locale'
default_locale	A fallback locale to use if locale_var can not be resolved. Defaults to "en_US". TYPE: str DEFAULT: 'en_US'
format_var	The name of a render context variable that resolves to the current decimal format string. Defaults to "decimal_format". TYPE: str DEFAULT: 'decimal_format'
default_format	A fallback decimal format that is used if format_var can not be resolved. Defaults to None, which means the standard format for the current locale will be used. TYPE: str | None DEFAULT: None
input_locale_var	The name of a render context variable that resolves to a locale suitable for parsing input strings to decimals. Defaults to "input_locale". TYPE: str DEFAULT: 'input_locale'
default_input_locale	A fallback locale to use if input_locale_var can not be resolved. Defaults to "en_US". TYPE: str DEFAULT: 'en_US'

__call__

__call__(
    left: object,
    *,
    context: RenderContext,
    group_separator: bool = True
) -> str

Apply the filter and return the result.

liquid2.builtin.PGetText

Bases: BaseTranslateFilter, TranslatableFilter

A Liquid filter equivalent of gettext.pgettext.

liquid2.builtin.Translate

Bases: BaseTranslateFilter, TranslatableFilter

A Liquid filter for translating strings to other languages.

Depending on the keyword arguments provided when the resulting filter is called, it could behave like gettext, ngettext, pgettext or npgettext.

__call__

__call__(
    __left: object,
    __message_context: object = None,
    *,
    context: RenderContext,
    **kwargs: Any
) -> str

Apply the filter and return the result.

liquid2.builtin.TranslateTag

Bases: Tag

The built-in "translate" tag.

parse

parse(stream: TokenStream) -> TranslateNode

Parse tokens from stream into an AST node.

validate_message_block

validate_message_block(
    block: BlockNode | None,
) -> MessageBlock | None

Check that a translation message block does not contain disallowed markup.

liquid2.builtin.Unit

A Liquid filter for formatting units of measurement.

PARAMETER	DESCRIPTION
locale_var	The name of a render context variable that resolves to the current locale. Defaults to "locale". TYPE: str DEFAULT: 'locale'
default_locale	A fallback locale to use if locale_var can not be resolved. Defaults to "en_US". TYPE: str DEFAULT: 'en_US'
length_var	The name of a render context variable that resolves to a unit format length. Should be one of "short", "long" or "narrow". Defaults to "long". TYPE: str DEFAULT: 'unit_length'
default_length	A fallback format length to use if length_var can not be resolved. TYPE: str DEFAULT: 'long'
format_var	The name of a render context variable that resolves to a decimal format string. Defaults to "unit_format". TYPE: str DEFAULT: 'unit_format'
default_format	A fallback decimal format to use if format_var can not be resolved. Defaults to None, meaning the locale's standard decimal format is used. TYPE: str | None DEFAULT: None
input_locale_var	The name of a render context variable that resolves to a locale suitable for parsing input strings to decimals. Defaults to "input_locale". TYPE: str DEFAULT: 'input_locale'
default_input_locale	A fallback locale to use if input_locale_var can not be resolved. Defaults to "en_US". TYPE: str DEFAULT: 'en_US'