simplify routing pybind11 wrapping

Author: lperron

ortools/routing/docs/ROUTING.md

@@ -103,6 +103,7 @@ int main(int argc, char* argv[]) {
 """Vehicle Routing example."""
 
 
+from ortools.routing import enums_pb2
 from ortools.routing.python import routing
 
 
@@ -137,7 +138,7 @@ def main() -> None:
   # Setting first solution heuristic.
   search_parameters = routing.default_routing_search_parameters()
   search_parameters.first_solution_strategy = (
-      routing.FirstSolutionStrategy.PATH_CHEAPEST_ARC
+      enums_pb2.FirstSolutionStrategy.PATH_CHEAPEST_ARC
   )  # pylint: disable=no-member
 
   # Solve the problem.

ortools/routing/python/BUILD.bazel

@@ -15,7 +15,6 @@
 
 load("@pip_deps//:requirements.bzl", "requirement")
 load("@pybind11_bazel//:build_defs.bzl", "pybind_extension")
-load("@rules_cc//cc:cc_binary.bzl", "cc_binary")
 load("@rules_cc//cc:cc_library.bzl", "cc_library")
 load("@rules_python//python:py_test.bzl", "py_test")
 
@@ -28,45 +27,12 @@ cc_library(
     ],
 )
 
-cc_binary(
-    name = "gen_proto_builder_pybind11",
-    srcs = ["gen_proto_builder_pybind11.cc"],
-    deps = [
-        "//ortools/base",
-        "//ortools/constraint_solver:search_stats_cc_proto",
-        "//ortools/constraint_solver:solver_parameters_cc_proto",
-        "//ortools/routing:enums_cc_proto",
-        "//ortools/routing:heuristic_parameters_cc_proto",
-        "//ortools/routing:ils_cc_proto",
-        "//ortools/routing:parameters_cc_proto",
-        "//ortools/util/python:wrappers",
-        "@abseil-cpp//absl/flags:parse",
-        "@abseil-cpp//absl/flags:usage",
-        "@abseil-cpp//absl/log:die_if_null",
-        "@abseil-cpp//absl/log:initialize",
-        "@abseil-cpp//absl/strings:str_format",
-    ],
-)
-
-genrule(
-    name = "run_gen_proto_builder_pybind11",
-    outs = ["proto_builder_pybind11.h"],
-    cmd = "$(location :gen_proto_builder_pybind11) > $@",
-    tools = [":gen_proto_builder_pybind11"],
-)
-
-cc_library(
-    name = "proto_builder_pybind11",
-    hdrs = ["proto_builder_pybind11.h"],
-)
-
 pybind_extension(
     name = "routing",
     srcs = ["routing.cc"],
     visibility = ["//visibility:public"],
     deps = [
         ":doc",
-        ":proto_builder_pybind11",
         "//ortools/constraint_solver:cp",
         "//ortools/constraint_solver:search_stats_cc_proto",
         "//ortools/constraint_solver:solver_parameters_cc_proto",
@@ -87,6 +53,7 @@ pybind_extension(
         "@abseil-cpp//absl/container:flat_hash_set",
         "@protobuf//:duration_cc_proto",
         "@pybind11_abseil//pybind11_abseil:absl_casters",
+        "@pybind11_protobuf//pybind11_protobuf:native_proto_caster",
     ],
 )
 
@@ -98,6 +65,7 @@ py_test(
         ":routing",
         requirement("absl-py"),
         "//ortools/constraint_solver/python:constraint_solver",
+        "//ortools/constraint_solver:search_stats_py_pb2",
         "//ortools/routing:enums_py_pb2",
         "//ortools/routing:parameters_py_pb2",
     ],
@@ -111,6 +79,7 @@ py_test(
         ":routing",
         requirement("absl-py"),
         "//ortools/routing:enums_py_pb2",
+        "//ortools/routing:parameters_py_pb2",  # keep
     ],
 )
 
@@ -132,6 +101,7 @@ py_test(
         ":routing",
         requirement("absl-py"),
         "//ortools/routing:enums_py_pb2",
+        "//ortools/routing:parameters_py_pb2",  # keep
         "//ortools/util:optional_boolean_py_pb2",
         "//ortools/util/python:sorted_interval_list",
     ],

ortools/routing/python/CMakeLists.txt

@@ -11,44 +11,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# routing_gen_proto_builder_pybind11 code generator.
-add_executable(routing_gen_proto_builder_pybind11)
-target_sources(routing_gen_proto_builder_pybind11 PRIVATE "gen_proto_builder_pybind11.cc")
-target_include_directories(routing_gen_proto_builder_pybind11 PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
-target_compile_features(routing_gen_proto_builder_pybind11 PRIVATE cxx_std_17)
-target_link_libraries(routing_gen_proto_builder_pybind11 PRIVATE
-  absl::flags_commandlineflag
-  absl::flags_parse
-  absl::flags_usage
-  absl::die_if_null
-  absl::str_format
-  protobuf::libprotobuf
-  ${PROJECT_NAMESPACE}::ortools_proto
-  ${PROJECT_NAMESPACE}::routing_proto
-  ${PROJECT_NAMESPACE}::util_python_wrappers)
-
-include(GNUInstallDirs)
-if(APPLE)
-  set_target_properties(routing_gen_proto_builder_pybind11 PROPERTIES INSTALL_RPATH
-    "@loader_path/../${CMAKE_INSTALL_LIBDIR};@loader_path")
-elseif(UNIX)
-  cmake_path(RELATIVE_PATH CMAKE_INSTALL_FULL_LIBDIR
-             BASE_DIRECTORY ${CMAKE_INSTALL_FULL_BINDIR}
-             OUTPUT_VARIABLE libdir_relative_path)
-  set_target_properties(routing_gen_proto_builder_pybind11 PROPERTIES
-                        INSTALL_RPATH "$ORIGIN/${libdir_relative_path}")
-endif()
-
-install(TARGETS routing_gen_proto_builder_pybind11)
-
-add_custom_command(
-     OUTPUT proto_builder_pybind11.h
-     COMMAND routing_gen_proto_builder_pybind11 > proto_builder_pybind11.h
-     COMMENT "Generate C++ proto_builder_pybind11.h"
-     VERBATIM)
-
 # routing
-pybind11_add_module(routing_pybind11 MODULE routing.cc proto_builder_pybind11.h)
+pybind11_add_module(routing_pybind11 MODULE routing.cc)
 set_target_properties(routing_pybind11 PROPERTIES
   LIBRARY_OUTPUT_NAME "routing")
 
@@ -65,6 +29,7 @@ endif()
 target_link_libraries(routing_pybind11 PRIVATE
   ${PROJECT_NAMESPACE}::ortools
   pybind11_abseil::absl_casters
+  pybind11_native_proto_caster  
 )
 add_library(${PROJECT_NAMESPACE}::routing_pybind11 ALIAS routing_pybind11)
 

ortools/routing/python/dimension_test.py

@@ -18,10 +18,11 @@
 
 from absl.testing import absltest
 
+from ortools.routing import enums_pb2
 from ortools.routing.python import routing
 
-FirstSolutionStrategy = routing.FirstSolutionStrategy
-RoutingSearchStatus = routing.RoutingSearchStatus
+FirstSolutionStrategy = enums_pb2.FirstSolutionStrategy
+RoutingSearchStatus = enums_pb2.RoutingSearchStatus
 
 
 def distance(node_i: int, node_j: int) -> int:

ortools/routing/python/gen_proto_builder_pybind11.cc

@@ -19,7 +19,6 @@
 from absl.testing import absltest
 from ortools.constraint_solver import pywrapcp
 from ortools.routing import enums_pb2
-from ortools.routing import parameters_pb2
 from ortools.routing import pywraprouting
 from ortools.util import optional_boolean_pb2
 

ortools/routing/python/pywraprouting_test.py

@@ -45,6 +45,7 @@
 #include "pybind11/pybind11.h"
 #include "pybind11/stl.h"
 #include "pybind11_abseil/absl_casters.h"
+#include "pybind11_protobuf/native_proto_caster.h"
 
 namespace py = ::pybind11;
 
@@ -59,14 +60,12 @@ using ::operations_research::routing::RoutingModelParameters;
 using ::operations_research::routing::RoutingSearchParameters;
 
 PYBIND11_MODULE(routing, m) {
+  pybind11_protobuf::ImportNativeProtoCasters();
+
   pybind11::module::import(
       "ortools.constraint_solver.python.constraint_solver");
   pybind11::module::import("ortools.util.python.sorted_interval_list");
 
-#define IMPORT_PROTO_WRAPPER_CODE
-#include "ortools/routing/python/proto_builder_pybind11.h"
-#undef IMPORT_PROTO_WRAPPER_CODE
-
   m.def("default_routing_model_parameters", &DefaultRoutingModelParameters,
         DOC(operations_research, routing, DefaultRoutingModelParameters));
 

ortools/routing/python/routing.cc

@@ -17,13 +17,16 @@
 import functools
 
 from absl.testing import absltest
+from google.protobuf import text_format
 
 from ortools.constraint_solver.python import constraint_solver
+from ortools.routing import enums_pb2
+from ortools.routing import parameters_pb2
 from ortools.routing.python import routing
 
-FirstSolutionStrategy = routing.FirstSolutionStrategy
-RoutingSearchStatus = routing.RoutingSearchStatus
-RoutingSearchParameters = routing.RoutingSearchParameters
+FirstSolutionStrategy = enums_pb2.FirstSolutionStrategy
+RoutingSearchStatus = enums_pb2.RoutingSearchStatus
+RoutingSearchParameters = parameters_pb2.RoutingSearchParameters
 
 
 def distance(node_i: int, node_j: int) -> int:
@@ -354,9 +357,10 @@ def test_disjunction_penalty_tsp(self) -> None:
     def test_routing_model_parameters(self) -> None:
         # Create routing model with parameters
         parameters = routing.default_routing_model_parameters()
-        parameters.solver_parameters.parse_text_format(
-            str(constraint_solver.Solver.default_solver_parameters())
-        )
+        # text_format.Parse(
+        #     str(constraint_solver.Solver.default_solver_parameters()),
+        #     parameters.solver_parameters,
+        # )
         parameters.solver_parameters.trace_propagation = True
         manager = routing.IndexManager(10, 1, 0)
         self.assertIsNotNone(manager)