gh-146396: Improve tarfile docs with extractfile() example and clarify TarInfo.size#146424
Open
dhanusharer wants to merge 1 commit intopython:mainfrom
Open
gh-146396: Improve tarfile docs with extractfile() example and clarify TarInfo.size#146424dhanusharer wants to merge 1 commit intopython:mainfrom
dhanusharer wants to merge 1 commit intopython:mainfrom
Conversation
…s and clarify TarInfo.size
|
All commit authors signed the Contributor License Agreement. |
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #146396
Summary
Improve the tarfile documentation by clarifying the meaning of
TarInfo.sizeand adding a practical example for reading file contents directly into memory.Changes
TarInfo.sizerefers to the size of the archived file’s data (excluding header information)TarFile.extractfile()to read file contents without extracting to diskMotivation
The current documentation does not clearly explain how to read file data from a tar archive in memory. This change improves usability and helps developers discover the intended high-level API without relying on internal details.