Skip to content

bpo-39791: Add files() to importlib.resources #19722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jaraco merged 4 commits into from
May 8, 2020
Merged

bpo-39791: Add files() to importlib.resources #19722

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
31712db
bpo-39791: Update importlib.resources to support files() API (importl…
jaraco Apr 26, 2020
edf023c
📜🤖 Added by blurb_it.
blurb-it[bot] Apr 27, 2020
49a116e
Add some documentation about the new objects added.
jaraco Apr 28, 2020
8a4c3cc
Merge branch 'master' into feature/39791-resources-files
jaraco May 8, 2020
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
Prev Previous commit
Next Next commit
Add some documentation about the new objects added.
  • Loading branch information
@jaraco
jaraco committed Apr 28, 2020
commit 49a116e83ece441397ba0498e4063769f6aaf32f
37 changes: 37 additions & 0 deletions Doc/library/importlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,8 @@ ABC hierarchy::

.. class:: ResourceReader

*Superseded by TraversableReader*

An :term:`abstract base class` to provide the ability to read
*resources*.

Expand Down Expand Up @@ -795,6 +797,28 @@ ABC hierarchy::
itself does not end in ``__init__``.


.. class:: Traversable

An object with a subset of pathlib.Path methods suitable for
traversing directories and opening files.

.. versionadded:: 3.9


.. class:: TraversableReader

An abstract base class for resource readers capable of serving
the ``files`` interface. Subclasses ResourceReader and provides
concrete implementations of the ResourceReader's abstract
methods. Therefore, any loader supplying TraversableReader
also supplies ResourceReader.

Loaders that wish to support resource reading are expected to
Comment thread
jaraco marked this conversation as resolved.
implement this interface.

.. versionadded:: 3.9


:mod:`importlib.resources` -- Resources
---------------------------------------

Expand Down Expand Up @@ -853,6 +877,19 @@ The following types are defined.

The following functions are available.


.. function:: files(package)

Returns an :class:`importlib.resources.abc.Traversable` object
representing the resource container for the package (think directory)
and its resources (think files). A Traversable may contain other
containers (think subdirectories).

*package* is either a name or a module object which conforms to the
``Package`` requirements.

.. versionadded:: 3.9

.. function:: open_binary(package, resource)

Open for binary reading the *resource* within *package*.
Expand Down