From 5fe4a0e8643d8fec9326a40cc4e156554beaf6b9 Mon Sep 17 00:00:00 2001 From: Stephen Seo Date: Tue, 12 Sep 2023 11:21:04 +0900 Subject: [PATCH] Add documentation and type hints to datetime fns --- update.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/update.py b/update.py index 70532dd..534a364 100755 --- a/update.py +++ b/update.py @@ -202,7 +202,9 @@ class ArchPkgVersion: return self_str -def timedelta_to_offset_string(timed: datetime.timedelta): +def timedelta_to_offset_string(timed: datetime.timedelta) -> str: + """Returns a timedelta string in the format "+HH:MM" or "-HH:MM".""" + seconds = timed.days * 24 * 60 * 60 + timed.seconds minutes_offset = int(seconds / 60) hours_offset = int(minutes_offset / 60) @@ -210,7 +212,11 @@ def timedelta_to_offset_string(timed: datetime.timedelta): return f"{hours_offset:+03d}:{minutes_offset:02d}" -def get_datetime_timezone_now(other_state): +def get_datetime_timezone_now(other_state) -> str: + """Returns a datetime string compatible with RFC 3339 and ISO 8601. + If other_state["datetime_in_local_time"] is True, then the returned string + is in localtime.""" + if other_state["datetime_in_local_time"]: lt = datetime.datetime.now(datetime.timezone.utc).astimezone() return lt.strftime(STRFTIME_LOCAL_FORMAT) + timedelta_to_offset_string(