Document the current practice for SystemError
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 36k
- PR 合并指标
- PR 指标待抓取
描述
@malemburg pointed that the documentation of SystemError only refers to CPython internal errors as the source.
https://docs.python.org/3/library/exceptions.html#SystemError
On practice, SystemError is also raised on improper use of the C API (like NULL pointer, or negative size, or wrong type in the concrete API) if it is possible to detect such error and it is not too costly (macros usually lack any argument checks). An alternative to SystemError is a crash or memory corruption. Currently the main source of SystemError is errors in third-party extensions, not in the Python core or standard extensions.
The documentation looks outdated, perhaps it predates the public C API.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 docs.python.org/3/library/exceptions.html#SystemError 中的 SystemError 部分开始,审阅 issue 对不当使用 C API 的描述。更新文档以反映所述的当前实践,包括扩展中的可检测误用,并确保最终文本不再暗示 CPython 内部错误是唯一来源。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- c, python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100