Replace pendulum with whenever by dgarros · Pull Request #256 · opsmill/infrahub-sdk-python

dgarros · 2025-01-30T18:06:31Z

fixes #255

This PR replaces pendulum with whenever to manage datetime, mainly as part of the Timestamp class.

This change allows us to re-enable the support for Python 3.13, since we haven't shipped a release without 3.13 support, I've updated the changelog for #251

In the process the Timestamp object has been slightly refactored

Direct access to obj has been deprecated, instead it's recommended to use to_datetime()
add_delta() has been deprecated, in favor of add() and substract() that are more inline with whenever

codecov · 2025-01-30T18:08:50Z

Codecov Report

Attention: Patch coverage is 91.11111% with 8 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
infrahub_sdk/timestamp.py	90.16%	6 Missing ⚠️
infrahub_sdk/utils.py	90.90%	2 Missing ⚠️

@@                 Coverage Diff                 @@
##             infrahub-develop     #256   +/-   ##
===================================================
  Coverage                    ?   70.53%           
===================================================
  Files                       ?       81           
  Lines                       ?     7561           
  Branches                    ?     1469           
===================================================
  Hits                        ?     5333           
  Misses                      ?     1849           
  Partials                    ?      379

Flag	Coverage Δ
integration-tests	`22.27% <0.00%> (?)`
python-3.10	`45.62% <68.88%> (?)`
python-3.11	`45.60% <66.66%> (?)`
python-3.12	`45.62% <68.88%> (?)`
python-3.13	`45.60% <66.66%> (?)`
python-3.9	`44.46% <68.88%> (?)`
python-filler-3.12	`24.07% <22.22%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
infrahub_sdk/ctl/branch.py	`77.14% <100.00%> (ø)`
infrahub_sdk/ctl/utils.py	`66.66% <ø> (ø)`
infrahub_sdk/exceptions.py	`81.11% <100.00%> (ø)`
infrahub_sdk/utils.py	`79.91% <90.90%> (ø)`
infrahub_sdk/timestamp.py	`81.05% <90.16%> (ø)`

ogenstad

We should also have a news fragment stating that the installation on Python 3.13 was fixed.

ogenstad · 2025-02-26T08:52:00Z

changelog/255.fixed.md

@@ -0,0 +1 @@
+Refactor Timestamp to use `whenever` instead of `pendulum` and extend Timestamp with add(), subtract(), and to_datetime(). Direct access to `obj` and `add_delta` have been deprecated and will be removed in a future version.


I think we could split this up into two fragments where we also use the special one for things marked for deprecation.

Good point, I forgot about the deprecated section

ogenstad · 2025-02-26T08:52:10Z

infrahub_sdk/timestamp.py

+            UserWarning,
+            stacklevel=2,
+        )
+        return self._obj


I'd suggest creating a follow up issue for when this should be removed and tie it into a future milestone so we know when to remove it.

ogenstad · 2025-02-26T08:56:51Z

infrahub_sdk/timestamp.py

+            return ZonedDateTime.now("UTC").subtract(**params)  # type: ignore[call-overload]

-        return DateTime.now(tz="UTC").subtract(**params)
+        raise TimestampFormatError(f"Invalid time format for {value}")


I know it was like this before but I think the error definition should live in exceptions.py like the other core SDK exceptions.

good point, I moved it

ajtmccarty · 2025-02-26T17:36:33Z

infrahub_sdk/utils.py

+    except TimestampFormatError:
+        return None
+
+    delta: TimeDelta = Timestamp()._obj.difference(time_value._obj)


shouldn't these use to_datetime()?

Not datetime, the goal is to access the ZonedDateTime here
I added a new get_obj() instead of accessing it directly

dgarros force-pushed the dga-20250130-whenever branch from 41aa45d to cceabf0 Compare February 23, 2025 10:18

dgarros changed the base branch from develop to infrahub-develop February 23, 2025 10:18

dgarros force-pushed the dga-20250130-whenever branch from cceabf0 to ce24e52 Compare February 23, 2025 10:19

github-actions bot added the group/ci Issue related to the CI pipeline label Feb 23, 2025

dgarros mentioned this pull request Feb 23, 2025

Replace pendulum with whenever opsmill/infrahub#5820

Merged

dgarros force-pushed the dga-20250130-whenever branch from ce24e52 to 702a5f1 Compare February 24, 2025 09:09

github-actions bot removed the group/ci Issue related to the CI pipeline label Feb 24, 2025

dgarros force-pushed the dga-20250130-whenever branch 2 times, most recently from 8234ed7 to 97986b8 Compare February 26, 2025 06:54

github-actions bot added the group/ci Issue related to the CI pipeline label Feb 26, 2025

dgarros requested a review from a team February 26, 2025 07:00

dgarros marked this pull request as ready for review February 26, 2025 07:03

ogenstad approved these changes Feb 26, 2025

View reviewed changes

ajtmccarty approved these changes Feb 26, 2025

View reviewed changes

dgarros force-pushed the dga-20250130-whenever branch from 97986b8 to d778262 Compare February 26, 2025 20:10

Replace pendulum with whenever

a2a496f

dgarros force-pushed the dga-20250130-whenever branch from d778262 to a2a496f Compare February 26, 2025 20:16

dgarros merged commit 55be7bb into infrahub-develop Feb 26, 2025
14 checks passed

dgarros deleted the dga-20250130-whenever branch February 26, 2025 20:24

fatih-acar mentioned this pull request Feb 27, 2025

fix: build for python 3.13 #287

Merged

dgarros mentioned this pull request Mar 6, 2025

Add support for Offset DateTime to Timestamp #295

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace pendulum with whenever#256

Replace pendulum with whenever#256
dgarros merged 1 commit intoinfrahub-developfrom
dga-20250130-whenever

dgarros commented Jan 30, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jan 30, 2025 •

edited

Loading

Uh oh!

ogenstad left a comment

Uh oh!

ogenstad Feb 26, 2025

Uh oh!

dgarros Feb 26, 2025

Uh oh!

ogenstad Feb 26, 2025

Uh oh!

dgarros Feb 26, 2025

Uh oh!

ogenstad Feb 26, 2025

Uh oh!

dgarros Feb 26, 2025

Uh oh!

ajtmccarty Feb 26, 2025

Uh oh!

dgarros Feb 26, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -0,0 +1 @@
		Refactor Timestamp to use `whenever` instead of `pendulum` and extend Timestamp with add(), subtract(), and to_datetime(). Direct access to `obj` and `add_delta` have been deprecated and will be removed in a future version. No newline at end of file

Conversation

dgarros commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ogenstad left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dgarros commented Jan 30, 2025 •

edited

Loading

codecov bot commented Jan 30, 2025 •

edited

Loading