bpo-44800: Document internal frame naming conventions#32281
Merged
ncoghlan merged 1 commit intoApr 3, 2022
python:mainpython/cpython:mainfrom
ncoghlan:bpo-44800-document-status-quoncoghlan/cpython:bpo-44800-document-status-quoCopy head branch name to clipboard
Merged
bpo-44800: Document internal frame naming conventions#32281ncoghlan merged 1 commit intopython:mainpython/cpython:mainfrom ncoghlan:bpo-44800-document-status-quoncoghlan/cpython:bpo-44800-document-status-quoCopy head branch name to clipboard
ncoghlan merged 1 commit into
python:mainpython/cpython:mainfrom
ncoghlan:bpo-44800-document-status-quoncoghlan/cpython:bpo-44800-document-status-quoCopy head branch name to clipboard
Conversation
The fact interpreter frames were split out from full frame objects rather than always being part of the eval loop implementation means that it's tricky to infer the expected naming conventions simply from looking at the code. Documenting the de facto conventions in pycore_frame.h means future readers of the code will have a clear explanation of the rationale for those conventions (i.e. minimising non-functional code churn).
Member
|
@ncoghlan Please don't merge changes without review. This change is both misleading in general and incorrect in detail, as I would have pointed out had you waited for a review rather than merging immediately. |
markshannon
added a commit
that referenced
this pull request
Apr 4, 2022
Member
|
See #32304 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The fact interpreter frames were split out from full frame objects
rather than always being part of the eval loop implementation means
that it's tricky to infer the expected naming conventions simply
from looking at the code.
Documenting the de facto conventions in pycore_frame.h means future
readers of the code will have a clear explanation of the rationale
for those conventions (i.e. minimising non-functional code churn).
Closes bpo-44800
https://bugs.python.org/issue44800