Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 8 additions & 5 deletions Doc/library/importlib.resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 6 additions & 0 deletions Doc/whatsnew/3.12.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------

Expand Down