gh-69912: Document sys.getprofile() behavior with C profilers#143338
Open
heathdutton wants to merge 2 commits into
Open
gh-69912: Document sys.getprofile() behavior with C profilers#143338heathdutton wants to merge 2 commits into
heathdutton wants to merge 2 commits into
Conversation
heathdutton
force-pushed
the
gh-69912-doc-sys-getprofile-setprofile-asymmetry
branch
from
4d52e80 to
b8c412c
Compare
|
This PR is stale because it has been open for 30 days with no activity. |
Documentation build overview
|
github-actions
Bot
removed
the
stale
Member
|
@birkenfeld, could you please review this PR? |
serhiy-storchaka
added
needs backport to 3.13
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
2 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.
When a C profile function is in effect (such as one installed by
cProfile),sys.getprofile()returns the internal profiler object rather than a callable. This object is not suitable for passing tosys.setprofile(), so saving and restoring the profiler state using this pair of functions may not work as expected.This adds an implementation detail note to
sys.getprofile()documenting this behavior, following the same pattern used forsys.gettrace().📚 Documentation preview 📚: https://cpython-previews--143338.org.readthedocs.build/