Skip to content

gh-105189: fix importlib.resources.abc deprecation docs - #105232

Merged
hugovk merged 7 commits into
python:mainfrom
graingert:fix-importlib-resources-abc-deprecations
Sep 13, 2023
Merged

gh-105189: fix importlib.resources.abc deprecation docs#105232
hugovk merged 7 commits into
python:mainfrom
graingert:fix-importlib-resources-abc-deprecations

Conversation

@graingert

@graingert graingert commented Jun 2, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Jun 2, 2023
@bedevere-bot bedevere-bot mentioned this pull request Jun 1, 2023
Closed
@graingert

graingert commented Jun 2, 2023

Copy link
Copy Markdown
Contributor Author

what to do about importlib.resources.abc.ResourceReader it seems it's supposed to be deprecated, but there's no deprecation warning in the source code

@graingert

graingert commented Jun 2, 2023

Copy link
Copy Markdown
Contributor Author

preview is here: https://cpython-previews--105232.org.readthedocs.build/en/105232/library/importlib.html#importlib.abc.ResourceReader

@graingert
graingert marked this pull request as ready for review June 2, 2023 10:26
@graingert

graingert commented Jun 2, 2023

Copy link
Copy Markdown
Contributor Author

the versionadded entries are incorrect on the 3.11 doc pages https://docs.python.org/3.11/library/importlib.resources.abc.html#importlib.resources.abc.TraversableResources

graingert
graingert commented Jun 2, 2023
View reviewed changes
Comment thread Doc/library/importlib.resources.abc.rst Outdated
graingert
graingert commented Jun 2, 2023
View reviewed changes
Comment thread Doc/library/importlib.resources.abc.rst Outdated
graingert
graingert commented Jun 2, 2023
View reviewed changes
Comment thread Doc/library/importlib.resources.abc.rst Outdated
hugovk
hugovk reviewed Jun 5, 2023
View reviewed changes
Comment thread Doc/library/importlib.resources.abc.rst Outdated
Comment thread Doc/library/importlib.rst Outdated
Comment thread Doc/library/importlib.rst Outdated
Comment thread Doc/library/importlib.rst Outdated
Comment thread Doc/library/importlib.rst Outdated
Comment thread Doc/library/importlib.rst Outdated
Comment thread Doc/library/importlib.rst Outdated
Comment thread Doc/library/importlib.rst Outdated
@brettcannon
brettcannon requested review from jaraco and removed request for brettcannon June 9, 2023 22:47
serhiy-storchaka
serhiy-storchaka reviewed Jul 28, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Concur with @graingert that separate versionadded directive for classes are not needed if they duplicate the module level versionadded.

I think that rather than duplicating documentation in importlib.rst (it can became de-synchronized), it would be enough to add minimal class declarations followed by references to new classes.

@hugovk

hugovk commented Sep 12, 2023

Copy link
Copy Markdown
Member

@graingert Would be great to get this ready for 3.12.0 final in a couple of weeks. Thanks!

@graingert
graingert requested a review from hugovk September 12, 2023 20:43
hugovk
hugovk approved these changes Sep 13, 2023
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@hugovk hugovk added the needs backport to 3.12 only security fixes label Sep 13, 2023
@hugovk
hugovk merged commit 6c0ddca into python:main Sep 13, 2023
@miss-islington

miss-islington commented Sep 13, 2023

Copy link
Copy Markdown
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 13, 2023
@graingert @hugovk
@AlexWaygood @miss-islington
pythongh-105189: fix importlib.resources.abc deprecation docs (python…
aa2cb55 
…GH-105232)

(cherry picked from commit 6c0ddca)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app

bedevere-app Bot commented Sep 13, 2023

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Sep 13, 2023
@hugovk

hugovk commented Sep 13, 2023

Copy link
Copy Markdown
Member

the versionadded entries are incorrect on the 3.11 doc pages https://docs.python.org/3.11/library/importlib.resources.abc.html#importlib.resources.abc.TraversableResources

Do we need a separate PR to fix this bit in 3.11?

@graingert
graingert deleted the fix-importlib-resources-abc-deprecations branch September 13, 2023 09:14
@graingert

graingert commented Sep 13, 2023

Copy link
Copy Markdown
Contributor Author

@hugovk yeah I think so

Yhg1s pushed a commit that referenced this pull request Sep 13, 2023
@miss-islington @graingert
@hugovk @AlexWaygood
[3.12] gh-105189: fix importlib.resources.abc deprecation docs (GH-10…
47402e2 
…5232) (#109363)

gh-105189: fix importlib.resources.abc deprecation docs (GH-105232)
(cherry picked from commit 6c0ddca)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
vstinner pushed a commit to vstinner/cpython that referenced this pull request Sep 13, 2023
@graingert @hugovk
@AlexWaygood @vstinner
pythongh-105189: fix importlib.resources.abc deprecation docs (python…
f693ed9 
…#105232)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk

hugovk commented Sep 13, 2023

Copy link
Copy Markdown
Member

@graingert Would you like to do the honours? :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka left review comments
@jaraco jaraco jaraco approved these changes
@hugovk hugovk hugovk approved these changes
@encukou encukou Awaiting requested review from encukou
@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner
@ncoghlan ncoghlan Awaiting requested review from ncoghlan ncoghlan is a code owner
@warsaw warsaw Awaiting requested review from warsaw warsaw is a code owner

Assignees

No one assigned

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.

7 participants

@graingert @hugovk @miss-islington @jaraco @serhiy-storchaka @bedevere-bot @AlexWaygood