Skip to content
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

Jump to bottom

importlib.resources.abc.Traversable.joinpath docs incomplete #117074

Closed
encukou opened this issue Mar 20, 2024 · 1 comment
Closed

importlib.resources.abc.Traversable.joinpath docs incomplete #117074

encukou opened this issue Mar 20, 2024 · 1 comment
Assignees
@encukou
Labels
docs Documentation in the Doc dir

Comments

@encukou
Copy link
Member

encukou commented Mar 20, 2024 •
edited by bedevere-app bot

importlib.resources.abc.Traversable.joinpath should mention that it can take multiple descendants.

The versionchanged note should mention that some providers might still not support this.

@jaraco, this was officially added in 3.11, right?

Linked PRs
@encukou encukou added the docs Documentation in the Doc dir label Mar 20, 2024
@encukou encukou self-assigned this Mar 20, 2024
@encukou encukou mentioned this issue Mar 20, 2024
Closed
@jaraco
Copy link
Member

jaraco commented Mar 20, 2024

this was officially added in 3.11, right?

It looks like the protocol was updated in importlib_resources 5.7 and Python 3.11, but it wasn't until later (importlib_resources 5.11 and Python 3.12) that MultiplexedPath added that support (so namespace packages wouldn't have support until Python 3.12). But yes, generally speaking, what you've described is correct.

encukou added a commit to encukou/cpython that referenced this issue Mar 21, 2024
@encukou
pythongh-117074: Update Traversable.joinpath docs to the 3.11+ protocol
5f6ec22
@bedevere-app bedevere-app bot mentioned this issue Mar 21, 2024
Merged
encukou added a commit that referenced this issue Apr 2, 2024
@encukou
gh-117074: Update Traversable.joinpath docs to the 3.11+ protocol (GH…
e569f91 
…-117113)
@encukou encukou closed this as completed Apr 5, 2024
@encukou encukou reopened this Apr 5, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 5, 2024
@encukou @miss-islington
pythongh-117074: Update Traversable.joinpath docs to the 3.11+ protoc…
2d2e1eb 
…ol (pythonGH-117113)

(cherry picked from commit e569f91)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Apr 5, 2024
Merged
encukou added a commit that referenced this issue Apr 5, 2024
@miss-islington @encukou
[3.12] gh-117074: Update Traversable.joinpath docs to the 3.11+ proto…
558b517 
…col (GH-117113) (GH-117571)

gh-117074: Update Traversable.joinpath docs to the 3.11+ protocol (GH-117113)
(cherry picked from commit e569f91)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
@encukou encukou closed this as completed Apr 5, 2024
diegorusso pushed a commit to diegorusso/cpython that referenced this issue Apr 17, 2024
@encukou @diegorusso
pythongh-117074: Update Traversable.joinpath docs to the 3.11+ protoc…
65d474e 
…ol (pythonGH-117113)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@encukou encukou

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@encukou @jaraco