gh-134009: Expose PyMutex_IsLocked in the public C API
#134365
Conversation
The `PyMutex_IsLocked()` function is useful in assertions for verifying that code maintains certain locking invariants.
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
|
|
||
| Returns non-zero if the mutex *m* is currently locked, zero otherwise. | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
I think we should consider promoting this note to a warning. I feel like a note doesn't address the actual severity of using this for control flow.
There was a problem hiding this comment.
No, the note is appropriate. The API does exactly what it name suggests.
There was a problem hiding this comment.
Yeah, but it's a pitfall that I commonly see people fall into, and it can cause crashes. I'm a little worried that a note is something that people will skip over, or at least not fully mentally process. Is there an API for precedent you had in mind?
There was a problem hiding this comment.
Where have you seen people fall into this?
There was a problem hiding this comment.
On GitHub, the two best examples off the top of my head are #125908 and #134289 (comment). It's a mistake I could definitely see some users of the C API making, but I'll be able to live with it as a note too.
The
PyMutex_IsLocked()function is useful in assertions for verifying that code maintains certain locking invariants.PyMutex_IsLockedin the public C API #134009📚 Documentation preview 📚: https://cpython-previews--134365.org.readthedocs.build/en/134365/c-api/init.html#c.PyMutex_IsLocked