python-liquid 2.3.6__py3-none-any.whl → 3.0.0__py3-none-any.whl

liquid/extra/filters/babel.py

@@ -1,552 +0,0 @@
-"""A currency, date, time, number and unit formatting filters."""
-
-from __future__ import annotations
-
-from datetime import date
-from datetime import datetime
-from datetime import time
-from decimal import Decimal
-from functools import wraps
-from typing import TYPE_CHECKING
-from typing import Any
-from typing import Callable
-from typing import Optional
-from typing import Union
-
-import pytz
-from babel import Locale
-from babel import UnknownLocaleError
-from babel import dates
-from babel import numbers
-from babel import units
-from dateutil import parser
-
-from liquid.exceptions import LiquidTypeError
-from liquid.exceptions import LiquidValueError
-from liquid.filter import num_arg
-from liquid.filter import with_context
-from liquid.undefined import is_undefined
-
-if TYPE_CHECKING:
-    from liquid import RenderContext
-
-    FilterT = Callable[..., Any]
-
-
-def _resolve_locale(
-    context: RenderContext,
-    locale_var: str,
-    default: Locale,
-) -> Locale:
-    _locale = context.resolve(locale_var)
-
-    if is_undefined(_locale):
-        locale = default
-    elif isinstance(_locale, str):
-        try:
-            locale = Locale.parse(_locale)
-        except UnknownLocaleError:
-            locale = default
-    else:
-        raise LiquidTypeError(
-            f"expected a string argument, found {_locale}", token=None
-        )
-
-    return locale
-
-
-@with_context
-class Currency:
-    """A Liquid filter for formatting currency values.
-
-    Args:
-        currency_code_var: The name of a render context variable that resolves
-            to the current currency code. Defaults to `"currency_code"`.
-        default_currency_code: A fallback currency code if `currency_code_var`
-            can not be resolved. Defaults to `"USD"`.
-        locale_var: The name of a render context variable that resolves to the
-            current locale. Defaults to `"locale"`.
-        default_locale: A fallback locale to use if `locale_var` can not be
-            resolved. Defaults to `"en_US"`.
-        format_var: The name of a render context variable that resolves to the
-            current currency format string. Defaults to `"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.
-        currency_digits: Indicates if the format should override locale specific
-            trailing digit behavior. Defaults to `False`.
-        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"`.
-        default_input_locale: A fallback locale to use if `input_locale_var`
-            can not be resolved. Defaults to `"en_US"`.
-    """
-
-    def __init__(
-        self,
-        *,
-        currency_code_var: str = "currency_code",
-        default_currency_code: str = "USD",
-        locale_var: str = "locale",
-        default_locale: str = "en_US",
-        format_var: str = "currency_format",
-        default_format: Optional[str] = None,
-        currency_digits: bool = True,
-        input_locale_var: str = "input_locale",
-        default_input_locale: str = "en_US",
-    ) -> None:
-        self.currency_code_var = currency_code_var
-        self.default_currency_code = default_currency_code
-        self.locale_var = locale_var
-        self.default_locale = Locale.parse(default_locale)
-        self.format_var = format_var
-        self.default_format = default_format
-        self.currency_digits = currency_digits
-        self.input_locale_var = input_locale_var
-        self.default_input_locale = Locale.parse(default_input_locale)
-
-    def __call__(
-        self,
-        left: object,
-        *,
-        context: RenderContext,
-        group_separator: bool = True,
-    ) -> str:
-        """Apply the filter and return the result."""
-        locale = _resolve_locale(
-            context,
-            self.locale_var,
-            default=self.default_locale,
-        )
-
-        input_locale = _resolve_locale(
-            context,
-            self.input_locale_var,
-            default=self.default_input_locale,
-        )
-
-        _format = context.resolve(self.format_var, default=self.default_format)
-
-        if _format is not None and not isinstance(_format, str):
-            raise LiquidTypeError(
-                f"expected a string argument, found {_format}", token=None
-            )
-
-        currency_code = context.resolve(
-            self.currency_code_var,
-            default=self.default_currency_code,
-        )
-
-        if not isinstance(currency_code, str):
-            raise LiquidTypeError(
-                f"expected a string argument, found {currency_code}", token=None
-            )
-
-        return numbers.format_currency(
-            _parse_decimal(left, input_locale),
-            currency_code,
-            format=_format,
-            locale=locale,
-            group_separator=group_separator,
-            currency_digits=self.currency_digits,
-        )
-
-
-def _parse_decimal(val: object, locale: Union[str, Locale]) -> Decimal:
-    if isinstance(val, str):
-        try:
-            return numbers.parse_decimal(val, locale)
-        except numbers.NumberFormatError:
-            return Decimal(0)
-
-    if isinstance(val, (Decimal, float, int)):
-        return Decimal(val)
-
-    # Give objects that implement __int__ etc. a chance.
-    return Decimal(num_arg(val, 0))
-
-
-@with_context
-class DateTime:
-    """A Liquid filter for formatting datetime objects.
-
-    Args:
-        timezone_var: The name of a render context variable that resolves to
-            a timezone. Defaults to `"timezone"`.
-        default_timezone: A fallback timezone to use if `timezone_var` can
-            not be resolved. Defaults to `"UTC"`.
-        locale_var: The name of a render context variable that resolves to the
-            current locale. Defaults to `"locale"`.
-        default_locale: A fallback locale to use if `locale_var` can not be
-            resolved. Defaults to `"en_US"`.
-        format_var: The name of a render context variable that resolves to the
-            current datetime format string. Defaults to `"datetime_format"`.
-        default_format: A fallback datetime format that is used if `format_var`
-            can not be resolved. Defaults to `"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"`.
-        default_input_timezone: A fallback timezone to use if `input_timezone_var`
-            can not be resolved. Defaults to `"UTC"`.
-    """
-
-    formats = {
-        "short": "short",
-        "medium": "medium",
-        "long": "long",
-        "full": "full",
-    }
-
-    def __init__(
-        self,
-        *,
-        timezone_var: str = "timezone",
-        default_timezone: str = "UTC",
-        locale_var: str = "locale",
-        default_locale: str = "en_US",
-        format_var: str = "datetime_format",
-        default_format: str = "medium",
-        input_timezone_var: str = "input_timezone",
-        default_input_timezone: str = "UTC",
-    ) -> None:
-        self.timezone_var = timezone_var
-        self.default_timezone = pytz.timezone(default_timezone)
-        self.locale_var = locale_var
-        self.default_locale = Locale.parse(default_locale)
-        self.format_var = format_var
-        self.default_format = self.formats.get(default_format, default_format)
-        self.input_timezone_var = input_timezone_var
-        self.default_input_timezone = pytz.timezone(default_input_timezone)
-
-    def __call__(
-        self,
-        left: object,
-        *,
-        context: RenderContext,
-        format: Optional[str] = None,  # noqa: A002
-    ) -> str:
-        """Apply the filter and return the result."""
-        locale = _resolve_locale(
-            context,
-            self.locale_var,
-            default=self.default_locale,
-        )
-
-        if format:
-            _format = self.formats.get(format, format)
-        else:
-            format_string = context.resolve(self.format_var)
-
-            if is_undefined(format_string):
-                _format = self.default_format
-            elif not isinstance(format_string, str):
-                raise LiquidTypeError(
-                    f"expected a string argument, found {format_string}",
-                    token=None,
-                )
-            else:
-                _format = self.formats.get(format_string, format_string)
-
-        tzinfo = self._resolve_timezone(
-            context,
-            self.timezone_var,
-            default=self.default_timezone,
-        )
-        input_tzinfo = self._resolve_timezone(
-            context,
-            self.input_timezone_var,
-            default=self.default_input_timezone,
-        )
-
-        return dates.format_datetime(
-            _parse_datetime(left, input_tzinfo),
-            format=_format,
-            locale=locale,
-            tzinfo=tzinfo,
-        )
-
-    def _resolve_timezone(
-        self,
-        context: RenderContext,
-        timezone_var: str,
-        default: pytz.BaseTzInfo,
-    ) -> pytz.BaseTzInfo:
-        _tz = context.resolve(timezone_var)
-
-        if is_undefined(_tz):
-            timezone = default
-        elif isinstance(_tz, str):
-            try:
-                timezone = pytz.timezone(_tz)
-            except pytz.UnknownTimeZoneError:
-                timezone = default
-        else:
-            raise LiquidTypeError(
-                f"expected a string argument, found {_tz}",
-                token=None,
-            )
-
-        return timezone
-
-
-def _parse_number(val: str) -> Union[int, float]:
-    try:
-        return int(val)
-    except ValueError:
-        # Let the ValueError raise
-        return float(val)
-
-
-def _parse_datetime(
-    val: object,
-    default_timezone: pytz.BaseTzInfo,
-) -> Union[date, time, datetime, int, float, None]:
-    if isinstance(val, str):
-        # `date.format_datetime` will use the current timestamp if
-        # given `None`.
-        if val in ("now", "today"):
-            return None
-
-        # String representations of ints and floats need to be cast
-        # to an int or float, but not passed to the fuzzy parser.
-        try:
-            return _parse_number(val)
-        except ValueError:
-            pass
-
-        # Fuzzy parsing using dateutil.
-        try:
-            _dt = parser.parse(val)
-            if _dt.tzinfo is None:
-                return _dt.replace(tzinfo=default_timezone)
-            return _dt
-        except parser.ParserError as err:
-            raise LiquidValueError(str(err), token=None) from err
-
-    if not isinstance(val, (date, time, datetime, int, float)):
-        raise LiquidTypeError(
-            f"date expected date or time, found {type(val).__name__}", token=None
-        )
-
-    return val
-
-
-@with_context
-class Number:
-    """A Liquid filter for formatting decimal values.
-
-    Args:
-        decimal_quantization_var: The name of a render context variable that
-            resolves to the decimal quantization to be used. Defaults to
-            `"decimal_quantization"`.
-        default_decimal_quantization: A fallback decimal quantization if
-            `decimal_quantization_var` can not be resolved. Defaults to `False`.
-        locale_var: The name of a render context variable that resolves to the
-            current locale. Defaults to `"locale"`.
-        default_locale: A fallback locale to use if `locale_var` can not be
-            resolved. Defaults to `"en_US"`.
-        format_var: The name of a render context variable that resolves to the
-            current decimal format string. Defaults to `"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.
-        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"`.
-        default_input_locale: A fallback locale to use if `input_locale_var`
-            can not be resolved. Defaults to `"en_US"`.
-    """
-
-    def __init__(
-        self,
-        *,
-        decimal_quantization_var: str = "decimal_quantization",
-        default_decimal_quantization: bool = False,
-        locale_var: str = "locale",
-        default_locale: str = "en_US",
-        format_var: str = "decimal_format",
-        default_format: Optional[str] = None,
-        input_locale_var: str = "input_locale",
-        default_input_locale: str = "en_US",
-    ) -> None:
-        self.decimal_quantization_var = decimal_quantization_var
-        self.default_decimal_quantization = default_decimal_quantization
-        self.locale_var = locale_var
-        self.default_locale = Locale.parse(default_locale)
-        self.format_var = format_var
-        self.default_format = default_format
-        self.input_locale_var = input_locale_var
-        self.default_input_locale = Locale.parse(default_input_locale)
-
-    def __call__(
-        self,
-        left: object,
-        *,
-        context: RenderContext,
-        group_separator: bool = True,
-    ) -> str:
-        """Apply the filter and return the result."""
-        decimal_quantization = context.resolve(
-            self.decimal_quantization_var,
-            default=self.default_decimal_quantization,
-        )
-
-        if not isinstance(decimal_quantization, bool):
-            raise LiquidTypeError(
-                f"expected a Boolean argument, found {decimal_quantization}", token=None
-            )
-
-        locale = _resolve_locale(
-            context,
-            self.locale_var,
-            default=self.default_locale,
-        )
-
-        input_locale = _resolve_locale(
-            context,
-            self.input_locale_var,
-            default=self.default_input_locale,
-        )
-
-        _format = context.resolve(self.format_var, default=self.default_format)
-
-        if _format is not None and not isinstance(_format, str):
-            raise LiquidTypeError(
-                f"expected a string argument, found {_format}", token=None
-            )
-
-        return numbers.format_decimal(  # type: ignore
-            _parse_decimal(left, input_locale),
-            format=_format,
-            locale=locale,
-            group_separator=group_separator,
-            decimal_quantization=decimal_quantization,
-        )
-
-
-def unit_filter(_filter: FilterT) -> FilterT:
-    """A filter function decorator that handles `TypeError` and `UnknownUnitError`."""
-
-    @wraps(_filter)
-    def wrapper(val: object, *args: Any, **kwargs: Any) -> Any:
-        try:
-            return _filter(val, *args, **kwargs)
-        except TypeError as err:
-            raise LiquidTypeError(err, token=None) from err
-        except units.UnknownUnitError as err:
-            raise LiquidValueError(err, token=None) from err
-
-    return wrapper
-
-
-class Unit:
-    """A Liquid filter for formatting units of measurement.
-
-    Args:
-        locale_var: The name of a render context variable that resolves to the
-            current locale. Defaults to `"locale"`.
-        default_locale: A fallback locale to use if `locale_var` can not be
-            resolved. Defaults to `"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"`.
-        default_length: A fallback format length to use if `length_var` can
-            not be resolved.
-        format_var: The name of a render context variable that resolves to a
-            decimal format string. Defaults to `"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.
-        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"`.
-        default_input_locale: A fallback locale to use if `input_locale_var`
-            can not be resolved. Defaults to `"en_US"`.
-    """
-
-    with_context = True
-
-    def __init__(
-        self,
-        *,
-        locale_var: str = "locale",
-        default_locale: str = "en_US",
-        length_var: str = "unit_length",
-        default_length: str = "long",
-        format_var: str = "unit_format",
-        default_format: Optional[str] = None,
-        input_locale_var: str = "input_locale",
-        default_input_locale: str = "en_US",
-    ) -> None:
-        self.locale_var = locale_var
-        self.default_locale = Locale.parse(default_locale)
-        self.length_var = length_var
-        self.default_length = default_length
-        self.format_var = format_var
-        self.default_format = default_format
-        self.input_locale_var = input_locale_var
-        self.default_input_locale = Locale.parse(default_input_locale)
-
-    @unit_filter
-    def __call__(  # noqa: D102
-        self,
-        left: object,
-        measurement_unit: str,
-        *,
-        context: RenderContext,
-        denominator: object = None,
-        denominator_unit: Optional[str] = None,
-        length: Optional[str] = None,
-        format: Optional[str] = None,  # noqa: A002
-    ) -> str:
-        locale = _resolve_locale(
-            context,
-            self.locale_var,
-            default=self.default_locale,
-        )
-
-        input_locale = _resolve_locale(
-            context,
-            self.input_locale_var,
-            default=self.default_input_locale,
-        )
-
-        _length = length if length else context.resolve(self.length_var)
-
-        if _length not in ("short", "long", "narrow"):
-            _length = self.default_length
-
-        assert isinstance(_length, str)
-
-        if format:
-            _format: Optional[str] = format
-        else:
-            format_string = context.resolve(self.format_var)
-            if isinstance(format_string, str):
-                _format = format_string
-            else:
-                _format = self.default_format
-
-        if denominator is not None or denominator_unit is not None:
-            _denominator = (
-                _parse_decimal(denominator, input_locale)
-                if denominator is not None
-                else 1
-            )
-            return units.format_compound_unit(
-                _parse_decimal(left, input_locale),
-                numerator_unit=measurement_unit,
-                denominator_value=_denominator,  # type: ignore
-                denominator_unit=denominator_unit,
-                length=_length,  # type: ignore
-                format=_format,
-                locale=locale,
-            )
-
-        return units.format_unit(
-            _parse_decimal(left, input_locale),
-            measurement_unit=measurement_unit,
-            length=_length,  # type: ignore
-            format=_format,
-            locale=locale,
-        )

liquid/extra/filters/html.py

@@ -1,32 +0,0 @@
-"""Extra HTML filters."""
-from __future__ import annotations
-
-import html
-from typing import TYPE_CHECKING
-
-from liquid import Markup
-from liquid.filter import string_filter
-from liquid.filter import with_environment
-
-if TYPE_CHECKING:
-    from liquid import Environment
-
-
-@string_filter
-@with_environment
-def stylesheet_tag(url: str, *, environment: Environment) -> str:
-    """Wrap a URL in an HTML stylesheet tag."""
-    tag = '<link href="{}" rel="stylesheet" type="text/css" media="all" />'
-    if environment.autoescape:
-        return Markup(tag).format(str(url))
-    return tag.format(html.escape(url))
-
-
-@string_filter
-@with_environment
-def script_tag(url: str, *, environment: Environment) -> str:
-    """Wrap a URL in an HTML script tag."""
-    tag = '<script src="{}" type="text/javascript"></script>'
-    if environment.autoescape:
-        return Markup(tag).format(str(url))
-    return tag.format(html.escape(url))