bpo-39947: Add PyThreadState_SetTrace() function by vstinner · Pull Request #29121 · python/cpython
Add new PyThreadState_SetProfile() and PyThreadState_SetTrace()
functions to set the profile and the trace function of a Python
thread state.
- Rename _PyEval_SetProfile() to PyThreadState_SetProfile().
- Rename _PyEval_SetTrace() to PyThreadState_SetTrace().
- Rename is_tstate_valid() to _PyThreadState_CheckConsistency().
Add new PyThreadState_SetProfile() and PyThreadState_SetTrace() functions to set the profile and the trace function of a Python thread state. * Rename _PyEval_SetProfile() to PyThreadState_SetProfile(). * Rename _PyEval_SetTrace() to PyThreadState_SetTrace(). * Rename is_tstate_valid() to _PyThreadState_CheckConsistency().
PyThreadState_SetProfile() is needed by the Python yappi profiler:
I'm not sure if yappi can use it directly, since PyThreadState_SetProfile() requires to hold the GIL. But it's more a yappi issue, than an API issue IMO.
This PR is stale because it has been open for 30 days with no activity.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be helpful to add a 3rd column stating which of the trace/profile functions see each event type. In case this isn't pointing to the right place, Doc/c-api/init.rst 1556 or 1616 depending on before/after
| @@ -0,0 +1,3 @@ | |||
| Add new :c:func:`PyThreadState_SetProfile` and | |||
| :c:func:`PyThreadState_SetTrace` functions to set the profile and the trace | |||
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add "(replacing _PyEval_SetProfile)" and "(replacing _PyEval_SetTrace)" since those are likely to be the names people have if they are searching for changes, instead of just reading in advance.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also mention renaming and move is_tstate_valid to _PyThreadState_CheckConsistency
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is_tstate_valid() is a static function, it cannot be used outside ceval.c. We don't document changes which don't affected the public C API.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add "(replacing _PyEval_SetProfile)" and "(replacing _PyEval_SetTrace)" since those are likely to be the names people have if they are searching for changes, instead of just reading in advance.
Usually, we never mention private functions in the changelog.
I think it would be helpful to add a 3rd column stating which of the trace/profile functions see each event type. In case this isn't pointing to the right place, Doc/c-api/init.rst 1556 or 1616 depending on before/after
If you consider that the doc should be completed, please open a new issue. I don't see a direct relationship between your comment and my PR adding new functions.
I'm not convinced that there are 3rd party Python projects which need and will use this function. I prefer to close this PR for now. I may revisit it later, if more users of this function are discovered.
This was referenced