TST: Add test for python-including files.

I should add an option to turn off the numpy detection inside numpy.

Author: DWesl

src/check_python_h_first/single_file.py

@@ -78,6 +78,8 @@ def check_python_h_included_first(name_to_check: str) -> int:
                     in_comment = False
                 continue
             line = line.split("//", 1)[0].strip()
+            if len(line) == 0:
+                continue
             # Now that there's no comments, look for headers
             match = HEADER_PATTERN.match(line)
             if match:
@@ -123,7 +125,8 @@ def check_python_h_included_first(name_to_check: str) -> int:
                 not included_python
                 and not warned_python_construct
                 and ".h" not in basename_to_check
-            ) and ("py::" in line or "PYBIND11_" in line):
+            ) and ("py::" in line or "PYBIND11_" in line
+                   or " npy_" in line or " Py" in line or line.startswith("Py")):
                 print(
                     "Python-including header not used before python constructs "
                     f"in file {name_to_check:s}\nConstruct on line {i:d}",
@@ -132,4 +135,4 @@ def check_python_h_included_first(name_to_check: str) -> int:
                 warned_python_construct = True
     if not includes_headers:
         LEAF_HEADERS.append(basename_to_check)
-    return included_python and len(included_non_python_header)
+    return (included_python and len(included_non_python_header)) or warned_python_construct

tests/bad_extension.c

@@ -0,0 +1,6 @@
+
+const float PI = npy_atanf(1.0) * 4f;
+
+PyMODINIT_Func(&func)
+/** I don't actually remember what's supposed to go here
+    fortunately this doesn't need to compile */

tests/good_extension.c

@@ -0,0 +1,6 @@
+/** Test file to do things */
+#include "myheader.h"
+
+PyMODINIT_Func(&func)
+/** I don't actually remember what's supposed to go here
+    fortunately this doesn't need to compile */

tests/myheader.h

@@ -1 +1,2 @@
-#include <Python.h>
+#include <Python.h> // This needs to be first
+#include <numpy/npy_common.h>

tests/test_single_file.py

@@ -17,7 +17,8 @@
 def test_files(file: str):
     """Test whether function on a single file."""
     actual = check_python_h_included_first(file)
-    if os.path.basename(file).startswith("system"):
+    file_basename = os.path.basename(file)
+    if file_basename.startswith("system") or file_basename.startswith("bad"):
         assert actual > 0
     else:
         assert actual == 0

tests/test_wrapper.py

@@ -42,7 +42,7 @@ def test_process_files():
     """
     result = process_files(HEADER_LIST + SOURCE_LIST)
     assert result == sum(
-        os.path.basename(name).startswith("system")
+        os.path.basename(name).startswith("system") or os.path.basename(name).startswith("bad")
         for name in HEADER_LIST + SOURCE_LIST
     )
 
@@ -55,5 +55,5 @@ def test_process_files():
 )
 def test_diff_files():
     """Test whether diff_files picks up the correct files."""
-    new_files = [os.path.basename(name) for name in diff_files("c8bda44")]
-    assert new_files == ["system_numpy.c"]
+    new_files = {os.path.basename(name) for name in diff_files("48eec70")}
+    assert new_files == {"myheader.h", "bad_extension.c", "good_extension.c"}