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

List and document remaining significant PEPs in What's New in 3.11 #95914

Closed
5 tasks done
CAM-Gerlach opened this issue Aug 12, 2022 · 14 comments
Closed
5 tasks done

List and document remaining significant PEPs in What's New in 3.11 #95914

CAM-Gerlach opened this issue Aug 12, 2022 · 14 comments
Assignees
Labels
3.11 only security fixes docs Documentation in the Doc dir

Comments

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Aug 12, 2022

As discussed with @pablogsal , meta-issue to add the significant PEPs not yet added to the summary section of the What's New in Python 3.11, as well as PEPs that are not documented in the body of the What's New but probably should be.

Specifically, the PEPs not currently mentioned in the Summary - Release Highlights section are (written with a non-canonical - so GitHub will link them):

  • PEP-594 Removing dead stdlib batteries
  • PEP-624 Remove Py_UNICODE encoder APIs
  • PEP-657 Fine-grained error locations
  • PEP-670 Macros to Functions in the C API
  • PEP-678 Enriching exceptions with notes
  • PEP-680: Tomllib
  • PEP-681 Dataclass transforms
  • PEP-682 Format specifier for signed zero (?)

These will be added to the relevant lists as appropriate, following the mold of the Python 3.10 What's New

Most 3.11 PEPs are already described in other What's New sections, but a few are conspicuously missing and should probably be documented somewhere. I've cross referenced this with the PEP API, as well as Accepted/Final PEPs that were not tagged with a Python-Version (notably, PEP 654 was lacking it, which I also fixed):

Then, once those are dealt with, we should finally:

Related: #95913

@iritkatriel
Copy link
Member

I'll add something. on PEP 654.

@CAM-Gerlach
Copy link
Member Author

Thanks @iritkatriel !

@belm0
Copy link
Contributor

belm0 commented Aug 16, 2022

Regarding PEP-682 "Format specifier for signed zero", see discussion in PR #93624. Though it has a PEP, a few of us thought that it didn't warrant being in the highlights.

@CAM-Gerlach
Copy link
Member Author

To note, I didn't actually add PEP 682 in #95916 unlike the others, and FWIW that reasoning seemed reasonably compelling—it didn't appear to be that much more significant from a user or developer perspective than many of the various other changes not mentioned there. I meant to bring that point up for discussion on the PR, but it seems it slipped by mind. Its up to @pablogsal , of course—if you think it should be added as a Summary bullet (its already mentioned under "Other Language Changes", along with other similarly-sized items), I would be of course happy to submit a PR to do so.

@belm0
Copy link
Contributor

belm0 commented Aug 16, 2022

To expand on it a little, "has a PEP" may not be the right bar for appearing in highlights, since the PEP process can be triggered by subtle policy reasons, etc. and not necessarily correspond to a change of interest to a lot of people.

@CAM-Gerlach
Copy link
Member Author

CAM-Gerlach commented Aug 16, 2022

Right, and that's not the actual (nominal) guideline—rather, it is "most important changes", then "PEP-sized items". There isn't a rule that every PEP has to appear in the summary, nor that the summary should be composed only of PEPs. Rather, the basic idea seems to be that the section should reflect changes of the size that would generally be found in a typical PEP. This does require some degree of subjective judgement, which is left in the capable hands of the RM (hence the ping), at times aided by the change authors/committers. I didn't mean to imply this in the issue description (my earlier proposal was much more clear about that); I've revised it accordingly.

@CAM-Gerlach CAM-Gerlach changed the title List and document missing PEPs in What's New in 3.11 List and document remaining significant PEPs in What's New in 3.11 Aug 16, 2022
@CAM-Gerlach
Copy link
Member Author

I've opened #96016 to add a description of the Py_UNICODE encoder removals for PEP 624 in the appropriate section.

pablogsal pushed a commit that referenced this issue Aug 18, 2022
…s New (#96016)

* 3.11 Whatsnew: Add Py_UNICODE encode functions removed in PEP 624

* Just use :func: instead of :c:func: for non-resolved funcs so ! works
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 18, 2022
… What's New (pythonGH-96016)

* 3.11 Whatsnew: Add Py_UNICODE encode functions removed in PEP 624

* Just use :func: instead of :c:func: for non-resolved funcs so ! works
(cherry picked from commit b6d88b7)

Co-authored-by: C.A.M. Gerlach <[email protected]>
miss-islington added a commit that referenced this issue Aug 19, 2022
…s New (GH-96016)

* 3.11 Whatsnew: Add Py_UNICODE encode functions removed in PEP 624

* Just use :func: instead of :c:func: for non-resolved funcs so ! works
(cherry picked from commit b6d88b7)

Co-authored-by: C.A.M. Gerlach <[email protected]>
miss-islington added a commit that referenced this issue Sep 8, 2022
…3.11' (GH-95937)

(cherry picked from commit 1402d2c)

Co-authored-by: Irit Katriel <[email protected]>
@CAM-Gerlach
Copy link
Member Author

Now that #95915 and #96097 are merged, I can go ahead with a PR for linking each summary entry to its appropriate subsection.

@erlend-aasland @vstinner should we include at least a short summary of the PEP 670 changes in the C API section, and/or a mention in the PEP-level summary up top? I could try to draft something, but it would probably be best if a subject matter expert like yourselves did (even as just plain text), which I could then reSTify if needed and review.

@erlend-aasland
Copy link
Contributor

I started preparing a short text for PEP 670. I'll make it into a PR (I have some time off for this on Thursday).

@CAM-Gerlach
Copy link
Member Author

Hey @erlend-aasland , did you get the chance to work on that at some point?

@CAM-Gerlach
Copy link
Member Author

After talking with @erlend-aasland , I've opened #98315 to document PEP-670, which should be the last blocker before I can link all the summary items to an entry and then we can close this issue.

miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 17, 2022
miss-islington added a commit that referenced this issue Oct 17, 2022
(cherry picked from commit aafc53c)

Co-authored-by: C.A.M. Gerlach <[email protected]>
carljm added a commit to carljm/cpython that referenced this issue Oct 17, 2022
* main: (31 commits)
  pythongh-95913: Move subinterpreter exper removal to 3.11 WhatsNew (pythonGH-98345)
  pythongh-95914: Add What's New item describing PEP 670 changes (python#98315)
  Remove unused arrange_output_buffer function from zlibmodule.c. (pythonGH-98358)
  pythongh-98174: Handle EPROTOTYPE under macOS in test_sendfile_fallback_close_peer_in_the_middle_of_receiving (python#98316)
  pythonGH-98327: Reduce scope of catch_warnings() in _make_subprocess_transport (python#98333)
  pythongh-93691: Compiler's code-gen passes location around instead of holding it on the global compiler state (pythonGH-98001)
  pythongh-97669: Create Tools/build/ directory (python#97963)
  pythongh-95534: Improve gzip reading speed by 10% (python#97664)
  pythongh-95913: Forward-port int/str security change to 3.11 What's New in main (python#98344)
  pythonGH-91415: Mention alphabetical sort ordering in the Sorting HOWTO (pythonGH-98336)
  pythongh-97930: Merge with importlib_resources 5.9 (pythonGH-97929)
  pythongh-85525: Remove extra row in doc (python#98337)
  pythongh-85299: Add note warning about entry point guard for asyncio example (python#93457)
  pythongh-97527: IDLE - fix buggy macosx patch (python#98313)
  pythongh-98307: Add docstring and documentation for SysLogHandler.createSocket (pythonGH-98319)
  pythongh-94808: Cover `PyFunction_GetCode`, `PyFunction_GetGlobals`, `PyFunction_GetModule` (python#98158)
  pythonGH-94597: Deprecate child watcher getters and setters (python#98215)
  pythongh-98254: Include stdlib module names in error messages for NameErrors (python#98255)
  Improve speed. Reduce auxiliary memory to 16.6% of the main array. (pythonGH-98294)
  [doc] Update logging cookbook with an example of custom handling of levels. (pythonGH-98290)
  ...
@CAM-Gerlach
Copy link
Member Author

I'll go ahead and open a PR on the final step, linking the summary items to their sections, once #98342 is merged. Almost done here!

ezio-melotti pushed a commit that referenced this issue Oct 18, 2022
Add links to Summary items to where readers can learn more
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 18, 2022
)

Add links to Summary items to where readers can learn more
(cherry picked from commit fcae195)

Co-authored-by: C.A.M. Gerlach <[email protected]>
miss-islington added a commit that referenced this issue Oct 18, 2022
Add links to Summary items to where readers can learn more
(cherry picked from commit fcae195)

Co-authored-by: C.A.M. Gerlach <[email protected]>
@CAM-Gerlach
Copy link
Member Author

All tasks complete, so going ahead and closing this as resolved. Thanks everyone for your help!

Repository owner moved this from In Progress to Done in Sprint 2024 Oct 19, 2022
@erlend-aasland
Copy link
Contributor

Great job!

pablogsal pushed a commit that referenced this issue Oct 22, 2022
pablogsal pushed a commit that referenced this issue Oct 22, 2022
Add links to Summary items to where readers can learn more
(cherry picked from commit fcae195)

Co-authored-by: C.A.M. Gerlach <[email protected]>
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
Projects
Archived in project
Development

No branches or pull requests

4 participants