FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-115756: make PyCode_GetFirstFree an unstable API by wrongnull · Pull Request #115781 · python/cpython · GitHub

/ cpython Public

gh-115756: make PyCode_GetFirstFree an unstable API - #115781

Merged
encukou merged 7 commits into
python:mainfrom
wrongnull:raname-getfirstfree
Mar 19, 2024
ConversationCommits (7)ChecksFiles changed
Merged

gh-115756: make PyCode_GetFirstFree an unstable API#115781
encukou merged 7 commits into
python:mainfrom
wrongnull:raname-getfirstfree

Conversation

wrongnull commented Feb 21, 2024 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Contributor

According to this , should I mention it in the documentation in a separate pull request?

bedevere-app Bot mentioned this pull request Feb 21, 2024
Closed
Eclips4 requested review from encukou, erlend-aasland and vstinner and removed request for gvanrossum February 21, 2024 20:34

erlend-aasland commented Feb 21, 2024

Copy link
Copy Markdown
Contributor

According to this , should I mention it in the documentation in a separate pull request?

No; this PR represents an atomic change. Documentation (and preferably tests) follow. Your previous PR consisted of two different changes1.

But you cannot just remove the existing API; you need to keep it and deprecate it (see PEP-387).

Footnotes

  1. 1: fix the return type of one API. 2: change the documentation of another API. ↩

Eclips4 commented Feb 22, 2024

Copy link
Copy Markdown
Member

Here's an example of deprecation: #105397

wrongnull commented Feb 22, 2024

Copy link
Copy Markdown
Contributor Author

The question may seem silly but should I add a news section?

encukou commented Feb 28, 2024

Copy link
Copy Markdown
Member

Yes, you should. it's a user-visible change.

encukou mentioned this pull request Mar 8, 2024
Closed
5 tasks
encukou reviewed Mar 19, 2024
View reviewed changes
Comment thread Doc/whatsnew/3.13.rst Outdated
encukou enabled auto-merge (squash) March 19, 2024 08:31
vstinner reviewed Mar 19, 2024
View reviewed changes
Comment thread Include/cpython/code.h
assert(PyCode_Check(op));
return op->co_nlocalsplus - op->co_nfreevars;
}

vstinner Mar 19, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

If the deprecation has no detail, for me, it can be removed as soon as in Python 3.15. But the doc is more specific:

"The old name is deprecated, but will remain available until the signature changes again."

Please add a comment to explain it here.

encukou Mar 19, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

If the deprecation has no detail, for me, it can be removed in Python 3.15.

What are you basing this on?

vstinner Mar 19, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

PEP 387: Similarly a feature cannot be removed without notice between any two consecutive releases.

encukou Mar 19, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I'm sorry, I didn't disable automerge after your comment. I didn't mean to ignore you :(

But IMO, the “Basic Policy” is just a summary. The “Making Incompatible Changes” section has more detailed instructions.
If you disagree with my reading, let's take it to Discourse; this isn't a good place for it.

vstinner Mar 19, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

It's just that this function has a specific comment in the doc, IMO it's worth it to repeat it in the header to avoid future eagger removal. But well, now that the change is merged, it's maybe no longer worth it.

encukou merged commit a8e93d3 into python:main Mar 19, 2024
vstinner pushed a commit to vstinner/cpython that referenced this pull request Mar 20, 2024
pythongh-115756: make PyCode_GetFirstFree an unstable API (pythonGH-1…
9ca3e2c 
…15781)
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 25, 2024
pythongh-115756: make PyCode_GetFirstFree an unstable API (pythonGH-1…
245bdd5 
…15781)
diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
pythongh-115756: make PyCode_GetFirstFree an unstable API (pythonGH-1…
40f3cf7 
…15781)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

vstinner vstinner left review comments
encukou encukou approved these changes
markshannon Awaiting requested review from markshannon markshannon is a code owner
iritkatriel Awaiting requested review from iritkatriel iritkatriel is a code owner
erlend-aasland Awaiting requested review from erlend-aasland

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL