This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author petr.viktorin
Recipients docs@python, jaraco, petr.viktorin
Date 2022-03-28.12:48:15
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1648471695.21.0.705816081737.issue47142@roundup.psfhosted.org>
In-reply-to
Content
importlib.resources.files is documented [0] as returning importlib.resources.abc.Traversable, which is an undocumented class (dead link) now. It should be documented.
The [source] has helpful docstrings, but is missing some details. I'd like to know these before writing some docs:

- Can the argument to `joinpath` contain path separators?
- Are the methods expected to raise specific exception types (e.g. if a resource is missing, or you call iterdir on a “file”)? This seems quite important for people who implement the protocol.


[0]: https://docs.python.org/dev/library/importlib.resources.html#importlib.resources.files
[source]: https://github.com/python/cpython/blob/main/Lib/importlib/resources/abc.py#L49
History
Date User Action Args
2022-03-28 12:48:15petr.viktorinsetrecipients: + petr.viktorin, jaraco, docs@python
2022-03-28 12:48:15petr.viktorinsetmessageid: <1648471695.21.0.705816081737.issue47142@roundup.psfhosted.org>
2022-03-28 12:48:15petr.viktorinlinkissue47142 messages
2022-03-28 12:48:15petr.viktorincreate