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.

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

chore(tests): fix tz warning #11497

Merged
merged 4 commits into from
Nov 26, 2024
Merged

chore(tests): fix tz warning #11497

merged 4 commits into from
Nov 26, 2024

Conversation

Kyle-Verhoog
Copy link
Member

@Kyle-Verhoog Kyle-Verhoog commented Nov 21, 2024

Running the tests locally, I get:

DeprecationWarning: datetime.datetime.utcnow() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC

The recommended upgrade is to use datetime.now(timezone.utc) which is what is done here.

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

@Kyle-Verhoog Kyle-Verhoog requested a review from a team as a code owner November 21, 2024 23:22
@Kyle-Verhoog Kyle-Verhoog added the changelog/no-changelog A changelog entry is not required for this PR. label Nov 21, 2024
Copy link
Contributor

CODEOWNERS have been resolved as:

tests/utils.py                                                          @DataDog/python-guild

Running the tests locally, I get:

```
DeprecationWarning: datetime.datetime.utcnow() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC
```

The recommended upgrade is to use `datetime.now(timezone.utc)` which is
what is done here.
@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented Nov 21, 2024

Datadog Report

Branch report: kylev/fix-tz-warning
Commit report: 7f1bf37
Test service: dd-trace-py

✅ 0 Failed, 918 Passed, 550 Skipped, 14m 3.94s Total duration (22m 0.6s time saved)

@pr-commenter
Copy link

pr-commenter bot commented Nov 22, 2024

Benchmarks

Benchmark execution time: 2024-11-26 21:40:41

Comparing candidate commit 7f1bf37 in PR branch kylev/fix-tz-warning with baseline commit 3fabd0a in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 388 metrics, 2 unstable metrics.

@Kyle-Verhoog Kyle-Verhoog enabled auto-merge (squash) November 26, 2024 21:05
@Kyle-Verhoog Kyle-Verhoog merged commit 9c9fe4d into main Nov 26, 2024
548 of 549 checks passed
@Kyle-Verhoog Kyle-Verhoog deleted the kylev/fix-tz-warning branch November 26, 2024 21:41
wantsui added a commit that referenced this pull request Jan 9, 2025
…1850)

See #11608 and
#11497.

Starting with [Python
3.12](https://docs.python.org/3/whatsnew/3.12.html), there were changes
to datetime:
>
[datetime](https://docs.python.org/3/library/datetime.html#module-datetime):
[datetime.datetime](https://docs.python.org/3/library/datetime.html#datetime.datetime)’s
[utcnow()](https://docs.python.org/3/library/datetime.html#datetime.datetime.utcnow)
and
[utcfromtimestamp()](https://docs.python.org/3/library/datetime.html#datetime.datetime.utcfromtimestamp)
are deprecated and will be removed in a future version. Instead, use
timezone-aware objects to represent datetimes in UTC: respectively, call
[now()](https://docs.python.org/3/library/datetime.html#datetime.datetime.now)
and
[fromtimestamp()](https://docs.python.org/3/library/datetime.html#datetime.datetime.fromtimestamp)
with the tz parameter set to
[datetime.UTC](https://docs.python.org/3/library/datetime.html#datetime.UTC).
(Contributed by Paul Ganssle in
[gh-103857](python/cpython#103857).)

The result is that the usage of **utcnow** and **utcfromtimestamp** now
throw deprecation warnings when used, ie:
> DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated
and scheduled for removal in a future version. Use timezone-aware
objects to represent datetimes in UTC:
datetime.datetime.fromtimestamp(timestamp, datetime.UTC).


There's a difference of `+00:00` between the old version and the new
format.

**For utcnow -> now**
- `datetime.datetime.utcnow().isoformat()` |
`'2025-01-02T19:51:32.579733'`
- `datetime.datetime.now(datetime.timezone.utc).isoformat()` |
`'2025-01-02T19:51:02.275232+00:00'`

**For utcfromtimestamp -> fromtimestamp**

Assume that `end_time_ns=1735848645000000000`:
- `(datetime.datetime.fromtimestamp(end_time_ns / 1e9,
tz=datetime.timezone.utc).replace(microsecond=0).isoformat() + "Z")`
    - returns `'2025-01-02T20:10:45+00:00Z'`
- `(datetime.datetime.utcfromtimestamp(end_time_ns /
1e9).replace(microsecond=0).isoformat() + "Z")`
    - returns `'2025-01-02T20:10:45Z'`

As a result, I attempted remove the trailing ones to be consistent with
the old format, but can bring it back.

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants