gh-133998: Fix gzip file creation when time is out of range #134278
Conversation
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
huwcbjones
reviewed
May 20, 2025
huwcbjones
reviewed
May 21, 2025
| creation time. If *mtime* is omitted or ``None``, the current time is used; | ||
| however, if the current time is outside the range 00:00:00 UTC, January 1, | ||
| 1970 through 06:28:15 UTC, February 7, 2106, then the value ``0`` is used | ||
| instead. | ||
|
|
There was a problem hiding this comment.
The docs are slightly wrong now that GzipFile.__init__ will raise a ValueError if the specified value is out of range.
I know you've documented it in the docstring for __init__, but I think it's worth clarifying here since we're already in the area.
Comment on lines
+191
to
+195
| Set mtime to 0 to generate a compressed stream that does not depend on | ||
| creation time. If mtime is omitted or None, the current time is used; | ||
| however, if the current time is outside the range 00:00:00 UTC, January | ||
| 1, 1970 through 06:28:15 UTC, February 7, 2106, then the value 0 is used | ||
| instead. |
| @@ -0,0 +1 @@ | |||
| Fix ``struct.error`` exception when creating a file with ``gzip.GzipFile()`` if the system time is outside the range 00:00:00 UTC, January 1, 1970 through 06:28:15 UTC, February 7, 2106. | |||
There was a problem hiding this comment.
I think this should also be tweaked since the behaviour of providing an out-of-range mtime has changed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If the system clock is set so that
time.time()falls outside of the range0through2**32-1, then creation of a GZIP-compressed file usinggzip.GzipFile()would fail with the exceptionstruct.error: 'L' format requires 0 <= number <= 4294967295. Fix this error.If the
mtimeargument togzip.GzipFile()is explicitly set to an out-of-range value, then the behavior is unchanged, and we continue raising the exception.2106-02-07T06:28:15#133998📚 Documentation preview 📚: https://cpython-previews--134278.org.readthedocs.build/