Skip to content

gh-107732: Mention dir support in importlib.resources docs #107734

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
Merged
hugovk merged 5 commits into from
Sep 6, 2023
Merged

gh-107732: Mention dir support in importlib.resources docs #107734

hugovk merged 5 commits into from
Sep 6, 2023

Conversation

@smheidrich
Copy link
Contributor

@smheidrich smheidrich commented Aug 7, 2023 •
edited by github-actions bot
Loading

Suggestion for how to point out importlib.resources.as_file()'s support for whole directories as resources in its docs.

📚 Documentation preview 📚: https://cpython-previews--107734.org.readthedocs.build/

@bedevere-bot bedevere-bot mentioned this pull request Aug 7, 2023
Closed
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Aug 7, 2023
@smheidrich smheidrich force-pushed the fix-gh-107732 branch 2 times, most recently from 5b8a601 to 1ffa82b Compare August 7, 2023 18:15
@smheidrich
Copy link
Contributor Author

smheidrich commented Aug 7, 2023

Ping @jaraco (as requested here)

AA-Turner
AA-Turner approved these changes Aug 8, 2023
View reviewed changes
@AA-Turner AA-Turner added the needs backport to 3.12 only security fixes label Aug 8, 2023
@smheidrich @AA-Turner
Update Doc/library/importlib.resources.rst
edd9a87 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@smheidrich
Copy link
Contributor Author

smheidrich commented Aug 8, 2023

By the way, wouldn't it be appropriate to also mention this new capability of as_file() in the Improved Modules section of 3.12's What's New page? Right now it only has an entry in the full changelog, but there are some entries in Improved Modules that seem less important to mention than this to me (e.g. performance improvements). How are decisions on what does and doesn't go in there made? 🤔

@AA-Turner
Copy link
Member

AA-Turner commented Aug 8, 2023

Yep, we should add an entry to What's New. Are you happy to add it to this PR?

A

@smheidrich
Copy link
Contributor Author

smheidrich commented Aug 8, 2023

Sure 👍 I added it.

AA-Turner
AA-Turner reviewed Aug 9, 2023
View reviewed changes
@smheidrich @AA-Turner
Update Doc/whatsnew/3.12.rst
befdc2e 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@brettcannon brettcannon removed their request for review August 9, 2023 18:49
@hugovk hugovk enabled auto-merge (squash) September 6, 2023 20:44
@hugovk hugovk merged commit 9f0c0a4 into python:main Sep 6, 2023
@miss-islington
Copy link
Contributor

miss-islington commented Sep 6, 2023

Thanks @smheidrich for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

miss-islington commented Sep 6, 2023

Sorry, @smheidrich and @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 9f0c0a46f00d687e921990ee83894b2f4ce8a6e7 3.12

hugovk added a commit to hugovk/cpython that referenced this pull request Sep 7, 2023
@smheidrich @AA-Turner @hugovk
pythongh-107732: Mention dir support in importlib.resources docs (pyt…
514c951 
…hon#107734)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
(cherry picked from commit 9f0c0a4)
hugovk added a commit to hugovk/cpython that referenced this pull request Sep 7, 2023
@smheidrich @AA-Turner @hugovk
pythongh-107732: Mention dir support in importlib.resources docs (pyt…
be47b7a 
…hon#107734)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
(cherry picked from commit 9f0c0a4)
@bedevere-bot
Copy link

bedevere-bot commented Sep 7, 2023

GH-109058 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Sep 7, 2023
Yhg1s pushed a commit that referenced this pull request Sep 8, 2023
@hugovk @smheidrich
[3.12] gh-107732: Mention dir support in importlib.resources docs (GH…
5ca2a68 
…-107734) (#109058)

gh-107732: Mention dir support in importlib.resources docs (#107734)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
(cherry picked from commit 9f0c0a4)

Co-authored-by: Shahriar Heidrich <smheidrich@weltenfunktion.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jaraco jaraco jaraco approved these changes

@hugovk hugovk hugovk approved these changes

@AA-Turner AA-Turner AA-Turner approved these changes

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently

@ncoghlan ncoghlan Awaiting requested review from ncoghlan

@warsaw warsaw Awaiting requested review from warsaw warsaw is a code owner

Assignees

@hugovk hugovk

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@smheidrich @AA-Turner @miss-islington @bedevere-bot @jaraco @hugovk