linkcheck: Use correct function to convert from UTC time to UNIX epoch#11649
Merged
AA-Turner merged 6 commits intosphinx-doc:masterfrom Aug 28, 2023
Merged
linkcheck: Use correct function to convert from UTC time to UNIX epoch#11649AA-Turner merged 6 commits intosphinx-doc:masterfrom
AA-Turner merged 6 commits intosphinx-doc:masterfrom
Conversation
After subtracting the offset, we get time in UTC. But time.mktime() expects a time struct in local time, not in UTC. The correct function for converting UTC time to UNIX epoch is calendar.timegm(). This fixes hanging tests when the local timezone is to the west of UTC. One could test this using: TZ=America/New_York python3 -m pytest -k test_too_many_requests_retry_after_HTTP_date
Member
|
Should we add a test for this? Please could you also add an entry to CHANGES, this will go into 7.2.3. A |
Contributor
Author
|
Done. |
AA-Turner
reviewed
Aug 27, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Subject: linkcheck: Use correct function to convert from UTC time to UNIX epoch
Feature or Bugfix
Purpose
After subtracting the offset, we get time in UTC. But
time.mktime()expects a time struct in local time, not in UTC. Quoting the Python documentation:So in our case, the correct function to use is
calendar.timegm().This fixes hanging tests when the local timezone is to the west of UTC. One could test this using:
After applying this change, the test passes with timezones from both western and eastern hemispheres.