Temporal Timezone¶
Utilities for working with timezones.
Timezone Module¶
Timezone operations.
This submodule provides utilities for working with timezones using the standard library zoneinfo module (Python 3.9+).
Examples¶
from rite.temporal.timezone import timezone_get, timezone_convert from datetime import datetime, timezone dt = datetime.now(timezone.utc) timezone_convert(dt, "Europe/Amsterdam")
Modules¶
timezone_convert
¶
Timezone Convert¶
Convert datetime to different timezone.
Examples¶
from rite.temporal.timezone import timezone_convert from datetime import datetime, timezone dt = datetime.now(timezone.utc) timezone_convert(dt, "America/New_York")
Functions¶
timezone_convert(dt: datetime, target_tz: str) -> datetime
¶
Convert datetime to target timezone.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dt
|
datetime
|
Datetime object (should be timezone-aware). |
required |
target_tz
|
str
|
Target timezone name (IANA). |
required |
Returns:
| Type | Description |
|---|---|
datetime
|
Datetime in target timezone. |
Examples:
>>> from datetime import datetime, timezone
>>> dt = datetime(2024, 12, 27, 12, 0, tzinfo=timezone.utc)
>>> timezone_convert(dt, "America/New_York")
datetime.datetime(2024, 12, 27, 7, 0, ...)
Notes
Input datetime should be timezone-aware. Returns new datetime object.
timezone_get
¶
Timezone Get¶
Get timezone object.
Examples¶
from rite.temporal.timezone import timezone_get timezone_get("UTC") ZoneInfo(key='UTC')
Functions¶
timezone_get(name: str = 'UTC') -> ZoneInfo
¶
Get timezone object by name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Timezone name (IANA). Defaults to UTC. |
'UTC'
|
Returns:
| Type | Description |
|---|---|
ZoneInfo
|
ZoneInfo timezone object. |
Raises:
| Type | Description |
|---|---|
ZoneInfoNotFoundError
|
If timezone not found. |
Examples:
>>> timezone_get("UTC")
ZoneInfo(key='UTC')
>>> timezone_get("America/New_York")
ZoneInfo(key='America/New_York')
Notes
Uses IANA timezone database. Python 3.9+ required.
options: show_root_heading: true show_source: false heading_level: 2