gh-129165: Clarify that signal.raise_signal() sends signal to calling thread #129167
+1
−1
Conversation
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
| @@ -397,7 +397,7 @@ The :mod:`signal` module defines the following functions: | |||
|
|
|||
| .. function:: raise_signal(signum) | |||
|
|
|||
| Sends a signal to the calling process. Returns nothing. | |||
| Sends a signal to the calling thread, not the entire process. Returns nothing. | |||
There was a problem hiding this comment.
- While we're here, it might be worth mentioning that on POSIX systems, this is equivalent to calling
signal.pthread_kill(threading.get_ident(), signum). Or, we could just link to the manpages forraise. - This is the correct description for POSIX, but what about Windows?
|
All commit authors signed the Contributor License Agreement. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 documentation for signal.raise_signal(signum) previously stated that it
"sends a signal to the calling process," which is misleading. In reality,
the signal is sent to the calling thread, which may cause different behavior
in multi-threaded applications.
This PR updates the documentation to clarify that
raise_signal()sendsthe signal to the calling thread instead of the entire process.
Fixes gh-129165.
📚 Documentation preview 📚: https://cpython-previews--129167.org.readthedocs.build/