gh-142093: clarify which variables appear in function.__closure__ #142086
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.
This PR adds a clarification to the documentation of function.__closure__,
noting that only variables from an enclosing scope that are actually
referenced in the inner function are included in its closure.
Names defined in the outer function but not referenced inside the nested
function do not appear in co_freevars and therefore do not contribute
cells to function.__closure__.
This behavior follows from the definition of free variables in the
execution model, but placing this clarification directly in the
function.__closure__ section improves interpretability for readers
examining closure behavior.
Documentation-only change; no behavioral modifications.
📚 Documentation preview 📚: https://cpython-previews--142086.org.readthedocs.build/