Skip to content

gh-115756: make PyCode_GetFirstFree an unstable API #115781

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.

Sign up for GitHub

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

Merged
encukou merged 7 commits into from
Mar 19, 2024
Merged

gh-115756: make PyCode_GetFirstFree an unstable API #115781

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cf33af7
make PyCode_GetFirstFree an unstable API
wrongnull Feb 21, 2024
356db2f
Preserve deprecated API function
wrongnull Feb 22, 2024
001fe51
Make necessary changes in a documentation
wrongnull Feb 22, 2024
db8cb38
Merge branch 'main' into raname-getfirstfree
wrongnull Feb 29, 2024
012f351
add news entry
wrongnull Feb 29, 2024
1a45b38
Avoid undefined reference
encukou Mar 19, 2024
04c101d
Add a blurb
encukou Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Preserve deprecated API function
  • Loading branch information
@wrongnull
wrongnull committed Feb 22, 2024
commit 356db2f2a37fe781ba3319d0cb88abc49d3d4977
4 changes: 4 additions & 0 deletions Include/cpython/code.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,10 @@ static inline int PyUnstable_Code_GetFirstFree(PyCodeObject *op) {
return op->co_nlocalsplus - op->co_nfreevars;
}

Copy link
Copy Markdown
Member

@vstinner vstinner Mar 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

@encukou encukou Mar 19, 2024

Choose a reason for hiding this comment

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

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

What are you basing this on?

Copy link
Copy Markdown
Member

@vstinner vstinner Mar 19, 2024

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member

@encukou encukou Mar 19, 2024

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

@vstinner vstinner Mar 19, 2024

Choose a reason for hiding this comment

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

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.

Py_DEPRECATED(3.13) static inline int PyCode_GetFirstFree(PyCodeObject *op) {
return PyUnstable_Code_GetFirstFree(op);
}

#define _PyCode_CODE(CO) _Py_RVALUE((_Py_CODEUNIT *)(CO)->co_code_adaptive)
#define _PyCode_NBYTES(CO) (Py_SIZE(CO) * (Py_ssize_t)sizeof(_Py_CODEUNIT))

Expand Down