icalendar.timezone.tzp module

class icalendar.timezone.tzp.TZP(provider='zoneinfo')

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.

cache_timezone_component(timezone_component)

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().

clean_timezone_id(tzid)

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)

Create a timezone from a timezone component.

This component will not be cached.

fix_rrule_until(rrule, ical_rrule)

Make sure the until value works.

Return type:

None

localize(dt, tz)

Localize a datetime to a timezone.

Return type:

datetime

localize_utc(dt)

Return the datetime in UTC.

If the datetime has no timezone, set UTC as its timezone.

Return type:

datetime

property name: str

The name of the timezone component used.

timezone(tz_id)

Return a timezone with an id or None if we cannot find it.

Return type:

Optional[tzinfo]

use(provider)

Switch to a different timezone provider.

use_default()

Use the default timezone provider.

use_pytz()

Use pytz as the timezone provider.

Return type:

None

use_zoneinfo()

Use zoneinfo as the timezone provider.

Return type:

None

uses_pytz()

Whether we use pytz at all.

Return type:

bool

uses_zoneinfo()

Whether we use zoneinfo.

Return type:

bool