From 20343d7f0f3b7076f3aa705565e5079e93f301b8 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 27 Mar 2021 20:25:53 -0400 Subject: [PATCH] bpo-43644: Add docs for importlib.resources.as_file. (GH-25048) (cherry picked from commit af50c84643ce21cfbdfdabbdfae6bd5e1368c542) Co-authored-by: Jason R. Coombs --- Doc/library/importlib.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst index cb2a5686a95a50..61a81e02ff88fc 100644 --- a/Doc/library/importlib.rst +++ b/Doc/library/importlib.rst @@ -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*.