mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

tarfile: Fix positional-only syntax in docs (GH-105770) 

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.
This commit is contained in:
Jelle Zijlstra 2023-06-14 00:26:48 -07:00 committed by GitHub
parent 6199fe3b32
commit 5cdd5ba49d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doc/library/tarfile.rst
View File

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