mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 02:39:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

[3.12] tarfile: Fix positional-only syntax in docs (GH-105770) (#105773)

Browse source 
The syntax used in the current docs (a / before any args) is invalid.

I think the right approach is for the arguments to arbitrary
filter functions to be treated as positional-only, meaning that users
can supply filter functions with any names for the argument. tarfile.py
only calls the filter function with positional arguments.
(cherry picked from commit 5cdd5ba49d)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
This commit is contained in:
Miss Islington (bot) 2023-06-15 22:43:19 -07:00 • committed by GitHub
parent 0cb670f7e2
commit f94cb788f9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Doc/library/tarfile.rst
View file

@ -903,7 +903,7 @@ can be:
path to where the archive is extracted (i.e. the same path is used for all
members)::
filter(/, member: TarInfo, path: str) -> TarInfo | None
filter(member: TarInfo, path: str, /) -> TarInfo | None
The callable is called just before each member is extracted, so it can
take the current state of the disk into account.
@ -923,13 +923,13 @@ Default named filters
The pre-defined, named filters are available as functions, so they can be
reused in custom filters:
.. function:: fully_trusted_filter(/, member, path)
.. function:: fully_trusted_filter(member, path)
Return *member* unchanged.
This implements the ``'fully_trusted'`` filter.
.. function:: tar_filter(/, member, path)
.. function:: tar_filter(member, path)
Implements the ``'tar'`` filter.
@ -946,7 +946,7 @@ reused in custom filters:
Return the modified ``TarInfo`` member.
.. function:: data_filter(/, member, path)
.. function:: data_filter(member, path)
Implements the ``'data'`` filter.
In addition to what ``tar_filter`` does: