Support coverage of Cython code

lenskit · Mar 4, 2024 · 0c9a3d7 · 0c9a3d7
1 parent a0f1dea
commit 0c9a3d7
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/.coveragerc b/.coveragerc
diff --git a/pyproject.toml b/pyproject.toml
@@ -157,3 +157,6 @@ exclude = [
 ]
 reportMissingImports = true
 reportMissingTypeStubs = false
+
+[tool.coverage.run]
+plugins = ["Cython.Coverage"]
diff --git a/setup.py b/setup.py
@@ -1,3 +1,5 @@
+import os
+
 from setuptools import Extension, setup
 
 try:
@@ -7,19 +9,29 @@
 except ImportError:
     USE_CYTHON = False
 
+
+COVERAGE = os.environ.get("BUILD_FOR_COVER", None)
 EXT_SPECS = {"lenskit.util.kvp": None}
 
+CYTHON_OPTIONS = {}
+C_DEFINES = []
+if COVERAGE:
+    print("enabling tracing")
+    CYTHON_OPTIONS["linetrace"] = True
+    C_DEFINES.append(("CYTHON_TRACE_NOGIL", "1"))
+
 
 def _make_extension(name: str, opts: None) -> Extension:
     path = name.replace(".", "/")
     if USE_CYTHON:
         path += ".pyx"
     else:
         path += ".c"
-    return Extension(name, [path])
+    return Extension(name, [path], define_macros=C_DEFINES)
 
 
 EXTENSIONS = [_make_extension(ext, opts) for (ext, opts) in EXT_SPECS.items()]
 if USE_CYTHON:
-    EXTENSIONS = cythonize(EXTENSIONS)
+    EXTENSIONS = cythonize(EXTENSIONS, compiler_directives=CYTHON_OPTIONS)
+print(EXTENSIONS[0].__dict__)
 setup(ext_modules=EXTENSIONS)