ignore duplicate bind_vector/bind_map declarations

wjakob · Jun 3, 2023 · 2c9124b · 2c9124b
1 parent f3b0e6c
commit 2c9124b
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/docs/api_extra.rst b/docs/api_extra.rst
@@ -243,6 +243,9 @@ include directive:
    not comparable or copy-assignable, some of these functions will not be
    generated.
 
+   The binding operation is a no-op if the vector type has already been
+   registered with nanobind.
+
 .. _map_bindings:
 
 STL map bindings
@@ -308,6 +311,9 @@ nanobind API and require an additional include directive:
       * - ``items(self, arg: Map) -> Map.ItemView``
         - Returns an iterable view of the map's items
 
+   The binding operation is a no-op if the map type has already been
+   registered with nanobind.
+
 Unique pointer deleter
 ----------------------
 

diff --git a/include/nanobind/stl/bind_map.h b/include/nanobind/stl/bind_map.h
@@ -42,6 +42,12 @@ class_<Map> bind_map(handle scope, const char *name, Args &&...args) {
     using Key = typename Map::key_type;
     using Value = typename Map::mapped_type;
 
+    handle cl_cur = type<Map>();
+    if (cl_cur.is_valid()) {
+        // Binding already exists, don't re-create
+        return borrow<class_<Map>>(cl_cur);
+    }
+
     auto cl = class_<Map>(scope, name, std::forward<Args>(args)...)
         .def(init<>(),
              "Default constructor")

diff --git a/include/nanobind/stl/bind_vector.h b/include/nanobind/stl/bind_vector.h
@@ -48,6 +48,12 @@ class_<Vector> bind_vector(handle scope, const char *name, Args &&...args) {
     using ValueRef = typename detail::iterator_access<typename Vector::iterator>::result_type;
     using Value = std::decay_t<ValueRef>;
 
+    handle cl_cur = type<Vector>();
+    if (cl_cur.is_valid()) {
+        // Binding already exists, don't re-create
+        return borrow<class_<Vector>>(cl_cur);
+    }
+
     auto cl = class_<Vector>(scope, name, std::forward<Args>(args)...)
         .def(init<>(), "Default constructor")
 

diff --git a/tests/test_stl_bind_vector.cpp b/tests/test_stl_bind_vector.cpp
@@ -8,6 +8,9 @@ NB_MODULE(test_bind_vector_ext, m) {
     nb::bind_vector<std::vector<unsigned int>>(m, "VectorInt");
     nb::bind_vector<std::vector<bool>>(m, "VectorBool");
 
+    // Ensure that a repeated binding call is ignored
+    nb::bind_vector<std::vector<bool>>(m, "VectorBool");
+
     struct El {
         explicit El(int v) : a(v) {}
         int a;