mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-23 09:19:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

bpo-43644: Add docs for importlib.resources.as_file. (GH-25048)

Browse source 
(cherry picked from commit af50c84643)

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
This commit is contained in:
Miss Islington (bot) 2021-03-27 17:48:53 -07:00 • committed by GitHub
parent 064bc07f24
commit 138e039ff9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Doc/library/importlib.rst
View file

@ -888,6 +888,22 @@ The following functions are available.
.. versionadded:: 3.9
.. 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.
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.
Use ``as_file`` when the Traversable methods
(``read_text``, etc) are insufficient and an actual file on
the file system is required.
.. versionadded:: 3.9
.. function:: open_binary(package, resource)
Open for binary reading the *resource* within *package*.