GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-105189: fix importlib.resources.abc deprecation docs by graingert · Pull Request #105232 · python/cpython

Conversation

@graingert

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

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor
  • Issue: importlib.resources.abc.TraversableResources says it is deprecated in favour of itself #105189

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@graingert
fix importlib.resources.abc deprecation docs
fad7636
@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
importlib.resources.abc.TraversableResources says it is deprecated in favour of itself #105189
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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@graingert
graingert marked this pull request as ready for review June 2, 2023 10:26
@graingert
graingert requested review from brettcannon, encukou, ericsnowcurrently, ncoghlan and warsaw as code owners June 2, 2023 10:26
@bedevere-bot bedevere-bot added the awaiting review label Jun 2, 2023
@graingert
fix importlib.resources.abc versionadded
8bcfe74
@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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
graingert
graingert commented Jun 2, 2023
View reviewed changes
Comment thread Doc/library/importlib.resources.abc.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
graingert
graingert commented Jun 2, 2023
View reviewed changes
Comment thread Doc/library/importlib.resources.abc.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
graingert
graingert commented Jun 2, 2023
View reviewed changes
Comment thread Doc/library/importlib.resources.abc.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
hugovk
hugovk reviewed Jun 5, 2023
View reviewed changes
Comment thread Doc/library/importlib.resources.abc.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/importlib.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/importlib.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/importlib.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/importlib.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/importlib.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/importlib.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/importlib.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@brettcannon
brettcannon requested review from jaraco and removed request for brettcannon June 9, 2023 22:47
hugovk and others added 2 commits July 27, 2023 19:14
@hugovk
Merge branch 'main' into fix-importlib-resources-abc-deprecations
fbf435d
@AlexWaygood
Update .nitignore
2611ce2
serhiy-storchaka
serhiy-storchaka reviewed Jul 28, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@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!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
graingert and others added 3 commits September 12, 2023 21:41
@graingert
Apply suggestions from code review
ecc61cc
@graingert @hugovk
Apply suggestions from code review
e507a32 
Co-authored-by: Hugo van Kemenade <[email protected]>
@graingert
Merge branch 'main' into fix-importlib-resources-abc-deprecations
b995e4a
@graingert
graingert requested a review from hugovk September 12, 2023 20:43
jaraco
jaraco approved these changes Sep 12, 2023
View reviewed changes
@bedevere-app bedevere-app Bot added awaiting core review and removed awaiting review labels Sep 12, 2023
hugovk
hugovk approved these changes Sep 13, 2023
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thank you!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@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.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting core review label Sep 13, 2023
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 <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
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 <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
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 <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
@hugovk

hugovk commented Sep 13, 2023

Copy link
Copy Markdown
Member

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
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

Uh oh!

There was an error while loading. Please reload this page.

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.

Uh oh!

There was an error while loading. Please reload this page.

7 participants

@graingert @hugovk @miss-islington @jaraco @serhiy-storchaka @bedevere-bot @AlexWaygood
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.