python / python/cpython

Build Windows debug extensions without debug Python

未关闭
#142,760 8 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

build OS-windows type-feature
主要语言
Python
星标
77.2k
派生
35.9k
PR 合并指标
PR 指标待抓取

描述

Feature or enhancement

Proposal:

Summary of a problem

On Windows when users are building a debug version of anything, including Python extensions, they typically provide /MDd/MTd flag to link against the debug version of the C runtime library.

Which automatically sets _DEBUG, which, historically, sets Py_DEBUG macro.

Py_DEBUG macro makes it impossible to link against release version of Python library:

  • because of implicit linking against _d.lib by # pragma comment(lib,"python315_d.lib").
    This restriction was overcomed in Python 3.14 by introduction of Py_NO_LINK_LIB macro.

  • Py_DEBUG also automatically sets Py_REF_DEBUG, which in turn enables additional symbols (namely Py_NegativeRefcount, Py_INCREF_IncRefTotal, Py_DECREF_DecRefTotal), which of course are not present in Release library, so linking Debug build against it is still impossible.
    But if we disable Py_REF_DEBUG when Py_DEBUG is set, then linking succeeds, so there are no more obstacles
    to build debug extensions against release Python.

Typically, users don't want to use debug Python for their extensions, they just want debug version of their own extension, as debug Python binaries are not widely available and even if they are, after build user now would also need debug versions of the entire extensions ecosystem they were using.

So it would be great to provide an option to finally figure this out after all those years.


Changes

There are two approaches to consider (PR currently implements both of them just to showcase the options, but we need to pick one):

  • Py_NO_PY_REF_DEBUG - macro to avoid setting Py_REF_DEBUG based on Py_DEBUG.
    It's a minimal change change to overcome the current problem.
    It seems currently there are no implications when set Py_DEBUG would conflict with unset Py_REF_DEBUG, but Python developers will need to keep it in mind in future that Py_REF_DEBUG might be unset even in debug builds.

  • Py_WIN_NO_PY_DEBUG - that would make _DEBUG not imply Py_DEBUG.
    Honestly, I would prefer this option, as it seems to be a fix for the root cause of the problem and makes flags more consistent between Windows and other platforms - making Py_DEBUG deliberate choice on both Windows and Unix systems.
    _DEBUG implying Py_DEBUG seems to be mostly historical thing introduced awhile ago (https://github.com/python/cpython/commit/9f9fa6d0c937a2cbc51feb3c92212688b09235f0) and they're not closely related.
    Adding Py_WIN_NO_PY_DEBUG also opens an opportunity in the future to completely deprecate _DEBUG setting Py_DEBUG.

Has this already been discussed elsewhere?

I have already discussed this feature proposal on Discourse

Links to previous discussion of this feature:

https://discuss.python.org/t/building-debug-version-of-extensions-on-windows-without-debug-binaries

Linked PRs
  • gh-142761

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

先从链接的 PR gh-142761 和 Discourse 讨论开始,然后跟踪此处描述的 Py_DEBUG、Py_REF_DEBUG、Py_NO_LINK_LIB、Py_NO_PY_REF_DEBUG 和 Py_WIN_NO_PY_DEBUG 入口点。完成的标准是选择一种提出的宏方案,并验证 Windows 调试扩展可以链接到 release Python,而无需调试专用符号。

由索引模型根据 Issue 内容生成。

评估

技术栈
c, python
领域
build-system
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。