Visitar URL original
gh-102950: Implement PEP 706 – Filter for tarfile.extractall by encukou · Pull Request #102953 · python/cpython · GitHub
Skip to content

gh-102950: Implement PEP 706 – Filter for tarfile.extractall #102953

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
encukou merged 16 commits into from
Apr 24, 2023
Merged

gh-102950: Implement PEP 706 – Filter for tarfile.extractall #102953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
cde089c
Implement PEP 706 – Filter for tarfile.extractall
encukou Jan 31, 2023
2395c92
Add a blurb
encukou Mar 23, 2023
561a9d4
Remove unneeded backslashes in docs
encukou Mar 27, 2023
54b5644
Fix typos in docs & comments
encukou Mar 27, 2023
7867fc3
Clarify the arguments to register_unpack_format's +function* argument
encukou Mar 27, 2023
734190d
tests: Clean up unused variables and unnecessary f-strings
encukou Mar 27, 2023
d55ae42
Make filter keyword-only in shutil
encukou Apr 6, 2023
c795bb3
Address documentation review
encukou Apr 6, 2023
5d850cc
Fix ReST syntax
encukou Apr 6, 2023
81e9050
Merge main branch to resolve conflict in Whatsnew
encukou Apr 11, 2023
de11090
Remove typo
encukou Apr 11, 2023
b0c0674
Improve errorlevel handling
encukou Apr 18, 2023
3796fdf
Fix the tests to match the PEP update
encukou Apr 19, 2023
08ab551
Document type of errorlevel
encukou Apr 19, 2023
0474842
Skip symlink-related test failures on WASI
encukou Apr 20, 2023
a255634
Ignore unrelated errors in NoneInfoTests_Misc.test_add
encukou Apr 20, 2023
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
26 changes: 20 additions & 6 deletions Doc/library/shutil.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -662,7 +662,7 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
Remove the archive format *name* from the list of supported formats.


.. function:: unpack_archive(filename[, extract_dir[, format]])
.. function:: unpack_archive(filename[, extract_dir[, format[, filter]]])
Comment thread
gpshead marked this conversation as resolved.

Unpack an archive. *filename* is the full path of the archive.

Expand All @@ -676,6 +676,14 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
registered for that extension. In case none is found,
a :exc:`ValueError` is raised.

The keyword-only *filter* argument is passed to the underlying unpacking
function. For zip files, *filter* is not accepted.
For tar files, it is recommended to set it to ``'data'``,
unless using features specific to tar and UNIX-like filesystems.
(See :ref:`tarfile-extraction-filter` for details.)
The ``'data'`` filter will become the default for tar files
in Python 3.14.

.. audit-event:: shutil.unpack_archive filename,extract_dir,format shutil.unpack_archive

.. warning::
Expand All @@ -688,18 +696,24 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
.. versionchanged:: 3.7
Accepts a :term:`path-like object` for *filename* and *extract_dir*.

.. versionchanged:: 3.12
Added the *filter* argument.

.. function:: register_unpack_format(name, extensions, function[, extra_args[, description]])

Registers an unpack format. *name* is the name of the format and
*extensions* is a list of extensions corresponding to the format, like
``.zip`` for Zip files.

*function* is the callable that will be used to unpack archives. The
callable will receive the path of the archive, followed by the directory
the archive must be extracted to.

When provided, *extra_args* is a sequence of ``(name, value)`` tuples that
will be passed as keywords arguments to the callable.
callable will receive:

- the path of the archive, as a positional argument;
- the directory the archive must be extracted to, as a positional argument;
- possibly a *filter* keyword argument, if it was given to
:func:`unpack_archive`;
- additional keyword arguments, specified by *extra_args* as a sequence
of ``(name, value)`` tuples.

*description* can be provided to describe the format, and will be returned
by the :func:`get_unpack_formats` function.
Expand Down
Loading