-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
gh-133125: Clarify ZipInfo.date_time attribute documentation #136082
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
base: main
Are you sure you want to change the base?
Conversation
…f timestamp and limitations
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@KentaroJay thanks for the PR! Would you be interested in adding information about the way CPython interprets the timezone of the datetime (i.e. the time is interpreted as the local timezone). This was brought up in #123059.
I can do that in a follow up if you'd prefer to keep this focused on just covering the source of the timestamp information.
@@ -818,7 +818,18 @@ Instances have the following methods and attributes: | |||
.. attribute:: ZipInfo.date_time | |||
|
|||
The time and date of the last modification to the archive member. This is a | |||
tuple of six values: | |||
tuple of six values representing the "last mod file time" and "last mod file date" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tuple of six values representing the "last mod file time" and "last mod file date" | |
tuple of six values representing the "last [modified] file time" and "last [modified] file date" |
I realize you are using the text from APPNOTE.txt here, but I think we should expand the word to be a bit clearer.
specifically returns the timestamp from the central directory. Future Python | ||
versions may use alternative timestamp sources if they provide better accuracy | ||
or precision. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
specifically returns the timestamp from the central directory. Future Python | |
versions may use alternative timestamp sources if they provide better accuracy | |
or precision. | |
specifically returns the timestamp from the central directory. |
I don't think we can change the source of date_time
in a backwards compatible way.
tuple of six values representing the "last mod file time" and "last mod file date" | ||
fields from the ZIP file's central directory. | ||
|
||
.. note:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would move this note further down as "a tuple of six values" is lost as context when you get to "The tuple" below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The note also seems very similar to the one below. I would merge the information in this note into the one below.
@emmatyping |
zipfile
: docs should document whatZipInfo.date_time
actually is #133125📚 Documentation preview 📚: https://cpython-previews--136082.org.readthedocs.build/