Skip to content
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

Add pendulum datetime handler to date normalisation #659

Merged
merged 3 commits into from
Jun 6, 2024
Merged

Add pendulum datetime handler to date normalisation #659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
212445d
Added pendulum dt objects to normalisation hander
keegansmith21 Jun 4, 2024
eff8dee
Silent bug fix
keegansmith21 Jun 5, 2024
2f26b7d
fix formatting
keegansmith21 Jun 5, 2024
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
3 changes: 3 additions & 0 deletions observatory_platform/date_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
from zoneinfo import ZoneInfo

from dateutil import parser
import pendulum


def datetime_normalise(dt: Union[str, datetime]) -> str:
Expand All @@ -28,6 +29,8 @@ def datetime_normalise(dt: Union[str, datetime]) -> str:
:param dt_string: The string to convert
:return: The ISO formatted datetime string
"""
if isinstance(dt, pendulum.DateTime):
dt = dt.to_iso8601_string()
if isinstance(dt, str):
dt = parser.parse(dt) # Parse string to datetime object
if not dt.utcoffset(): # If no timezone present, assume +0000UTC
Expand Down
33 changes: 31 additions & 2 deletions observatory_platform/tests/test_date_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
import unittest
from zoneinfo import ZoneInfo

import pendulum

from observatory_platform.date_utils import datetime_normalise


Expand Down Expand Up @@ -60,9 +62,36 @@ def test_dt_inputs(self):
actual_output = datetime_normalise(input)
self.assertEqual(expected_output, actual_output)

def test_pendulum_inputs(self):
inputs = [
pendulum.datetime(2024, 1, 1, 12, 0, 0, tz="UTC"),
pendulum.datetime(2024, 1, 1, 12, 0, 0, tz="Etc/GMT+1"),
pendulum.datetime(2024, 1, 1, 0, 0, 0, tz="Etc/GMT-1"),
pendulum.datetime(2023, 12, 31, 23, 0, 0, tz="Etc/GMT+1"),
]
expected_outputs = [
"2024-01-01T12:00:00+00:00",
"2024-01-01T13:00:00+00:00",
"2023-12-31T23:00:00+00:00",
"2024-01-01T00:00:00+00:00",
]
for input, expected_output in zip(inputs, expected_outputs):
actual_output = datetime_normalise(input)
self.assertEqual(expected_output, actual_output)

def test_missing_tz(self):
inputs = ["2024-01-01 00:00:00", "2024-01-01T12:00:00", datetime(2024, 1, 1, 12, 0, 0)]
expected_outputs = ["2024-01-01T00:00:00+00:00", "2024-01-01T12:00:00+00:00", "2024-01-01T12:00:00+00:00"]
inputs = [
"2024-01-01 00:00:00",
"2024-01-01T12:00:00",
datetime(2024, 1, 1, 12, 0, 0),
pendulum.datetime(2024, 1, 1, 12, 0, 0),
]
expected_outputs = [
"2024-01-01T00:00:00+00:00",
"2024-01-01T12:00:00+00:00",
"2024-01-01T12:00:00+00:00",
"2024-01-01T12:00:00+00:00",
]
for input, expected_output in zip(inputs, expected_outputs):
actual_output = datetime_normalise(input)
self.assertEqual(expected_output, actual_output)
Loading