Improve the rendering of enums in the documentation (colmap#2966)

zhan994 · Nov 29, 2024 · e778be6 · e778be6
1 parent 256639d
commit e778be6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/src/pycolmap/helpers.h b/src/pycolmap/helpers.h
@@ -44,7 +44,8 @@ void AddStringToEnumConstructor(py::enum_<T>& enm) {
   enm.def(py::init([enm](const std::string& value) {
             return PyStringToEnum(enm, py::str(value));  // str constructor
           }),
-          "value"_a);
+          "name"_a);
+  enm.attr("__repr__") = enm.attr("__str__");
   py::implicitly_convertible<std::string, T>();
 }
 

diff --git a/src/pycolmap/scene/two_view_geometry.cc b/src/pycolmap/scene/two_view_geometry.cc
@@ -16,9 +16,9 @@ using namespace pybind11::literals;
 namespace py = pybind11;
 
 void BindTwoViewGeometryScene(py::module& m) {
-  py::enum_<TwoViewGeometry::ConfigurationType>(m,
-                                                "TwoViewGeometryConfiguration")
-      .value("UNDEFINED", TwoViewGeometry::UNDEFINED)
+  py::enum_<TwoViewGeometry::ConfigurationType> PyTwoViewGeometryConfiguration(
+      m, "TwoViewGeometryConfiguration");
+  PyTwoViewGeometryConfiguration.value("UNDEFINED", TwoViewGeometry::UNDEFINED)
       .value("DEGENERATE", TwoViewGeometry::DEGENERATE)
       .value("CALIBRATED", TwoViewGeometry::CALIBRATED)
       .value("UNCALIBRATED", TwoViewGeometry::UNCALIBRATED)
@@ -27,6 +27,7 @@ void BindTwoViewGeometryScene(py::module& m) {
       .value("PLANAR_OR_PANORAMIC", TwoViewGeometry::PLANAR_OR_PANORAMIC)
       .value("WATERMARK", TwoViewGeometry::WATERMARK)
       .value("MULTIPLE", TwoViewGeometry::MULTIPLE);
+  AddStringToEnumConstructor(PyTwoViewGeometryConfiguration);
 
   py::class_<TwoViewGeometry> PyTwoViewGeometry(m, "TwoViewGeometry");
   PyTwoViewGeometry.def(py::init<>())