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

Jump to bottom

Edit What's New for Python 3.11 #95913

Open
16 of 32 tasks
CAM-Gerlach opened this issue Aug 12, 2022 · 9 comments
Open
16 of 32 tasks

Edit What's New for Python 3.11 #95913

CAM-Gerlach opened this issue Aug 12, 2022 · 9 comments
Assignees
@pablogsal @CAM-Gerlach
Labels
3.11 docs Documentation in the Doc dir

Comments

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Aug 12, 2022 •
edited

As discussed with @pablogsal , this is a meta-issue for coordinating an editing pass on the What's New in Python 3.11 document.

The focus with this issue and its accompanying PRs will be on textual and reST/Sphinx fixes and improvements to the existing content, rather than adding any missing NEWS entries, or touching the organization of the document itself. Another issue, #95914 , will cover adding the PEPs not currently listed to the Summary - Release highlights section, as well as a few PEPs that are not documented at all in What's New, but probably should be somewhere (PEP-624, PEP-654 and PEP-670).

It seems best to split this into separate PRs, one for each top-level section. I've listed them here for reference, with PRs linked as they are submitted:

Pre-/co-requisites

Edit Sections

Add new APIs

Adapted and updated from @pablogsal 's post

Related
@CAM-Gerlach CAM-Gerlach added docs Documentation in the Doc dir 3.11 labels Aug 12, 2022
@CAM-Gerlach CAM-Gerlach self-assigned this Aug 12, 2022
This was referenced Aug 12, 2022
Open
Merged
@pablogsal
Copy link
Member

pablogsal commented Aug 13, 2022 •
edited by gvanrossum

The following functions has been added in 3.11 and must be (maybe) documented as well:

  • module: zipfile
    added: ['Path.suffix', 'Path.stem', 'Path.suffixes', 'ZipFile.mkdir']
  • module: tempfile
    added: ['SpooledTemporaryFile.detach', 'SpooledTemporaryFile.read1', 'SpooledTemporaryFile.writable', 'SpooledTemporaryFile.readinto1', 'SpooledTemporaryFile.seekable', 'SpooledTemporaryFile.readable', 'SpooledTemporaryFile.readinto']
  • module: hashlib
    added: ['file_digest']
  • module: traceback
    added: ['TracebackException.print', 'StackSummary.format_frame_summary']
  • module: pdb
    added: ['ScriptTarget', 'ModuleTarget']
  • module: inspect
    added: ['FrameInfo']
  • module: contextlib
    added: ['chdir']
  • module: string
    added: ['Template.is_valid', 'Template.get_identifiers']
  • module: enum
    added: ['global_enum_repr', 'global_str', 'show_flag_values', 'global_flag_repr']
  • module: asyncio.tasks
    added: ['Task.cancelling', 'Task.uncancel']
  • module: asyncio.selector_events
    added: ['BaseSelectorEventLoop.sock_recvfrom_into', 'BaseSelectorEventLoop.sock_recvfrom', 'BaseSelectorEventLoop.sock_sendto']
  • module: asyncio.proactor_events
    added: ['BaseProactorEventLoop.sock_recvfrom_into', 'BaseProactorEventLoop.sock_recvfrom', 'BaseProactorEventLoop.sock_sendto']
  • module: asyncio.sslproto
    added: ['SSLProtocolState', 'AppProtocolState', 'add_flowcontrol_defaults', 'SSLProtocol.get_buffer', 'SSLProtocol.buffer_updated']
  • module: asyncio.runners
    added: ['Runner']
  • module: asyncio.exceptions
    added: ['BrokenBarrierError']
  • module: asyncio.windows_events
    added: ['IocpProactor.recvfrom_into']
  • module: logging.handlers
    added: ['SysLogHandler.createSocket']

@pablogsal
Copy link
Member

pablogsal commented Aug 13, 2022 •
edited

CC: @tiran @iritkatriel @asvetlov @ambv as you were involved in some of the changes (and the dev in residence for awareness).

@tiran
Copy link
Member

tiran commented Aug 13, 2022

hashlib.file_digest is covered by gh-95965.

@iritkatriel
Copy link
Member

iritkatriel commented Aug 14, 2022

@jaraco should pdb.ScriptTarget pdb.ModuleTarget be documented? I think they were intended to be implementation details.

@jaraco
Copy link
Member

jaraco commented Aug 14, 2022

@jaraco should pdb.ScriptTarget pdb.ModuleTarget be documented? I think they were intended to be implementation details.

Correct. Those are implementation details.

@bedevere-bot bedevere-bot mentioned this issue Aug 15, 2022
Merged
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Aug 17, 2022
@iritkatriel
pythongh-95913: make the new internal classes pdb.ModuleTarget/Script…
eb91e0b 
…Target private
@bedevere-bot bedevere-bot mentioned this issue Aug 17, 2022
Merged
@CAM-Gerlach CAM-Gerlach changed the title Copyedit/Proofread What's New for Python 3.11 Edit What's New for Python 3.11 Aug 17, 2022
@bedevere-bot bedevere-bot mentioned this issue Aug 18, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 18, 2022
@iritkatriel @miss-islington
pythongh-95913: make the new internal classes pdb.ModuleTarget/Script…
117c7c6 
…Target private (pythonGH-96053)

(cherry picked from commit 1a720c6)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
iritkatriel added a commit that referenced this issue Aug 18, 2022
@iritkatriel
gh-95913: make the new internal classes pdb.ModuleTarget/ScriptTarget…
1a720c6 
… private (GH-96053)
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 18, 2022
@iritkatriel @miss-islington
pythongh-95913: Add traceback module additions to what's new in 3.11 (p…
0015245 
…ythonGH-95980)

(cherry picked from commit c5bc67b)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
iritkatriel added a commit that referenced this issue Aug 18, 2022
@iritkatriel
gh-95913: Add traceback module additions to what's new in 3.11 (GH-95980
c5bc67b 
)
@bedevere-bot bedevere-bot mentioned this issue Aug 18, 2022
Merged
iritkatriel added a commit that referenced this issue Aug 18, 2022
@miss-islington @iritkatriel
gh-95913: Add traceback module additions to what's new in 3.11 (GH-95980
7c334a3 
) (GH-96064)

(cherry picked from commit c5bc67b)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
pablogsal pushed a commit that referenced this issue Aug 18, 2022
@miss-islington @iritkatriel
[3.11] gh-95913: make the new internal classes pdb.ModuleTarget/Scrip…
1b9b485 
…tTarget private (GH-96053) (#96063)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
@CAM-Gerlach CAM-Gerlach mentioned this issue Aug 19, 2022
Merged
tiran pushed a commit to tiran/cpython that referenced this issue Aug 19, 2022
@iritkatriel @tiran
pythongh-95913: make the new internal classes pdb.ModuleTarget/Script…
eae213f 
…Target private (pythonGH-96053)
tiran pushed a commit to tiran/cpython that referenced this issue Aug 19, 2022
@iritkatriel @tiran
pythongh-95913: Add traceback module additions to what's new in 3.11 (p…
4fe1cf8 
…ythonGH-95980)
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Sep 19, 2022
@CAM-Gerlach @miss-islington
pythongh-95913: Fix and copyedit New Features section of 3.11 What's …
91446f3 
…New (pythonGH-95915)

(cherry picked from commit 8ee27e3)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-bot bedevere-bot mentioned this issue Sep 19, 2022
Merged
encukou pushed a commit that referenced this issue Sep 19, 2022
@CAM-Gerlach
gh-95913: Fix and copyedit New Features section of 3.11 What's New (G…
8ee27e3 
…H-95915)
encukou pushed a commit that referenced this issue Sep 19, 2022
@CAM-Gerlach @ezio-melotti @AlexWaygood
gh-95913: Copyedit, link & format Typing Features section in 3.11 Wha…
558768f 
…t's New (GH-96097)


Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
ezio-melotti added a commit that referenced this issue Oct 4, 2022
@CAM-Gerlach @ezio-melotti
gh-95913: Move py.exe to appropriate What's New section & refine text (…
9859581 
…#97718)

* Move Windows py.exe improvements from Typing section to New Features

* Add ref target label and use literal for py.exe

* Be clearer/explict about what legacy version arg components reprisent

* Apply other minor clarity and textual fixes to py.exe launcher text

* Refine phrasing of legacy sentence of py.exe desc

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 4, 2022
@CAM-Gerlach @miss-islington
pythongh-95913: Move py.exe to appropriate What's New section & refin…
49314d9 
…e text (pythonGH-97718)

* Move Windows py.exe improvements from Typing section to New Features

* Add ref target label and use literal for py.exe

* Be clearer/explict about what legacy version arg components reprisent

* Apply other minor clarity and textual fixes to py.exe launcher text

* Refine phrasing of legacy sentence of py.exe desc

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 9859581)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-bot bedevere-bot mentioned this issue Oct 4, 2022
Merged
miss-islington added a commit that referenced this issue Oct 4, 2022
@miss-islington @CAM-Gerlach
gh-95913: Move py.exe to appropriate What's New section & refine text (…
a685cc0 
…GH-97718)

* Move Windows py.exe improvements from Typing section to New Features

* Add ref target label and use literal for py.exe

* Be clearer/explict about what legacy version arg components reprisent

* Apply other minor clarity and textual fixes to py.exe launcher text

* Refine phrasing of legacy sentence of py.exe desc

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 9859581)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
ezio-melotti added a commit that referenced this issue Oct 4, 2022
@CAM-Gerlach @ezio-melotti
gh-95913: Copyedit/improve Other Language Changes What's New section (#…
a77d9de 
…97719)

* Add/refine cross references to items in other lang changes section

* Unify context manager exception changes into single non-repetitive item

* More clearly describe the intent and consequences of the -P option

* Apply minor clarifications & copyedits to rest of section

* Tweak the formatting of module references

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 4, 2022
@CAM-Gerlach @miss-islington
pythongh-95913: Copyedit/improve Other Language Changes What's New se…
f29e096 
…ction (pythonGH-97719)

* Add/refine cross references to items in other lang changes section

* Unify context manager exception changes into single non-repetitive item

* More clearly describe the intent and consequences of the -P option

* Apply minor clarifications & copyedits to rest of section

* Tweak the formatting of module references

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit a77d9de)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-bot bedevere-bot mentioned this issue Oct 4, 2022
Merged
miss-islington added a commit that referenced this issue Oct 4, 2022
@miss-islington @CAM-Gerlach
gh-95913: Copyedit/improve Other Language Changes What's New section (G…
a13b4e8 
…H-97719)

* Add/refine cross references to items in other lang changes section

* Unify context manager exception changes into single non-repetitive item

* More clearly describe the intent and consequences of the -P option

* Apply minor clarifications & copyedits to rest of section

* Tweak the formatting of module references

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit a77d9de)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
ezio-melotti added a commit that referenced this issue Oct 5, 2022
@CAM-Gerlach @ezio-melotti
gh-95913: Copyedit/improve Implementation Changes What's New section (#…
4e73181 
…97720)

* Add and refine reST/Sphinx syntax for implementation changes section

* Clarify and refine wording in the Implementation Changes section

* Elide unnecessary comma

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 5, 2022
@CAM-Gerlach @miss-islington
pythongh-95913: Copyedit/improve Implementation Changes What's New se…
16f8b29 
…ction (pythonGH-97720)

* Add and refine reST/Sphinx syntax for implementation changes section

* Clarify and refine wording in the Implementation Changes section

* Elide unnecessary comma

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 4e73181)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-bot bedevere-bot mentioned this issue Oct 5, 2022
Merged
miss-islington added a commit that referenced this issue Oct 5, 2022
@miss-islington @CAM-Gerlach
gh-95913: Copyedit/improve Implementation Changes What's New section (G…
d03f452 
…H-97720)

* Add and refine reST/Sphinx syntax for implementation changes section

* Clarify and refine wording in the Implementation Changes section

* Elide unnecessary comma

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 4e73181)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
mpage pushed a commit to mpage/cpython that referenced this issue Oct 11, 2022
@gvanrossum @kumaraditya303
@CAM-Gerlach @JelleZijlstra @mpage
pythonGH-95913: Update what's new in 3.11 for asyncio (python#97806)
cc60df0 
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
mpage pushed a commit to mpage/cpython that referenced this issue Oct 11, 2022
@CAM-Gerlach @ezio-melotti @mpage
pythongh-95913: Move py.exe to appropriate What's New section & refin…
937cc6d 
…e text (python#97718)

* Move Windows py.exe improvements from Typing section to New Features

* Add ref target label and use literal for py.exe

* Be clearer/explict about what legacy version arg components reprisent

* Apply other minor clarity and textual fixes to py.exe launcher text

* Refine phrasing of legacy sentence of py.exe desc

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
mpage pushed a commit to mpage/cpython that referenced this issue Oct 11, 2022
@CAM-Gerlach @ezio-melotti @mpage
pythongh-95913: Copyedit/improve Other Language Changes What's New se…
c9733b2 
…ction (python#97719)

* Add/refine cross references to items in other lang changes section

* Unify context manager exception changes into single non-repetitive item

* More clearly describe the intent and consequences of the -P option

* Apply minor clarifications & copyedits to rest of section

* Tweak the formatting of module references

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
mpage pushed a commit to mpage/cpython that referenced this issue Oct 11, 2022
@CAM-Gerlach @ezio-melotti @mpage
pythongh-95913: Copyedit/improve Implementation Changes What's New se…
556e861 
…ction (python#97720)

* Add and refine reST/Sphinx syntax for implementation changes section

* Clarify and refine wording in the Implementation Changes section

* Elide unnecessary comma

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@bedevere-bot bedevere-bot mentioned this issue Oct 15, 2022
Open
This was referenced Oct 15, 2022
Open
Open
Closed
Open
Open
Open
Open
Open
@CAM-Gerlach
Copy link
Member Author

CAM-Gerlach commented Oct 16, 2022

Thanks to all involved for your help thus far!

Next big batch of changes are (after a lot of catchup after the sprints) all submitted, adding the remaining missing What's New items that @pablogsal detected, as well as a handful of other missing APIs found crawling the modules' relevant documention, and documenting some elsewhere that hadn't been. In addition, the relevant sections were also edited, and a blurb was added for PEP 670, the final missing undocumented PEP.

Next up, I'll drop a quick PR separating remaining sections/subsections by at least two spaces and adding ref target labels, get that merged quickly, and then start working through them one by one. Once the PRs above all get merged (hopefully very shortly), I'll do the same for each of the Improved modules sections, and also submit the final PR linking the summary items to their entries. Finally, if time allows, I'll go through the documentation of each module not mentioned here and and check that there aren't any major missing improvements to mention.

This was referenced Oct 16, 2022
Open
Merged
Open
gpshead pushed a commit that referenced this issue Oct 17, 2022
@CAM-Gerlach
gh-95913: Forward-port int/str security change to 3.11 What's New in …
bb38b39 
…main (#98344)

Add int/str security change from issue gh-95778 PRs gh-96499 / gh-95800

Co-authored-by: Gregory P. Smith <greg@krypto.org> [Google]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pablogsal pablogsal

@CAM-Gerlach CAM-Gerlach

Labels
3.11 docs Documentation in the Doc dir
Projects
Sprint 2022
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
7 participants
@jaraco @tiran @iritkatriel @gvanrossum @pablogsal @CAM-Gerlach @kumaraditya303