How to disable leak warnings for wheel builds?

[nurpax]

The nanobind docs mention the below:

"Some projects choose to activate leak warnings for internal builds but disable them for wheels uploaded to PyPI, as they can be confusing to end users."

Unfortunately I'm drawing blanks on how to do this concretely. Anyone have ideas on how to disable leak checks specifically when building wheels? Perhaps instruct cmake via environment variables set in cibuildwheel config?

[nurpax]

Looks like I figured it out. For posteriority, here's what worked.

Extension code:

--- a/src/slimgui_ext.cpp
+++ b/src/slimgui_ext.cpp
@@ -68,6 +68,9 @@ static int InputTextCallback(ImGuiInputTextCallbackData* data)
 }

 NB_MODULE(slimgui_ext, m) {
+#if SLIMGUI_DISABLE_LEAK_CHECKS == 1
+    nb::set_leak_warnings(false);
+#endif

     m.attr("IMGUI_VERSION") = IMGUI_VERSION;
     m.attr("IMGUI_VERSION_NUM") = IMGUI_VERSION_NUM;

CMakeLists.txt change:

--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -10,12 +10,20 @@ find_package(Python 3.8
 # Import nanobind through CMake's find_package mechanism
 find_package(nanobind CONFIG REQUIRED)

+# Disable leak checks if requested (usually by cibuildwheel in CI)
+if (DEFINED ENV{SLIMGUI_DISABLE_LEAK_CHECKS})
+    set(DISABLE_LEAK_CHECKS 1)
+else()
+    set(DISABLE_LEAK_CHECKS 0)
+endif()
+
 #add_definitions(-DIMGUI_DISABLE_OBSOLETE_FUNCTIONS=1)
-add_definitions(-DIMGUI_DISABLE_OBSOLETE_KEYIO=1)
+add_definitions(-DIMGUI_DISABLE_OBSOLETE_KEYIO=1 -DSLIMGUI_DISABLE_LEAK_CHECKS=${DISABLE_LEAK_CHECKS})

 nanobind_add_module(slimgui_ext
   NB_STATIC
   STABLE_ABI
+  NB_DOMAIN slimgui_abi_domain

   src/slimgui_ext.cpp
   src/c/imgui/imgui.cpp

And to turn it on in GitHub CI:

--- a/.github/workflows/wheels.yml
+++ b/.github/workflows/wheels.yml
@@ -45,6 +45,8 @@ jobs:
         submodules: true

     - uses: pypa/[email protected]
+      env:
+        CIBW_ENVIRONMENT: SLIMGUI_DISABLE_LEAK_CHECKS=1

     # - name: Verify clean directory
     #   run: git diff --exit-code