Run tests in debug mode as well (#1146)

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>

Author: bdraco

.github/workflows/ci-cd.yml

@@ -158,7 +158,11 @@ jobs:
       dists-artifact-name: ${{ needs.pre-setup.outputs.dists-artifact-name }}
 
   test:
-    name: Test
+    name: >-
+      Test ${{ matrix.os }}
+      ${{ matrix.pyver }}
+      ${{ matrix.no-extensions == 'Y' && ' ' || 'ext' }}
+      ${{ matrix.debug == 'Y' && 'debug' || '' }}
     needs:
     - build-pure-python-dists  # transitive, for accessing settings
     - build-wheels-for-tested-arches
@@ -174,7 +178,10 @@ jobs:
         - 3.9
         no-extensions: ['', 'Y']
         os: [ubuntu, macos, windows]
+        debug: ['', 'Y']
         exclude:
+        - no-extensions: Y
+          debug: Y
         - os: macos
           no-extensions: Y
         - os: windows
@@ -183,10 +190,13 @@ jobs:
           pyver: 3.13-freethreading  # this is still tested within cibuildwheel
         - os: windows
           pyver: 3.13-freethreading  # this is still tested within cibuildwheel
+        - no-extensions: Y
+          debug: Y
         include:
         - pyver: pypy-3.9
           no-extensions: Y
           os: ubuntu
+          debug: ''
       fail-fast: false
     runs-on: ${{ matrix.os }}-latest
     timeout-minutes: 15
@@ -199,6 +209,14 @@ jobs:
       }}
 
     steps:
+    - name: Determine build type
+      id: build_type
+      run: |
+        echo "build_type=${{
+          (contains(matrix.pyver, '-dev') || matrix.debug == 'Y') &&
+          'source' || 'wheel'
+        }}" >> "$GITHUB_OUTPUT"
+      shell: sh
     - name: Retrieve the project source from an sdist inside the GHA artifact
       uses: re-actors/checkout-python-sdist@release/v2
       with:
@@ -207,7 +225,7 @@ jobs:
         workflow-artifact-name: >-
           ${{ needs.pre-setup.outputs.dists-artifact-name }}
     - name: Download distributions
-      if: ${{ !endsWith(matrix.pyver, '-dev') && true || false }}
+      if: steps.build_type.outputs.build_type == 'wheel'
       uses: actions/download-artifact@v4
       with:
         pattern: ${{ needs.pre-setup.outputs.dists-artifact-name }}*
@@ -268,6 +286,8 @@ jobs:
             matrix.pyver
           }}-${{
             matrix.no-extensions
+          }}-${{
+            matrix.debug
           }}-${{
             hashFiles('requirements/*.txt')
           }}
@@ -279,13 +299,15 @@ jobs:
             matrix.pyver
           }}-${{
             matrix.no-extensions
-          }}-
+          }}-${{
+            matrix.debug
+          }}
     - name: Install dependencies
       uses: py-actions/py-dependency-install@v4
       with:
         path: requirements/pytest.txt
     - name: Determine pre-compiled compatible wheel
-      if: ${{ !endsWith(matrix.pyver, '-dev') && true || false }}
+      if: steps.build_type.outputs.build_type == 'wheel'
       env:
         # NOTE: When `pip` is forced to colorize output piped into `jq`,
         # NOTE: the latter can't parse it. So we're overriding the color
@@ -324,18 +346,18 @@ jobs:
         | jq --raw-output .install[].download_info.url
         | tee -a "${GITHUB_OUTPUT}"
       shell: bash
-    - name: >-
-        Self-install (from ${{
-          endsWith(matrix.pyver, '-dev')
-          && 'source'
-          || 'wheel'
-        }})
+    - name: Ensure clean for source build
+      if: steps.build_type.outputs.build_type == 'source'
+      run: >-
+        make clean
+      shell: bash
+    - name: Self-install (from ${{ steps.build_type.outputs.build_type }})
       env:
         MULTIDICT_NO_EXTENSIONS: ${{ matrix.no-extensions }}
+        MULTIDICT_DEBUG_BUILD: 1  # Always on for source builds
       run: >-
-        python -Im
         pip install '${{
-          endsWith(matrix.pyver, '-dev')
+          steps.build_type.outputs.build_type == 'source'
           && '.'
           || steps.wheel-file.outputs.path
         }}'
@@ -374,6 +396,7 @@ jobs:
       if: ${{ matrix.os == 'ubuntu' }}
       uses: aio-libs/[email protected]
 
+
   benchmark:
     name: Benchmark
     needs:

CHANGES/1145.packaging.rst

@@ -0,0 +1 @@
+Added the ability to build in debug mode by setting :envvar:`MULTIDICT_DEBUG_BUILD` in the environment -- by :user:`bdraco`.

README.rst

@@ -104,7 +104,12 @@ e.g.:
 Please note, the pure Python (uncompiled) version is about 20-50 times slower depending on
 the usage scenario!!!
 
+For extension development, set the ``MULTIDICT_DEBUG_BUILD`` environment variable to compile
+the extensions in debug mode:
 
+.. code-block:: console
+
+   $ MULTIDICT_DEBUG_BUILD=1 pip install multidict
 
 Changelog
 ---------

docs/multidict.rst

@@ -442,3 +442,15 @@ Environment variables
 
       The pure-Python (uncompiled) version is roughly 20-50 times slower than
       its C counterpart, depending on the way it's used.
+
+.. envvar:: MULTIDICT_DEBUG_BUILD
+   
+   An environment variable that instructs the packaging scripts to compile
+   the C-extension based variant of :mod:`multidict` with debug symbols.
+   This is useful for debugging the C-extension code, but it will result in
+   a larger binary size and worse performance.
+
+   .. caution::
+
+      The debug build is not intended for production use and should only be
+      used for development and debugging purposes.

setup.py

@@ -5,12 +5,13 @@
 from setuptools import Extension, setup
 
 NO_EXTENSIONS = bool(os.environ.get("MULTIDICT_NO_EXTENSIONS"))
+DEBUG_BUILD = bool(os.environ.get("MULTIDICT_DEBUG_BUILD"))
 
 if sys.implementation.name != "cpython":
     NO_EXTENSIONS = True
 
-CFLAGS = ["-O3"]
-# CFLAGS = ["-O0", "-g3", "-UNDEBUG"]
+CFLAGS = ["-O0", "-g3", "-UNDEBUG"] if DEBUG_BUILD else ["-O3"]
+
 if platform.system() != "Windows":
     CFLAGS.extend(
         [