icalendar.timezone.tzp module#

class icalendar.timezone.tzp.TZP(provider='zoneinfo')[source]#

Bases: object

This is the timezone provider proxy.

If you would like to have another timezone implementation, you can create a new one and pass it to this proxy. All of icalendar will then use this timezone implementation.

Create a new timezone implementation proxy.

cache_timezone_component(timezone_component)[source]#

Cache the timezone that is created from a timezone component if it is not already known.

This can influence the result from timezone(): Once cached, the custom timezone is returned from timezone().

Return type:: None

clean_timezone_id(tzid)[source]#

Return a clean version of the timezone id.

Timezone ids can be a bit unclean, starting with a / for example. Internally, we should use this to identify timezones.

Return type:: str

create_timezone(timezone_component)[source]#

Create a timezone from a timezone component.

This component will not be cached.

Return type:: tzinfo

fix_rrule_until(rrule, ical_rrule)[source]#

Make sure the until value works.

Return type:: None

localize(dt, tz)[source]#

Localize a date, datetime or time to a timezone.

Overloads:

dt (datetime), tz (tzinfo | str | None) → datetime
dt (time), tz (tzinfo | str | None) → time
dt (date), tz (tzinfo | str | None) → datetime

Use tz=None to remove the timezone.

Returns:

A localized datetime.datetime when a datetime.datetime is given.
A localized datetime.datetime at midnight when a datetime.date is given.
A localized datetime.time when a datetime.time is given.

localize_utc(dt)[source]#

Return the value in UTC.

Overloads:

dt (datetime) → datetime
dt (time) → time
dt (date) → datetime

If the value has no timezone, set UTC as its timezone. Otherwise, the same date/time in UTC is returned.

Returns:

A localized datetime.datetime in UTC when a datetime.datetime is given.
A localized datetime.datetime at midnight in UTC when a datetime.date is given.
A localized datetime.time in UTC when a datetime.time is given.

property name: str#: The name of the timezone component used.

timezone(tz_id)[source]#

Return a timezone with an ID or None if we can't find it.

tz_id may be a plain Olson name (Europe/Berlin), a Windows timezone name, or a "globally unique" identifier (RFC 5545 Section 3.2.19) such as /freeassociation.sourceforge.net/Europe/Berlin. We try the candidate IDs from _lookup_ids in order, checking the cache before the provider for each one, and cache the first match under the primary ID so the next lookup is fast.

A lookup that is resolved by guessing the trailing Olson identifier emits GloballyUniqueTZIDGuessed on every call, including when the result is served from the cache.

Return type:: tzinfo | None

use(provider)[source]#

Switch to a different timezone provider.

Return type:: None

use_default()[source]#

Use the default timezone provider.

Return type:: None

use_pytz()[source]#

Use pytz as the timezone provider.

Return type:: None

use_zoneinfo()[source]#

Use zoneinfo as the timezone provider.

Return type:: None

uses_pytz()[source]#

Whether we use pytz at all.

Return type:: bool

uses_zoneinfo()[source]#

Whether we use zoneinfo.

Return type:: bool