add nb::globals

docs/changelog.rst

@@ -15,6 +15,13 @@ case, both modules must use the same nanobind ABI version, or they will be
 isolated from each other. Releases that don't explicitly mention an ABI version
 below inherit that of the preceding release.
 
+Version 1.6.2 (TBA)
+-------------------
+
+* Added :cpp:func:`nb::globals() <globals>`. (PR `#311
+  <https://github.com/wjakob/nanobind/pull/311>`__).
+
+
 Version 1.6.1 (Oct 2, 2023)
 -------------------
 

include/nanobind/nb_misc.h

@@ -39,4 +39,12 @@ inline void set_implicit_cast_warnings(bool value) noexcept {
     detail::set_implicit_cast_warnings(value);
 }
 
+/// \ingroup python_builtins
+/// Return a dictionary representing the global variables in the current execution frame,
+/// or ``__main__.__dict__`` if there is no frame.
+inline dict globals() {
+    PyObject *p = PyEval_GetGlobals();
+    return borrow<dict>(p ? p : module_::import_("__main__").attr("__dict__").ptr());
+}
+
 NAMESPACE_END(NB_NAMESPACE)

tests/test_globals.cpp

@@ -0,0 +1,15 @@
+#include <nanobind/nanobind.h>
+
+namespace nb = nanobind;
+
+NB_MODULE(test_eval_ext, m) {
+    m.def("globals_contains_a", []() {
+        return nb::globals().contains("a");
+    });
+
+    m.def("globals_add_b", []() {
+        auto globals = nb::globals();
+        globals["b"] = 123;
+        return globals;
+    });
+}

tests/test_globals.py

@@ -0,0 +1,10 @@
+
+def test_read_globals():
+    a = 1
+    assert m.globals_contains_a()
+
+
+def test_write_globals():
+    assert "b" not in globals()
+    m.globals_add_b()
+    assert globals()["b"] == 123