working windows debug build

Author: jere8184

buildsystem/HandlePythonOptions.cmake

@@ -1,4 +1,4 @@
-# Copyright 2015-2023 the openage authors. See copying.md for legal info.
+# Copyright 2015-2025 the openage authors. See copying.md for legal info.
 
 # finds the python interpreter, install destination and extension flags.
 
@@ -39,6 +39,17 @@ if(PYTHON_VER VERSION_GREATER_EQUAL 3.8 AND PYTHON_VERSION VERSION_LESS 3.9)
 endif()
 
 set(PYEXT_LIBRARY "${PYTHON_LIBRARIES}")
+
+#Windows always uses optimized version of Python lib
+if(WIN32 AND "${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
+	#get index of string "optimized" and increment it by 1 so index points at the path of the optimized lib
+	list (FIND PYEXT_LIBRARY "optimized" _index)
+	if (${_index} GREATER -1)
+		MATH(EXPR _index "${_index}+1")
+		list(GET PYEXT_LIBRARY ${_index} PYEXT_LIBRARY)
+	endif()
+endif()
+
 set(PYEXT_INCLUDE_DIRS "${PYTHON_INCLUDE_DIRS};${NUMPY_INCLUDE_DIR}")
 
 if(NOT CMAKE_PY_INSTALL_PREFIX)

buildsystem/cythonize.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 #
-# Copyright 2015-2021 the openage authors. See copying.md for legal info.
+# Copyright 2015-2025 the openage authors. See copying.md for legal info.
 
 """
 Runs Cython on all modules that were listed via add_cython_module.
@@ -73,7 +73,7 @@ def remove_if_exists(filename):
         filename.unlink()
 
 
-def cythonize_wrapper(modules, **kwargs):
+def cythonize_wrapper(modules, force_optimized_lib = False, **kwargs):
     """ Calls cythonize, filtering useless warnings """
     bin_dir, bin_modules = kwargs['build_dir'], []
     src_dir, src_modules = Path.cwd(), []
@@ -88,29 +88,40 @@ def cythonize_wrapper(modules, **kwargs):
         with redirect_stdout(cython_filter):
             if src_modules:
                 cythonize(src_modules, **kwargs)
-                windows_include_python_debug_build_wrapper(src_modules, bin_dir)
+                if sys.platform == 'win32' and force_optimized_lib:
+                    windows_use_optimized_lib_python(src_modules, bin_dir)
 
             if bin_modules:
                 os.chdir(bin_dir)
                 cythonize(bin_modules, **kwargs)
-                windows_include_python_debug_build_wrapper(bin_modules, bin_dir)
+                if sys.platform == 'win32' and force_optimized_lib:
+                    windows_use_optimized_lib_python(bin_modules, bin_dir)
                 os.chdir(src_dir)
 
 
-def windows_include_python_debug_build_wrapper(modules, path):
+def windows_use_optimized_lib_python(modules, path):
+    """
+    Add an #ifdef statement in cythonized .cpp files to temporarily undefine _DEBUG before
+    #include "Python.h"
+
+    This function modifies the generated C++ files from Cython to prevent linking to
+    the debug version of the Python library on Windows. The debug version of the
+    Python library cannot import Python libraries that contain extension modules.
+    """
+
     for module in modules:
         module = str(module)
-        if (path):
+        if path:
             module = path + "\\" + module
         module = module.removesuffix(".py").removesuffix(".pyx")
         module = module + ".cpp"
-        with open(module, "r") as file:
+        with open(module, "r", encoding='utf8') as file:
             text = file.read()
             text = text.replace("#include \"Python.h\"",
                                 "#ifdef _DEBUG\n#define _DEBUG_WAS_DEFINED\n#undef _DEBUG\n#endif\n\
                                 #include \"Python.h\"\n#ifdef _DEBUG_WAS_DEFINED\n#define _DEBUG\n\
                                 #undef _DEBUG_WAS_DEFINED\n#endif", 1)
-        with open(module, "w") as file:
+        with open(module, "w", encoding='utf8') as file:
             file.write(text)
 
 
@@ -144,6 +155,8 @@ def main():
     ))
     cli.add_argument("--threads", type=int, default=cpu_count(),
                      help="number of compilation threads to use")
+    cli.add_argument("--force_optimized_lib", action="store_true",
+                     help= "edit compiled .cpp files to link to optimized version of python libary")
     args = cli.parse_args()
 
     # cython emits warnings on using absolute paths to modules
@@ -178,12 +191,12 @@ def main():
     # writing funny lines at the head of each file.
     cythonize_args['language'] = 'c++'
 
-    cythonize_wrapper(modules, **cythonize_args)
+    cythonize_wrapper(modules, args.force_optimized_lib, **cythonize_args)
 
     # build standalone executables that embed the py interpreter
     Options.embed = "main"
 
-    cythonize_wrapper(embedded_modules, **cythonize_args)
+    cythonize_wrapper(embedded_modules, args.force_optimized_lib, **cythonize_args)
 
     # verify depends
     from Cython.Build.Dependencies import _dep_tree

buildsystem/python.cmake

@@ -1,4 +1,4 @@
-# Copyright 2014-2020 the openage authors. See copying.md for legal info.
+# Copyright 2014-2025 the openage authors. See copying.md for legal info.
 
 # provides macros for defining python extension modules and pxdgen sources.
 # and a 'finalize' function that must be called in the end.
@@ -128,7 +128,8 @@ function(add_cython_modules)
 				if(MINGW)
 					set_target_properties("${TARGETNAME}" PROPERTIES LINK_FLAGS "-municode")
 				endif()
-				target_link_libraries("${TARGETNAME}" PRIVATE C:/vcpkg/installed/x64-windows/lib/python311.lib)
+
+				target_link_libraries("${TARGETNAME}" PRIVATE ${PYEXT_LIBRARY})
 			else()
 				set_property(GLOBAL APPEND PROPERTY SFT_CYTHON_MODULES "${source}")
 				add_library("${TARGETNAME}" MODULE "${CPPNAME}")
@@ -139,7 +140,7 @@ function(add_cython_modules)
 				)
 
 				if(WIN32)
-					target_link_libraries("${TARGETNAME}" PRIVATE C:/vcpkg/installed/x64-windows/lib/python311.lib)
+					target_link_libraries("${TARGETNAME}" PRIVATE ${PYEXT_LIBRARY})
 				endif()
 			endif()
 
@@ -374,6 +375,9 @@ function(python_finalize)
 
 
 	# cythonize (.pyx -> .cpp)
+	if(WIN32 AND "${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
+		set(force_optimized_lib "--force_optimized_lib")
+	endif()
 
 	get_property(cython_modules GLOBAL PROPERTY SFT_CYTHON_MODULES)
 	write_on_change("${CMAKE_BINARY_DIR}/py/cython_modules" "${cython_modules}")
@@ -392,6 +396,7 @@ function(python_finalize)
 		"${CMAKE_BINARY_DIR}/py/cython_modules"
 		"${CMAKE_BINARY_DIR}/py/cython_modules_embed"
 		"${CMAKE_BINARY_DIR}/py/pxd_list"
+		${force_optimized_lib}
 		"--build-dir" "${CMAKE_BINARY_DIR}"
 		COMMAND "${CMAKE_COMMAND}" -E touch "${CYTHONIZE_TIMEFILE}"
 		DEPENDS
@@ -513,7 +518,6 @@ function(python_finalize)
 		${INPLACEMODULES_LISTFILE}
 		"$<CONFIG>"
 	)
-	message(hello jeremiah, ${INPLACEMODULES_LISTFILE})
 	set(INPLACEMODULES_TIMEFILE "${CMAKE_BINARY_DIR}/py/inplacemodules_timefile")
 	add_custom_command(OUTPUT "${INPLACEMODULES_TIMEFILE}"
 		COMMAND ${INPLACEMODULES_INVOCATION}