-
-
Notifications
You must be signed in to change notification settings - Fork 33.7k
Description
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.libby# pragma comment(lib,"python315_d.lib").
This restriction was overcomed in Python 3.14 by introduction ofPy_NO_LINK_LIBmacro. -
Py_DEBUGalso automatically setsPy_REF_DEBUG, which in turn enables additional symbols (namelyPy_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 disablePy_REF_DEBUGwhenPy_DEBUGis 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 settingPy_REF_DEBUGbased onPy_DEBUG.
It's a minimal change change to overcome the current problem.
It seems currently there are no implications when setPy_DEBUGwould conflict with unsetPy_REF_DEBUG, but Python developers will need to keep it in mind in future thatPy_REF_DEBUGmight be unset even in debug builds. -
Py_WIN_NO_PY_DEBUG- that would make_DEBUGnot implyPy_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 - makingPy_DEBUGdeliberate choice on both Windows and Unix systems.
_DEBUGimplyingPy_DEBUGseems to be mostly historical thing introduced awhile ago (9f9fa6d) and they're not closely related.
AddingPy_WIN_NO_PY_DEBUGalso opens an opportunity in the future to completely deprecate_DEBUGsettingPy_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