Skip to content

Default to UTC timezone #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stefanv merged 10 commits into from
Dec 4, 2025
+41 −2
Merged

Default to UTC timezone #116

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a2c593a
BUG: defaulting to UTC tz rather than to None
bsipocz Jul 29, 2025
95b8a7d
BUG: again, default tz to UTC
bsipocz Jul 29, 2025
a4405a8
MAINT: ignore ruff
bsipocz Jul 29, 2025
fa9a56c
MAINT: this really is becoming ridiculous
bsipocz Jul 29, 2025
765d473
Revert "BUG: again, default tz to UTC"
bsipocz Dec 3, 2025
e9fdbc6
TST: adding test for defaulting to UTC
bsipocz Dec 3, 2025
00216b5
Revert "Revert "BUG: again, default tz to UTC""
bsipocz Dec 3, 2025
765a076
Revert "Revert "Revert "BUG: again, default tz to UTC"""
bsipocz Dec 3, 2025
c5d4b82
Changing the default
bsipocz Dec 3, 2025
344bdf0
Document UTC default
stefanv Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ ignore = [
"ARG001", # Unused function argument
"PT012", # `pytest.raises()` block
"PLW0129", # Asserting on a non-empty string literal will always pass
"SIM108", # Use ternary operator instead of `if`-`else`-block
]

[tool.pytest.ini_options]
Expand Down
16 changes: 16 additions & 0 deletions tests/test_events.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,3 +173,19 @@ def test_events_with_multiple_timezones():
assert events[1].begin.tzname() in ("UTC", "Coordinated Universal Time")
assert events[2].begin.tzname() == "PDT"
assert events[3].begin.tzname() == "PST"


def test_events_without_timezone():
f = io.BytesIO(b"""
name: Default Timezone
events:
- summary: Meeting A
begin: 2025-09-02 17:00:00
duration: { minutes: 60 }
- summary: Meeting B
begin: 2025-12-01 09:00:00
end: 2025-12-01 10:00:00
""")
events, _ = files_to_events([f])
assert events[0].begin.tzname() in ("UTC", "Coordinated Universal Time")
assert events[1].begin.tzname() in ("UTC", "Coordinated Universal Time")
10 changes: 7 additions & 3 deletions yaml2ics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,18 +52,20 @@ def gettz(tzname: str) -> datetime.tzinfo:
# This function can be used to add a list of e.g. exception dates (EXDATE) or
# recurrence dates (RDATE) to a reoccurring event
def add_recurrence_property(
Copy link
Copy Markdown
Member

@stefanv stefanv Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we make TZ required for now; this is for internal use anyway.

event: ics.Event, property_name, dates: map, tz: datetime.tzinfo = None
event: ics.Event, property_name, dates: map, tz: datetime.tzinfo = dateutil.tz.UTC
):
event.extra.append(
ics.ContentLine(
name=property_name,
params={"TZID": [str(ics.Timezone.from_tzinfo(tz))]} if tz else None,
params={"TZID": [str(ics.Timezone.from_tzinfo(tz))]},
value=",".join(dates),
)
)


def event_from_yaml(event_yaml: dict, tz: datetime.tzinfo = None) -> ics.Event:
def event_from_yaml(
event_yaml: dict, tz: datetime.tzinfo = dateutil.tz.UTC
Copy link
Copy Markdown
Member

@stefanv stefanv Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think either change the default, or change the handling below, but not both.

Copy link
Copy Markdown
Member Author

@bsipocz bsipocz Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel it makes most sense to change the default here, and then let the event timezone overwrite. Or it maybe cleaner to drop the tz kwarg altogether and rely only on the yaml and have a conditional?

    if "timezone" in d:
        tz = gettz(d.pop("timezone"))
    else:
        tz = dateutil.tz.UTC

Copy link
Copy Markdown
Member

@stefanv stefanv Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or, just break if the event_yaml does not have a timezone.

Copy link
Copy Markdown
Member

@stefanv stefanv Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, after #125 this becomes the crux of the current PR. We should document this in the README.

) -> ics.Event:
d = event_yaml
repeat = d.pop("repeat", None)
ics_custom = d.pop("ics", None)
Expand Down Expand Up @@ -184,6 +186,8 @@ def files_to_events(files: list) -> (ics.Calendar, str):
tz = calendar_yaml.get("timezone", None)
if tz is not None:
tz = gettz(tz)
else:
Comment thread
bsipocz marked this conversation as resolved.
Outdated
tz = dateutil.tz.UTC
if "include" in calendar_yaml:
included_events, _name = files_to_events(
os.path.join(os.path.dirname(f), newfile)
Expand Down