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.

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-95913: Fix, sort & expand pending removal sect in 3.11 WhatsNew #98583

Merged
merged 6 commits into from
Oct 24, 2022

Conversation

CAM-Gerlach
Copy link
Member

@CAM-Gerlach CAM-Gerlach commented Oct 24, 2022

Part of #95913

This PR copyedits, sorts and fixes the syntax of the Pending Removal section of the What's New in Python 3.11 document. In particular, it:

  • Fixes several items that had typos, were duplicated, or otherwise broken
  • Structures the list by modules, then APIs within modules, sorted alphabetically
  • De-resolves references to undocumented APIs to avoid inefficiency and warnings

It also adds several missing modules pending removal in 3.12 but not previously listed, specifically:

  • asynchat
  • asyncore
  • imp
  • The typing.io namespace
  • The typing.re namespace
  • Numerous deprecated aliases (assert* and fail*) in the unittest module that were bumped from 3.11 to 3.12 in beta 1, but not listed anywhere in the document

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 24, 2022
@CAM-Gerlach CAM-Gerlach added 3.11 only security fixes needs backport to 3.11 only security fixes labels Oct 24, 2022
@CAM-Gerlach CAM-Gerlach mentioned this pull request Oct 24, 2022
33 tasks
@CAM-Gerlach CAM-Gerlach force-pushed the whatsnew-edit-pending-removal branch from 974596e to 3f17a8e Compare October 24, 2022 06:38
@pablogsal pablogsal changed the title gh-95913: Fix, sort & expand Pending Rm sect in 3.11 WhatsNew gh-95913: Fix, sort & expand pending removal sect in 3.11 WhatsNew Oct 24, 2022
@pablogsal
Copy link
Member

The docs are failing due to:

WARNING: undefined label: deprecated-aliases


* :func:`!sqlite3.enable_shared_cache`
* :func:`!sqlite3.OptimizedUnicode`
* :mod:`unittest` ``fail*`` and ``assert*`` :ref:`deprecated-aliases`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* :mod:`unittest` ``fail*`` and ``assert*`` :ref:`deprecated-aliases`
* :mod:`unittest` ``fail*`` and ``assert*`` deprecated-aliases

The section was removed in GH-92556.

Copy link
Member

Choose a reason for hiding this comment

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

That's unfortunate because the line is hard to understand without links. As I understand it doesn't refer to all assert* method, just old aliases like assertEquals. Maybe we'll have to list the methods explicitly here?

Copy link
Member

Choose a reason for hiding this comment

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

Yes. IMO the removed table should have been moved here. I'll make a commit.

Copy link
Member

Choose a reason for hiding this comment

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

Pushed directly to CAM's branch, as it would have been awkward as a suggestion or PR-for-a-PR

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for the help and sorry for not being around; I was getting a few hours of sleep after staying at the office way too late past 4 am working on these.

Yeah, the table was removed but in 3.12 and still present in 3.11 where it mattered; my plan was to write the What's New against what would work in 3.11, and then go back later and fix the missing stuff for 3.12+, but I mistakenly thought the undefined label warning was due to -n rather than on by default (and an error with -W). In that case, just adding the full table was the best thing to do given the circumstances.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@encukou encukou merged commit e19c2b9 into python:main Oct 24, 2022
@miss-islington
Copy link
Contributor

Thanks @CAM-Gerlach for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 24, 2022
…New (pythonGH-98583)

* Fix names/references of pending removal APIs

* Sort list of APIs pending removal alphabetically

* Add missing modules/submodules pending removal in 3.12

* Add table of unittest deprecated aliases to 3.11 What's New

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
(cherry picked from commit e19c2b9)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-bot
Copy link

GH-98600 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 24, 2022
miss-islington added a commit that referenced this pull request Oct 25, 2022
…H-98583)

* Fix names/references of pending removal APIs

* Sort list of APIs pending removal alphabetically

* Add missing modules/submodules pending removal in 3.12

* Add table of unittest deprecated aliases to 3.11 What's New

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
(cherry picked from commit e19c2b9)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants