python / python/cpython

Build Windows debug extensions without debug Python

Abierto
#142,760 8 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

build OS-windows type-feature
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con el PR vinculado gh-142761 y la discusión de Discourse; después, sigue los puntos de entrada Py_DEBUG, Py_REF_DEBUG, Py_NO_LINK_LIB, Py_NO_PY_REF_DEBUG y Py_WIN_NO_PY_DEBUG descritos aquí. Se considera terminado cuando se haya seleccionado uno de los enfoques de macros propuestos y se haya validado que las extensiones de depuración de Windows pueden enlazarse con Python release sin requerir símbolos exclusivos de depuración.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
c, python
Área
build-system
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.