Skip to content

Support zoned datetimes in query modules #3121

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

Jump to bottom
Merged
colinbarry merged 44 commits into from
Aug 20, 2025
Merged

Support zoned datetimes in query modules #3121

colinbarry merged 44 commits into from
Aug 20, 2025

Conversation

@colinbarry
Copy link
Contributor

@colinbarry colinbarry commented Jul 18, 2025 •
edited
Loading

Add support for ZonedDateTime types in query modules.

  • ZonedDateTime with a timezone (either numeric offset or named time identifier) can be passed to query modules.
  • Any datetimes returned by a Python query module will be converted into a ZonedDateTime if they have a valid timezone tzinfo, otherwise, they will be treated as LocalDateTimes.

@colinbarry colinbarry self-assigned this Jul 18, 2025
@colinbarry
Copy link
Contributor Author

colinbarry commented Jul 18, 2025 •
edited
Loading

Tracking

  • [Link to Epic/Issue]

Standard development

CI Testing Labels

  • Select the appropriate CI test labels (CI -build=build-name -test=test-suite)

Documentation checklist

  • Add the documentation label
  • Add the bug / feature label
  • Add the milestone for which this feature is intended
    • If not known, set for a later milestone
  • Write a release note, including added/changed clauses
    • Added: Query modules now support timezone-aware datetime objects. This means your custom procedures and functions can now accept and return datetime values that include timezone information in either named IANA or numeric offset formats. #3121 #3200
    • docs: Add API reference for ZonedDateTime

@colinbarry colinbarry added the feature feature label Jul 18, 2025
@colinbarry colinbarry added this to the mg-v3.5.0 milestone Jul 18, 2025
@colinbarry colinbarry added CI -build=release -test=core Run release build and core tests on push CI -build=release -test=e2e Run release build and e2e tests on push CI -build=release -test=query_modules Run release build and query modules tests on push labels Jul 18, 2025
@colinbarry colinbarry force-pushed the feat/support-zoned-date-time-in-query-modules branch 2 times, most recently from 4e294eb to e82a209 Compare August 12, 2025 16:44
@colinbarry colinbarry added CI -build=coverage -test=core Run coverage build and core tests on push CI -build=community -test=core Run community build and core tests on push CI -build=jepsen -test=core Run jepsen build and core tests on push CI -build=debug -test=integration Run debug build and integration tests on push CI -build=release -test=stress Run release build and stress tests on push labels Aug 18, 2025
@colinbarry colinbarry force-pushed the feat/support-zoned-date-time-in-query-modules branch from 45eb563 to bafaaaf Compare August 18, 2025 13:16
@colinbarry colinbarry added the documentation documentation label Aug 18, 2025
@colinbarry
wip: Support zoned-date-time in API
2dd5813 
Work in progress for minimal support of zoned-date-times, with the goal
of being able to use them in query modules.
@colinbarry
wip: Pass ZonedDateTime through API
0417898
@colinbarry
fix: Remove memory leak when accessing datetime timezone
e19255c
@colinbarry
feat: Accept datetime with tz as argument in query module
254a69a
@colinbarry
fix: Allow negative offset for timezones
2591600
@colinbarry
test: Add test for ZonedDateTime AsLocalTime and AsDate
403ce6f
@colinbarry
feat: Remove partial implementation of ZonedDateTime from C API
a8b918f 
This will be put back in another PR, because implementing it is beyond
the scope (and time) of this one.
@colinbarry
chore: Tidy code and add todo tags around missing code
f1cf5fa
@colinbarry
test: Add e2e test for Python query modules taking ZonedDateTimes
35fa654
@colinbarry
test: Add more tests for accepting a ZonedDateTime
10d185e
@colinbarry
wip: Add basic ZonedDateTime throughout C-API and tests
a83b4e8
@colinbarry
feat: Suppport ZonedDateTime timezone as offset or named IANA timezone
5b83129
@colinbarry
test: Fix basic ZonedDateTime C API tests
420e0dd
@colinbarry
feat: Add copy, move, and mgp:Value constructors and tests
bc560ce
@colinbarry colinbarry added community community CI -build=community -test=core Run community build and core tests on push CI -build=coverage -test=core Run coverage build and core tests on push CI -build=jepsen -test=core Run jepsen build and core tests on push CI -build=debug -test=core Run debug build and core tests on push CI -build=release -test=core Run release build and core tests on push CI -build=release -test=stress Run release build and stress tests on push CI -build=release -test=query_modules Run release build and query modules tests on push labels Aug 20, 2025
@colinbarry colinbarry force-pushed the feat/support-zoned-date-time-in-query-modules branch from 99d4c4d to 1b420ab Compare August 20, 2025 08:33
@colinbarry colinbarry marked this pull request as ready for review August 20, 2025 08:42
@Josipmrden Josipmrden self-requested a review August 20, 2025 10:03
Josipmrden
Josipmrden reviewed Aug 20, 2025
View reviewed changes
@colinbarry colinbarry requested a review from as51340 August 20, 2025 10:16
as51340
as51340 approved these changes Aug 20, 2025
View reviewed changes
Copy link
Contributor

@as51340 as51340 left a comment

Choose a reason for hiding this comment

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

LGTM

@sonarqubecloud
Copy link

sonarqubecloud bot commented Aug 20, 2025

Quality Gate Passed Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@colinbarry colinbarry added this pull request to the merge queue Aug 20, 2025
Merged via the queue into master with commit cb186a6 Aug 20, 2025
30 of 31 checks passed
@colinbarry colinbarry deleted the feat/support-zoned-date-time-in-query-modules branch August 20, 2025 14:09
@gitbuda gitbuda added the Docs needed Docs needed label Aug 20, 2025
@gitbuda gitbuda mentioned this pull request Aug 20, 2025
Merged
81 tasks
@colinbarry colinbarry mentioned this pull request Aug 21, 2025
Merged
github-merge-queue bot pushed a commit that referenced this pull request Aug 21, 2025
@colinbarry
fix: Use shim for PyDateTime_DATE_GET_TZINFO to support Python 3.9 (#…
e16910b 
…3200)

`PyDateTime_DATE_GET_TZINFO` is only supported in Python 3.10 and above.
As we currently still support Python 3.9, this shim function does
exactly the same thing, without needing the macro.

Delivered as part of
[#3121](#3121)
@colinbarry colinbarry mentioned this pull request Aug 21, 2025
Merged
11 tasks
as51340 pushed a commit that referenced this pull request Oct 24, 2025
@colinbarry
Support zoned datetimes in query modules (#3121)
a78d60f 
Add support for `ZonedDateTime` types in query modules.

- `ZonedDateTime` with a timezone (either numeric offset or named time
identifier) can be passed to query modules.
- Any `datetime`s returned by a Python query module will be converted
into a `ZonedDateTime` if they have a valid `timezone` `tzinfo`,
otherwise, they will be treated as `LocalDateTime`s.
as51340 pushed a commit that referenced this pull request Oct 24, 2025
@colinbarry
fix: Use shim for PyDateTime_DATE_GET_TZINFO to support Python 3.9 (#…
5d6cffa 
…3200)

`PyDateTime_DATE_GET_TZINFO` is only supported in Python 3.10 and above.
As we currently still support Python 3.9, this shim function does
exactly the same thing, without needing the macro.

Delivered as part of
[#3121](#3121)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Josipmrden Josipmrden Josipmrden left review comments

@as51340 as51340 as51340 approved these changes

Assignees

@colinbarry colinbarry

Labels

CI -build=community -test=core Run community build and core tests on push CI -build=coverage -test=core Run coverage build and core tests on push CI -build=debug -test=core Run debug build and core tests on push CI -build=jepsen -test=core Run jepsen build and core tests on push CI -build=release -test=core Run release build and core tests on push CI -build=release -test=e2e Run release build and e2e tests on push CI -build=release -test=query_modules Run release build and query modules tests on push CI -build=release -test=stress Run release build and stress tests on push community community Docs needed Docs needed documentation documentation feature feature

Projects

None yet

Milestone

mg-v3.5.0

Development

Successfully merging this pull request may close these issues.

5 participants

@colinbarry @Josipmrden @as51340 @gitbuda