Clarify the Purpose of the PyGILState API and Identify Better Alternatives
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 35.9k
- PR 合併指標
- PR 指標待擷取
描述
This especially applies to the following sections:
- https://docs.python.org/3/c-api/init.html#c.PyGILState_Ensure
- https://docs.python.org/3/c-api/init.html#c.PyGILState_Release
but also:
- https://docs.python.org/3/c-api/init.html#c.PyGILState_GetThisThreadState
- https://docs.python.org/3/c-api/init.html#c.PyGILState_Check
The PyGILState_* C-API was introduced by PEP 311 as a convenience for extension maintainers for some very specific situations:
- code running in the current thread does not know if it holds the GIL
- this situation may involve reentrancy
The PyGILState_* API also (almost incidentally) supports use cases that are more appropriately satisfied by other API, like Py_BEGIN_ALLOW_THREADS()/Py_END_ALLOW_THREADS() for balanced acquire-release.
The documentation isn't so clear about the specific use cases, nor that an interested user may actually want a different API. For example, from a recent issue I saw: We were wrapping each evaluation in PyGILState_Ensure and PyGILState_Release, which I believe is a correct way to do this.
FTR, https://docs.python.org/3/c-api/init.html#non-python-created-threads does a decent job of explaining, as does the PEP, but the entries for PyGILState_Ensure() and PyGILState_Release() are less clear.
FWIW, I expect that it is easier now to deal with the motivating cases using the exiting C-API than it was in 2003. I'm not sure we would accept something like PEP 311 if it were proposed today. Then again, for a pair of operations that needs to balanced like this, having a specific pair of functions is helpful.
Related: a recent discussion about replacing the PyGILState_* API: https://discuss.python.org/t/a-new-api-for-ensuring-releasing-thread-states/83959.
Also see gh-131264 and gh-131265.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
先從 PyGILState_Ensure()、PyGILState_Release()、PyGILState_GetThisThreadState() 和 PyGILState_Check() 的文件條目開始,然後將其與 PEP 311、非 Python 建立的執行緒章節以及連結的討論進行比較。完成的標準是這些條目能清楚說明其預期使用情境,並在適當情況下引導讀者使用更好的替代方案。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- c, python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100