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.

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

Jump to bottom

bpo-46355: What's New: Note that PyFrameObject are private #31032

Merged
merged 1 commit into from
Feb 1, 2022
Merged

bpo-46355: What's New: Note that PyFrameObject are private #31032

merged 1 commit into from
Feb 1, 2022

Conversation

encukou
Copy link
Member

@encukou encukou commented Jan 31, 2022 •
edited by miss-islington
Loading

This adds a slightly more detailed explanation of the change.
The most important point is that the changed/removed fields
were "subject to change" to begin with.

https://bugs.python.org/issue46355

Automerge-Triggered-By: GH:encukou

@encukou
bpo-46355: What's New: Note that PyFrameObject are private
e1059a3 
This adds a slightly more detailed explanation of the change.
The most important point is that the changed/removed fields
were "subject to change" to begin with.
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jan 31, 2022
@encukou encukou requested a review from vstinner January 31, 2022 12:28
vstinner
vstinner approved these changes Jan 31, 2022
View reviewed changes
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

LGTM. You're right, it's good to remind that the structure is "private".

@vstinner
Copy link
Member

A few lines below, there is "Changes of the PyThreadState structure members". IMO this structure is also private. At least, @markshannon and me want to make it opaque :-)

@encukou
Copy link
Member Author

encukou commented Jan 31, 2022

Feel free to send a similar PR.
I like to use similar wording as the docs, but I also check the docs of several past versions, to be fair to people that wrote their code long ago.
So for frame I added the "subject to change at any time", but threadstate docs say the members are not "public", so just calling them "private" should work.

@miss-islington miss-islington merged commit a4cb319 into python:main Feb 1, 2022
@encukou encukou deleted the frame-is-private branch February 1, 2022 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vstinner vstinner vstinner approved these changes

@raghavthind2005 raghavthind2005 raghavthind2005 approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@encukou @vstinner @raghavthind2005 @the-knights-who-say-ni @bedevere-bot @miss-islington