Function localtime

tortoise/timezone.py:100–117

Convert an aware datetime.datetime to local time. Only aware datetime are allowed. When value is omitted, it defaults to now(). Local time is defined by the current time zone, unless another time zone is specified. :raises ValueError: when value is naive datetime

(value: datetime | None = None, timezone: tzinfo | str | None = None)

def localtime(value: datetime | None = None, timezone: tzinfo | str | None = None) -> datetime:
    """
    Convert an aware datetime.datetime to local time.

    Only aware datetime are allowed. When value is omitted, it defaults to
    now().

    Local time is defined by the current time zone, unless another time zone
    is specified.

    :raises ValueError: when value is naive datetime
    """
    if value is None:
        value = now()
    elif is_naive(value):
        raise ValueError("localtime() cannot be applied to a naive datetime")
    tz = _get_or_parse_timezone(timezone)
    return value.astimezone(tz)


def is_aware(value: datetime | time) -> bool: