bind_vector/map: implemented __repr__ function, fixed api<T> in-place ops

Author: wjakob

include/nanobind/nb_lib.h

@@ -419,9 +419,16 @@ NB_CORE void set_implicit_cast_warnings(bool value) noexcept;
 
 NB_CORE bool iterable_check(PyObject *o) noexcept;
 
+// ========================================================================
+
 NB_CORE void slice_compute(PyObject *slice, Py_ssize_t size,
                            Py_ssize_t &start, Py_ssize_t &stop,
                            Py_ssize_t &step, size_t &slice_length);
 
+// ========================================================================
+
+NB_CORE PyObject *repr_list(PyObject *o);
+NB_CORE PyObject *repr_map(PyObject *o);
+
 NAMESPACE_END(detail)
 NAMESPACE_END(NB_NAMESPACE)

include/nanobind/nb_types.h

@@ -51,6 +51,10 @@ public:                                                                        \
             detail::obj_op_2(derived().ptr(), o.derived().ptr(), op));         \
     }
 
+#define NB_API_OP_2_IO(name)                                                   \
+    template <typename T> NB_INLINE decltype(auto) name(const api<T> &o) {     \
+        return operator=(handle::name(o));                                     \
+    }
 
 // A few forward declarations
 class object;
@@ -220,6 +224,16 @@ class object : public handle {
         temp.dec_ref();
         return *this;
     }
+
+    NB_API_OP_2_IO(operator+=)
+    NB_API_OP_2_IO(operator-=)
+    NB_API_OP_2_IO(operator*=)
+    NB_API_OP_2_IO(operator/=)
+    NB_API_OP_2_IO(operator|=)
+    NB_API_OP_2_IO(operator&=)
+    NB_API_OP_2_IO(operator^=)
+    NB_API_OP_2_IO(operator<<=)
+    NB_API_OP_2_IO(operator>>=)
 };
 
 template <typename T> NB_INLINE T borrow(handle h) {
@@ -670,3 +684,4 @@ NAMESPACE_END(NB_NAMESPACE)
 #undef NB_API_OP_1
 #undef NB_API_OP_2
 #undef NB_API_OP_2_I
+#undef NB_API_OP_2_IO

include/nanobind/stl/bind_map.h

@@ -52,6 +52,11 @@ class_<Map> bind_map(handle scope, const char *name, Args &&...args) {
              [](const Map &m) { return !m.empty(); },
              "Check whether the map is nonempty")
 
+        .def("__repr__",
+             [](handle_t<Map> h) {
+                return steal<str>(detail::repr_map(h.ptr()));
+             })
+
         .def("__contains__",
              [](const Map &m, const Key &k) { return m.find(k) != m.end(); })
 

include/nanobind/stl/bind_vector.h

@@ -57,6 +57,11 @@ class_<Vector> bind_vector(handle scope, const char *name, Args &&...args) {
              [](const Vector &v) { return !v.empty(); },
              "Check whether the vector is nonempty")
 
+        .def("__repr__",
+             [](handle_t<Vector> h) {
+                return steal<str>(detail::repr_list(h.ptr()));
+             })
+
         .def("__iter__",
              [](Vector &v) {
                  return make_iterator(type<Vector>(), "Iterator",

src/common.cpp

@@ -962,5 +962,34 @@ bool iterable_check(PyObject *o) noexcept {
 #endif
 }
 
+// ========================================================================
+
+NB_CORE PyObject *repr_list(PyObject *o) {
+    object s = steal(nb_inst_name(o));
+    s += str("([");
+    size_t len = obj_len(o);
+    for (size_t i = 0; i < len; ++i) {
+        s += repr(handle(o)[i]);
+        if (i + 1 < len)
+            s += str(", ");
+    }
+    s += str("])");
+    return s.release().ptr();
+}
+
+NB_CORE PyObject *repr_map(PyObject *o) {
+    object s = steal(nb_inst_name(o));
+    s += str("({");
+    bool first = true;
+    for (handle kv : handle(o).attr("items")()) {
+        if (!first)
+            s += str(", ");
+        s += repr(kv[0]) + str(": ") + repr(kv[1]);
+        first = false;
+    }
+    s += str("})");
+    return s.release().ptr();
+}
+
 NAMESPACE_END(detail)
 NAMESPACE_END(NB_NAMESPACE)

tests/test_stl_bind_map.py

@@ -34,6 +34,7 @@ def test_map_string_double():
     assert len(mm2) == 1
     mm2.clear()
     assert len(mm2) == 0
+    assert repr(mm) == "test_bind_map_ext.MapStringDouble({'a': 1.0, 'b': 2.5})"
 
     with pytest.warns(RuntimeWarning, match="implicit conversion from type 'dict' to type 'test_bind_map_ext.MapStringDouble' failed"):
         with pytest.raises(TypeError):
@@ -80,7 +81,6 @@ def test_map_string_double():
     assert list(um.keys()) == list(um)
     assert sorted(list(um.items())) == [("ua", 1.1), ("ub", 2.6)]
     assert list(zip(um.keys(), um.values())) == list(um.items())
-    assert "UnorderedMapStringDouble" in str(um)
 
     assert type(keys).__qualname__ == 'MapStringDouble.KeyView'
     assert type(values).__qualname__ == 'MapStringDouble.ValueView'

tests/test_stl_bind_vector.py

@@ -10,6 +10,7 @@ def test01_vector_int():
     # test construction from a generator
     v_int1 = t.VectorInt(x for x in range(5))
     assert t.VectorInt(v_int1) == t.VectorInt([0, 1, 2, 3, 4])
+    assert repr(v_int1) == "test_bind_vector_ext.VectorInt([0, 1, 2, 3, 4])"
 
     v_int2 = t.VectorInt([0, 0])
     assert v_int == v_int2
@@ -121,8 +122,6 @@ def check_del(s):
         del l1c[s]
         del l2c[s]
         l2c = list(l2c)
-        print(repr(l1c))
-        print(repr(l2c))
         assert l1c == l2c
 
     check_same(slice(1, 13, 4))