Skip to content

gh-146396: Improve tarfile docs with extractfile() example and clarify TarInfo.size #146424

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.

Sign up for GitHub

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

Open
dhanusharer wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −1
Open

gh-146396: Improve tarfile docs with extractfile() example and clarify TarInfo.size #146424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion Doc/library/tarfile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -810,7 +810,7 @@ A ``TarInfo`` object has the following public data attributes:
.. attribute:: TarInfo.size
:type: int

Size in bytes.
Size of the archived file's data in bytes.


.. attribute:: TarInfo.mtime
Expand Down Expand Up @@ -1387,6 +1387,17 @@ a generator function instead of a list::
tar.extractall(members=py_files(tar))
tar.close()

How to read the content of a specific archive member into memory::

import tarfile

with tarfile.open("sample.tar.gz") as tar:
for member in tar:
f = tar.extractfile(member)
if f is not None:
content = f.read()
break

How to read a gzip compressed tar archive and display some member information::

import tarfile
Expand Down
Loading