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.
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
gh-92611: Link to section for PEP 594 modules; mention rm version & alternatives #92612
Conversation
7614253
to
6893011
Compare
Edit: let's discuss in #92564, see #92564 (comment). |
(Already replied to you over there) |
@brettcannon Per your helpful advice on the Discourse thread, I've added individual deprecation notices to the I can bring the broader issue up with the Docs However, one question remains—should the additional explanations mentioned above and added in c937d01 also be backported (if so, I would modify them to remove the removal version for this PR), or left 3.11+ only as well? Let me know, and I'll either move both commits to another branch for a followup 3.11+ only PR, or just drop/move 76f04e1 and edit c937d01 to not use |
c937d01
to
faf067a
Compare
c99a4b0
to
2342f43
Compare
@brettcannon While I didn't see any response, I'm assuming you're okay with the additional explanations being 3.11-only in light of your approval here and your call on #92613 regarding those deprecations. Therefore, I've gone with the simpler first option for now and just moved everything to another 3.11-only branch but everything except for the commit fixing PEP links to point directly to the relevant sections and linking any stdlib replacements (which, of course, does have to be backported to fix the existing message, as otherwise, those reading the existing message in the 3.9 and (default) 3.10 docs will continue to be confused). |
Sorry, but that's a lot of words with nested parentheses and I'm sick, so my brain can't fully process what you're saying. I think you're just saying you yanked the |
Thanks @CAM-Gerlach for the PR, and @brettcannon for merging it |
GH-92785 is a backport of this pull request to the 3.11 branch. |
…ecation notices (pythonGH-92612) (cherry picked from commit 9f68dab) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
…ecation notices (pythonGH-92612) (cherry picked from commit 9f68dab) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
GH-92786 is a backport of this pull request to the 3.10 branch. |
…ecation notices (pythonGH-92612) (cherry picked from commit 9f68dab) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
GH-92787 is a backport of this pull request to the 3.9 branch. |
Thanks for your help and merging, @brettcannon
Sorry, its my fault—I realized my original explanation was rather dense, buried and overcomplicated so I rewrote it in that comment, but I kept adding to it and it ended up being as complex as the original Take care of yourself, and I hope you feel better!
Yep, basically, except that I also yanked the per-function I'll make two separate PRs, one with each, and if you'd like the per-function deprecation messages backported, I can drop the |
…es (GH-92793) As discussed in #92611 and #92564 and as a followup to PR #92612 , this 3.11+ only PR uses the proper `deprecated-removed` role for the modules deprecated by PEP 593 (PEP-594) to clearly indicate to users that a removal version is planned and what it is, so they can prepare accordingly or voice any unanticipated impacts. Related to #92792 ; if we decide to backport that PR, the upgrade to using `deprecated-removed` on those functions can be moved to this one.
… modules (pythonGH-92793) As discussed in pythonGH-92611 and pythonGH-92564 and as a followup to PR pythonGH-92612 , this 3.11+ only PR uses the proper `deprecated-removed` role for the modules deprecated by PEP 593 (PEP-594) to clearly indicate to users that a removal version is planned and what it is, so they can prepare accordingly or voice any unanticipated impacts. Related to pythonGH-92792 ; if we decide to backport that PR, the upgrade to using `deprecated-removed` on those functions can be moved to this one. (cherry picked from commit 31fa41e) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
…es (GH-92793) (GH-93026) As discussed in GH-92611 and GH-92564 and as a followup to PR GH-92612 , this 3.11+ only PR uses the proper `deprecated-removed` role for the modules deprecated by PEP 593 (PEP-594) to clearly indicate to users that a removal version is planned and what it is, so they can prepare accordingly or voice any unanticipated impacts. Related to GH-92792 ; if we decide to backport that PR, the upgrade to using `deprecated-removed` on those functions can be moved to this one. (cherry picked from commit 31fa41e) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
As discussed in #92611 , currently the experience is pretty subpar for users trying to get even basic information about the deprecations from PEP 594 in the relevant modules' docs. To improve this and increase the visibility of the pending removal, this PR
Uses the properDeferred to a 3.11+ PR for now.deprecated-removed
to clearly indicate to users that a removal version is planned and what it is, so they can prepare accordingly or voice any unanticipated impacts (as discussed in #92564)Add additional replacement information for functions in theDeferred to a 3.11+ PRcgi
module, per requestsAlso, despite having been deprecated for many versions without any mention of imminent removal, the
imp
module is due to be removed in Python 3.12, but no indication of that is given in the documentation, which this also resolves.Fixes #92611