Skip to content

bpo-39693: tarfile extractfile documentation #18639

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

Merged
merged 8 commits into from
Oct 20, 2020
Merged

bpo-39693: tarfile extractfile documentation #18639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d15d1cc
Merge pull request #1 from python/master
dorosch Feb 23, 2020
588f4c3
bpo-39693: tarfile extractfile documentation
Feb 24, 2020
986fdf8
Update after review
dorosch Jun 29, 2020
f967ad5
Merge branch 'master' into bpo-39693-tarfile-extractfile-documentation
dorosch Jun 29, 2020
22ed780
Update ACKS
dorosch Jun 29, 2020
ba28411
Update ACKS
dorosch Jun 29, 2020
7697668
Update tarfile.rst
dorosch Jun 29, 2020
80e7fb3
Update tarfile.py
dorosch Jun 29, 2020
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
9 changes: 5 additions & 4 deletions Doc/library/tarfile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,10 +444,11 @@ be finalized; only the internally used file object will be closed. See the

.. method:: TarFile.extractfile(member)

Extract a member from the archive as a file object. *member* may be a filename
or a :class:`TarInfo` object. If *member* is a regular file or a link, an
:class:`io.BufferedReader` object is returned. Otherwise, :const:`None` is
returned.
Extract a member from the archive as a file object. *member* may be
a filename or a :class:`TarInfo` object. If *member* is a regular file or
a link, an :class:`io.BufferedReader` object is returned. For all other
existing members, :const:`None` is returned. If *member* does not appear
in the archive, :exc:`KeyError` is raised.

.. versionchanged:: 3.3
Return an :class:`io.BufferedReader` object.
Expand Down
7 changes: 4 additions & 3 deletions Lib/tarfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2089,9 +2089,10 @@ def extract(self, member, path="", set_attrs=True, *, numeric_owner=False):

def extractfile(self, member):
"""Extract a member from the archive as a file object. `member' may be
a filename or a TarInfo object. If `member' is a regular file or a
link, an io.BufferedReader object is returned. Otherwise, None is
returned.
a filename or a TarInfo object. If `member' is a regular file or
a link, an io.BufferedReader object is returned. For all other
existing members, None is returned. If `member' does not appear
in the archive, KeyError is raised.
"""
self._check("r")

Expand Down
1 change: 1 addition & 0 deletions Misc/ACKS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1937,5 +1937,6 @@ Gennadiy Zlobin
Doug Zongker
Peter Åstrand
Vlad Emelianov
Andrey Doroschenko

(Entries should be added in rough alphabetical order by last names)
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2020-02-24-09-02-05.bpo-39693.QXw0Fm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix tarfile's extractfile documentation