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

gh-107732: Mention dir support in importlib.resources docs (#107734) 

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
This commit is contained in:
Shahriar Heidrich 2023-09-06 22:53:32 +02:00 committed by GitHub
parent f9bd6e49ae
commit 9f0c0a46f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Doc/library/importlib.resources.rst
View File

@ -82,15 +82,18 @@ for example, a package and its resources can be imported from a zip file using
.. function:: as_file(traversable)
Given a :class:`~importlib.resources.abc.Traversable` object representing
a file, typically from :func:`importlib.resources.files`, return
a context manager for use in a :keyword:`with` statement.
a file or directory, typically from :func:`importlib.resources.files`,
return a context manager for use in a :keyword:`with` statement.
The context manager provides a :class:`pathlib.Path` object.
Exiting the context manager cleans up any temporary file created when the
resource was extracted from e.g. a zip file.
Exiting the context manager cleans up any temporary file or directory
created when the resource was extracted from e.g. a zip file.
Use ``as_file`` when the Traversable methods
(``read_text``, etc) are insufficient and an actual file on
(``read_text``, etc) are insufficient and an actual file or directory on
the file system is required.
.. versionadded:: 3.9
.. versionchanged:: 3.12
Added support for ``traversable`` representing a directory.

6
Doc/whatsnew/3.12.rst
View File

@ -630,6 +630,12 @@ fractions
* Objects of type :class:`fractions.Fraction` now support float-style
formatting. (Contributed by Mark Dickinson in :gh:`100161`.)
importlib.resources
-------------------
* :func:`importlib.resources.as_file` now supports resource directories.
(Contributed by Jason R. Coombs in :gh:`97930`.)
inspect
-------