Rename pybind11_local_bindings to pybind11_cross_module_tests

Author: jagerman

tests/CMakeLists.txt

@@ -68,6 +68,13 @@ endif()
 
 string(REPLACE ".cpp" ".py" PYBIND11_PYTEST_FILES "${PYBIND11_TEST_FILES}")
 
+# Contains the set of test files that require pybind11_cross_module_tests to be
+# built; if none of these are built (i.e. because TEST_OVERRIDE is used and
+# doesn't include them) the second module doesn't get built.
+set(PYBIND11_CROSS_MODULE_TESTS
+  test_local_bindings.cpp
+)
+
 # Check if Eigen is available; if not, remove from PYBIND11_TEST_FILES (but
 # keep it in PYBIND11_PYTEST_FILES, so that we get the "eigen is not installed"
 # skip message).
@@ -122,12 +129,15 @@ function(pybind11_enable_warnings target_name)
 endfunction()
 
 set(test_targets pybind11_tests)
-# If test_local_bindings is being built in pybind11_tests.so we'll also build
-# a separate module pybind11_local_bindings.so for the test:
-list(FIND PYBIND11_TEST_FILES test_local_bindings.cpp test_local_i)
-if (test_local_i GREATER -1)
-  list(APPEND test_targets pybind11_local_bindings)
-endif()
+
+# If any tests are being built that require pybind11_cross_module_tests, add it
+# to test_targets:
+foreach(t ${PYBIND11_CROSS_MODULE_TESTS})
+  list(FIND PYBIND11_TEST_FILES ${t} i)
+  if (i GREATER -1)
+    list(APPEND test_targets pybind11_cross_module_tests)
+  endif()
+endforeach()
 
 set(testdir ${CMAKE_CURRENT_SOURCE_DIR})
 foreach(tgt ${test_targets})

tests/pybind11_local_bindings.cpp renamed to tests/pybind11_cross_module_tests.cpp

@@ -1,5 +1,5 @@
 /*
-    tests/pybind11_local_bindings.cpp -- counterpart to test_local_bindings.cpp
+    tests/pybind11_cross_module_tests.cpp -- contains tests that require multiple modules
 
     Copyright (c) 2017 Jason Rhinelander <[email protected]>
 
@@ -11,9 +11,11 @@
 #include "local_bindings.h"
 #include <pybind11/stl_bind.h>
 
-PYBIND11_MODULE(pybind11_local_bindings, m) {
-    m.doc() = "pybind11 local bindings test module";
+PYBIND11_MODULE(pybind11_cross_module_tests, m) {
+    m.doc() = "pybind11 cross-module test module";
 
+    // test_local_bindings.py tests:
+    //
     // Definitions here are tested by importing both this module and the
     // pybind11_tests.local_bindings submodule from test_local_bindings.py
 

tests/test_local_bindings.cpp

@@ -24,7 +24,7 @@ TEST_SUBMODULE(local_bindings, m) {
 
     // test_nonlocal_failure
     // The main pybind11 test module is loaded first, so this registration will succeed (the second
-    // one, in pybind11_local_bindings.cpp, is designed to fail):
+    // one, in pybind11_cross_module_tests.cpp, is designed to fail):
     bind_local<NonLocalType, 0>(m, "NonLocalType")
         .def(py::init<int>())
         .def("get", [](LocalType &i) { return i.i; })

tests/test_local_bindings.py

@@ -7,7 +7,7 @@ def test_local_bindings():
     """Tests that duplicate py::local class bindings work across modules"""
 
     # Make sure we can load the second module with the conflicting (but local) definition:
-    import pybind11_local_bindings as m2
+    import pybind11_cross_module_tests as m2
 
     i1 = m1.LocalType(5)
 
@@ -35,7 +35,7 @@ def test_local_bindings():
 
 def test_nonlocal_failure():
     """Tests that attempting to register a non-local type in multiple modules fails"""
-    import pybind11_local_bindings as m2
+    import pybind11_cross_module_tests as m2
 
     with pytest.raises(RuntimeError) as excinfo:
         m2.register_nonlocal()
@@ -53,7 +53,7 @@ def test_duplicate_local():
 
 
 def test_stl_bind_local():
-    import pybind11_local_bindings as m2
+    import pybind11_cross_module_tests as m2
 
     v1, v2 = m1.LocalVec(), m2.LocalVec()
     v1.append(m1.LocalType(1))
@@ -88,7 +88,7 @@ def test_stl_bind_local():
 
 
 def test_stl_bind_global():
-    import pybind11_local_bindings as m2
+    import pybind11_cross_module_tests as m2
 
     with pytest.raises(RuntimeError) as excinfo:
         m2.register_nonlocal_map()
@@ -105,5 +105,5 @@ def test_stl_bind_global():
 
 def test_internal_locals_differ():
     """Makes sure the internal local type map differs across the two modules"""
-    import pybind11_local_bindings as m2
+    import pybind11_cross_module_tests as m2
     assert m1.local_cpp_types_addr() != m2.local_cpp_types_addr()