Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

gh-117074: Update Traversable.joinpath docs to the 3.11+ protocol (GH-117113)

This commit is contained in:
Petr Viktorin 2024-04-02 16:08:16 +02:00 committed by GitHub
parent 52f5b7f9e0
commit e569f9132b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Doc/library/importlib.resources.abc.rst
View File

@ -109,13 +109,35 @@
Return True if self is a file.
.. abstractmethod:: joinpath(child)
.. abstractmethod:: joinpath(*pathsegments)
Return Traversable child in self.
Traverse directories according to *pathsegments* and return
the result as :class:`!Traversable`.
Each *pathsegments* argument may contain multiple names separated by
forward slashes (``/``, ``posixpath.sep`` ).
For example, the following are equivalent::
files.joinpath('subdir', 'subsuddir', 'file.txt')
files.joinpath('subdir/subsuddir/file.txt')
Note that some :class:`!Traversable` implementations
might not be updated to the latest version of the protocol.
For compatibility with such implementations, provide a single argument
without path separators to each call to ``joinpath``. For example::
files.joinpath('subdir').joinpath('subsubdir').joinpath('file.txt')
.. versionchanged:: 3.11
``joinpath`` accepts multiple *pathsegments*, and these segments
may contain forward slashes as path separators.
Previously, only a single *child* argument was accepted.
.. abstractmethod:: __truediv__(child)
Return Traversable child in self.
Equivalent to ``joinpath(child)``.
.. abstractmethod:: open(mode='r', *args, **kwargs)