Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Pass the boolean parameter to the on_exit python binding
[simgrid.git] / src / bindings / python / simgrid_python.cpp
index a875f1e..206f1d0 100644 (file)
@@ -89,6 +89,10 @@ PYBIND11_MODULE(simgrid, m)
 
   py::register_exception<simgrid::NetworkFailureException>(m, "NetworkFailureException");
   py::register_exception<simgrid::TimeoutException>(m, "TimeoutException");
+  py::register_exception<simgrid::HostFailureException>(m, "HostFailureException");
+  py::register_exception<simgrid::StorageFailureException>(m, "StorageFailureException");
+  py::register_exception<simgrid::VmFailureException>(m, "VmFailureException");
+  py::register_exception<simgrid::CancelException>(m, "CancelException");
 
   /* this_actor namespace */
   m.def_submodule("this_actor", "Bindings of the s4u::this_actor namespace. See the C++ documentation for details.")
@@ -122,16 +126,18 @@ PYBIND11_MODULE(simgrid, m)
           [](py::object cb) {
             py::function fun = py::reinterpret_borrow<py::function>(cb);
             fun.inc_ref(); // FIXME: why is this needed for tests like actor-kill and actor-lifetime?
-            simgrid::s4u::this_actor::on_exit([fun](bool /*failed*/) {
+            simgrid::s4u::this_actor::on_exit([fun](bool failed) {
+              py::gil_scoped_acquire py_context; // need a new context for callback
               try {
-                py::gil_scoped_acquire py_context; // need a new context for callback
-                fun();
+                fun(failed);
               } catch (const py::error_already_set& e) {
                 xbt_die("Error while executing the on_exit lambda: %s", e.what());
               }
             });
           },
-          py::call_guard<py::gil_scoped_release>(), "")
+          py::call_guard<py::gil_scoped_release>(),
+          "Define a lambda to be called when the actor ends. It takes a bool parameter indicating whether the actor "
+          "was killed. If False, the actor finished peacefully.")
       .def("get_pid", &simgrid::s4u::this_actor::get_pid, "Retrieves PID of the current actor")
       .def("get_ppid", &simgrid::s4u::this_actor::get_ppid,
            "Retrieves PPID of the current actor (i.e., the PID of its parent).");
@@ -146,20 +152,55 @@ PYBIND11_MODULE(simgrid, m)
              return new simgrid::s4u::Engine(&argc, argv.data());
            }),
            "The constructor should take the parameters from the command line, as is ")
-      .def_static("get_clock", &Engine::get_clock,
-                  "The simulation time, ie the amount of simulated seconds since the simulation start.")
-      .def_static(
-          "instance", []() { return Engine::get_instance(); }, "Retrieve the simulation engine")
-      .def("get_all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
-      .def("get_all_links", &Engine::get_all_links, "Returns the list of all links found in the platform")
-
-      .def("get_netzone_root", &Engine::get_netzone_root, "Retrieve the root netzone, containing all others.")
-      .def("get_all_netpoints", &Engine::get_all_netpoints)
-      .def("get_netzone_root", &Engine::get_netzone_root)
+      .def_static("get_clock",
+                  []() // XBT_ATTRIB_DEPRECATED_v334
+                  {
+                    PyErr_WarnEx(PyExc_DeprecationWarning,
+                                 "get_clock() is deprecated and  will be dropped after v3.33, use clock instead.", 1);
+                    return Engine::get_clock();
+                  })
+      .def_property_readonly_static(
+          "clock", [](py::object /* self */) { return Engine::get_clock(); },
+          "The simulation time, ie the amount of simulated seconds since the simulation start.")
+      .def_property_readonly_static(
+          "instance", [](py::object /* self */) { return Engine::get_instance(); }, "Retrieve the simulation engine")
+      .def("get_all_hosts",
+           [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(PyExc_DeprecationWarning,
+                          "get_all_hosts() is deprecated and  will be dropped after v3.33, use all_hosts instead.", 1);
+             return self.attr("all_hosts");
+           })
+      .def_property_readonly("all_hosts", &Engine::get_all_hosts, "Returns the list of all hosts found in the platform")
+      .def("get_all_links",
+           [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(PyExc_DeprecationWarning,
+                          "get_all_links() is deprecated and  will be dropped after v3.33, use all_links instead.", 1);
+             return self.attr("all_links");
+           })
+      .def_property_readonly("all_links", &Engine::get_all_links, "Returns the list of all links found in the platform")
+      .def("get_all_netpoints",
+           [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(
+                 PyExc_DeprecationWarning,
+                 "get_all_netpoints() is deprecated and  will be dropped after v3.33, use all_netpoints instead.", 1);
+             return self.attr("all_netpoints");
+           })
+      .def_property_readonly("all_netpoints", &Engine::get_all_netpoints)
+      .def("get_netzone_root",
+           [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(PyExc_DeprecationWarning,
+                          "get_netzone_root() is deprecated and  will be dropped after v3.3, use netzone_root instead.",
+                          1);
+             return self.attr("netzone_root");
+           })
+      .def_property_readonly("netzone_root", &Engine::get_netzone_root,
+                             "Retrieve the root netzone, containing all others.")
       .def("netpoint_by_name", &Engine::netpoint_by_name_or_null)
       .def("netzone_by_name", &Engine::netzone_by_name_or_null)
-      .def("set_netzone_root", &Engine::set_netzone_root)
-
       .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
       .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
       .def("run", &Engine::run, py::call_guard<py::gil_scoped_release>(), "Run the simulation until its end")
@@ -170,8 +211,8 @@ PYBIND11_MODULE(simgrid, m)
           "register_actor",
           [](Engine* e, const std::string& name, py::object fun_or_class) {
             e->register_actor(name, [fun_or_class](std::vector<std::string> args) {
+              py::gil_scoped_acquire py_context;
               try {
-                py::gil_scoped_acquire py_context;
                 /* Convert the std::vector into a py::tuple */
                 py::tuple params(args.size() - 1);
                 for (size_t i = 1; i < args.size(); i++)
@@ -241,7 +282,15 @@ PYBIND11_MODULE(simgrid, m)
       .def("create_router", &simgrid::s4u::NetZone::create_router, "Create a router")
       .def("set_parent", &simgrid::s4u::NetZone::set_parent, "Set the parent of this zone")
       .def("set_property", &simgrid::s4u::NetZone::set_property, "Add a property to this zone")
-      .def("get_netpoint", &simgrid::s4u::NetZone::get_netpoint, "Retrieve the netpoint associated to this zone")
+      .def("get_netpoint",
+           [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(PyExc_DeprecationWarning,
+                          "get_netpoint() is deprecated and  will be dropped after v3.33, use netpoint instead.", 1);
+             return self.attr("netpoint");
+           })
+      .def_property_readonly("netpoint", &simgrid::s4u::NetZone::get_netpoint,
+                             "Retrieve the netpoint associated to this zone")
       .def("seal", &simgrid::s4u::NetZone::seal, "Seal this NetZone")
       .def_property_readonly(
           "name", [](const simgrid::s4u::NetZone* self) { return self->get_name(); },
@@ -312,12 +361,49 @@ PYBIND11_MODULE(simgrid, m)
           "   \"\"\"\n\n"
           "The second function parameter is the periodicity: the time to wait after the last event to start again over "
           "the list. Set it to -1 to not loop over.")
-      .def("get_pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
-      .def("get_pstate_speed", &Host::get_pstate_speed, "Retrieve the maximal speed at the given pstate")
-      .def("get_netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this host")
+      .def("get_pstate_count",
+           [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(
+                 PyExc_DeprecationWarning,
+                 "get_pstate_count() is deprecated and  will be dropped after v3.33, use pstate_count instead.", 1);
+             return self.attr("pstate_count");
+           })
+      .def_property_readonly("pstate_count", &Host::get_pstate_count, "Retrieve the count of defined pstate levels")
+      .def("get_pstate_speed",
+           [](py::object self, int state) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(
+                 PyExc_DeprecationWarning,
+                 "get_pstate_speed() is deprecated and  will be dropped after v3.33, use pstate_speed instead.", 1);
+             return self.attr("pstate_speed")(state);
+           })
+      .def("pstate_speed", &Host::get_pstate_speed, py::call_guard<py::gil_scoped_release>(),
+           "Retrieve the maximal speed at the given pstate")
+      .def("get_netpoint",
+           [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(PyExc_DeprecationWarning,
+                          "get_netpoint() is deprecated and  will be dropped after v3.33, use netpoint instead.", 1);
+             return self.attr("netpoint");
+           })
+      .def_property_readonly("netpoint", &Host::get_netpoint, "Retrieve the netpoint associated to this zone")
       .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
-      .def("set_core_count", &Host::set_core_count, py::call_guard<py::gil_scoped_release>(),
-           "Set the number of cores in the CPU")
+      .def("set_core_count",
+           [](py::object self, double count) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(PyExc_DeprecationWarning,
+                          "set_core_count() is deprecated and  will be dropped after v3.33, use core_count instead.",
+                          1);
+             self.attr("core_count")(count);
+           })
+      .def_property(
+          "core_count", &Host::get_core_count,
+          [](Host* h, int count) {
+            py::gil_scoped_release gil_guard;
+            return h->set_core_count(count);
+          },
+          "Manage the number of cores in the CPU")
       .def("set_coordinates", &Host::set_coordinates, py::call_guard<py::gil_scoped_release>(),
            "Set the coordinates of this host")
       .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, py::call_guard<py::gil_scoped_release>(),
@@ -359,8 +445,8 @@ PYBIND11_MODULE(simgrid, m)
           [](py::object cb) {
             Host::on_creation_cb([cb](Host& h) {
               py::function fun = py::reinterpret_borrow<py::function>(cb);
+              py::gil_scoped_acquire py_context; // need a new context for callback
               try {
-                py::gil_scoped_acquire py_context; // need a new context for callback
                 fun(&h);
               } catch (const py::error_already_set& e) {
                 xbt_die("Error while executing the on_creation lambda : %s", e.what());
@@ -515,8 +601,22 @@ PYBIND11_MODULE(simgrid, m)
   /* Class Split-Duplex Link */
   py::class_<simgrid::s4u::SplitDuplexLink, Link, std::unique_ptr<simgrid::s4u::SplitDuplexLink, py::nodelete>>(
       m, "SplitDuplexLink", "Network split-duplex link")
-      .def("get_link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
-      .def("get_link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
+      .def("get_link_up",
+           [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(PyExc_DeprecationWarning,
+                          "get_link_up() is deprecated and  will be dropped after v3.33, use link_up instead.", 1);
+             return self.attr("link_up");
+           })
+      .def_property_readonly("link_up", &simgrid::s4u::SplitDuplexLink::get_link_up, "Get link direction up")
+      .def("get_link_down",
+           [](py::object self) // XBT_ATTRIB_DEPRECATED_v334
+           {
+             PyErr_WarnEx(PyExc_DeprecationWarning,
+                          "get_link_down() is deprecated and  will be dropped after v3.33, use link_down instead.", 1);
+             return self.attr("link_down");
+           })
+      .def_property_readonly("link_down", &simgrid::s4u::SplitDuplexLink::get_link_down, "Get link direction down");
 
   /* Class Mailbox */
   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(
@@ -555,7 +655,7 @@ PYBIND11_MODULE(simgrid, m)
       .def(
           "get",
           [](Mailbox* self) {
-            py::object data = pybind11::reinterpret_steal<py::object>(self->get<PyObject>());
+            py::object data = py::reinterpret_steal<py::object>(self->get<PyObject>());
             // data.dec_ref(); // FIXME: why does it break python-actor-create?
             return data;
           },
@@ -645,8 +745,8 @@ PYBIND11_MODULE(simgrid, m)
             fun.inc_ref();  // FIXME: why is this needed for tests like exec-async, exec-dvfs and exec-remote?
             args.inc_ref(); // FIXME: why is this needed for tests like actor-migrate?
             return simgrid::s4u::Actor::create(name, h, [fun, args]() {
+              py::gil_scoped_acquire py_context;
               try {
-                py::gil_scoped_acquire py_context;
                 fun(*args);
               } catch (const py::error_already_set& ex) {
                 if (ex.matches(pyForcefulKillEx)) {