Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'fix_bindings_mistakenly_set_as_member_functions' into 'master'
[simgrid.git] / src / bindings / python / simgrid_python.cpp
index 3d2fa25..0b1721b 100644 (file)
@@ -24,7 +24,6 @@
 
 #include "simgrid/kernel/ProfileBuilder.hpp"
 #include "simgrid/kernel/routing/NetPoint.hpp"
-#include "src/kernel/context/Context.hpp"
 #include <simgrid/Exception.hpp>
 #include <simgrid/s4u/Actor.hpp>
 #include <simgrid/s4u/Comm.hpp>
@@ -100,6 +99,8 @@ PYBIND11_MODULE(simgrid, m)
           "debug", [](const char* s) { XBT_DEBUG("%s", s); }, "Display a logging message of 'debug' priority.")
       .def(
           "info", [](const char* s) { XBT_INFO("%s", s); }, "Display a logging message of 'info' priority.")
+      .def(
+          "warning", [](const char* s) { XBT_WARN("%s", s); }, "Display a logging message of 'warning' priority.")
       .def(
           "error", [](const char* s) { XBT_ERROR("%s", s); }, "Display a logging message of 'error' priority.")
       .def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
@@ -316,7 +317,7 @@ PYBIND11_MODULE(simgrid, m)
   /* Class Host */
   py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>> host(
       m, "Host", "Simulated host. See the C++ documentation for details.");
-  host.def("by_name", &Host::by_name, "Retrieves a host from its name, or die")
+  host.def_static("by_name", &Host::by_name, py::arg("name"), "Retrieves a host from its name, or die")
       .def(
           "route_to",
           [](const simgrid::s4u::Host* h, const simgrid::s4u::Host* to) {
@@ -422,7 +423,7 @@ PYBIND11_MODULE(simgrid, m)
             h->set_pstate(i);
           },
           "The current pstate (read/write property).")
-      .def("current", &Host::current, py::call_guard<py::gil_scoped_release>(),
+      .def_static("current", &Host::current, py::call_guard<py::gil_scoped_release>(),
            "Retrieves the host on which the running actor is located.")
       .def_property_readonly(
           "name",
@@ -441,7 +442,7 @@ PYBIND11_MODULE(simgrid, m)
                              "Get the available speed ratio, between 0 and 1.\n"
                              "This accounts for external load (see :py:func:`set_speed_profile() "
                              "<simgrid.Host.set_speed_profile>`) (read-only property).")
-      .def(
+      .def_static(
           "on_creation_cb",
           [](py::object cb) {
             Host::on_creation_cb([cb](Host& h) {
@@ -625,7 +626,10 @@ PYBIND11_MODULE(simgrid, m)
       .def(
           "__str__", [](const Mailbox* self) { return std::string("Mailbox(") + self->get_cname() + ")"; },
           "Textual representation of the Mailbox`")
-      .def("by_name", &Mailbox::by_name, py::call_guard<py::gil_scoped_release>(), "Retrieve a Mailbox from its name")
+      .def_static("by_name", &Mailbox::by_name,
+                  py::call_guard<py::gil_scoped_release>(),
+                  py::arg("name"),
+                  "Retrieve a Mailbox from its name")
       .def_property_readonly(
           "name",
           [](const Mailbox* self) {
@@ -653,6 +657,14 @@ PYBIND11_MODULE(simgrid, m)
             return self->put_async(data.ptr(), size);
           },
           py::call_guard<py::gil_scoped_release>(), "Non-blocking data transmission")
+      .def(
+          "put_init",
+          [](Mailbox* self, py::object data, int size) {
+            data.inc_ref();
+            return self->put_init(data.ptr(), size);
+          },
+          py::call_guard<py::gil_scoped_release>(),
+          "Creates (but don’t start) a data transmission to that mailbox.")
       .def(
           "get",
           [](Mailbox* self) {
@@ -689,19 +701,35 @@ PYBIND11_MODULE(simgrid, m)
       .def("wait", &simgrid::s4u::Comm::wait, py::call_guard<py::gil_scoped_release>(),
            "Block until the completion of that communication.")
       .def("wait_for", &simgrid::s4u::Comm::wait_for,
+           py::arg("timeout"),
            py::call_guard<py::gil_scoped_release>(),
            "Block until the completion of that communication, or raises TimeoutException after the specified timeout.")
+      .def("detach", [](simgrid::s4u::Comm* self) {
+              return self->detach();
+           },
+           py::return_value_policy::reference_internal,
+           py::call_guard<py::gil_scoped_release>(),
+           "Start the comm, and ignore its result. It can be completely forgotten after that.")
       // use py::overload_cast for wait_all/wait_any, until the overload marked XBT_ATTRIB_DEPRECATED_v332 is removed
       .def_static(
           "wait_all", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_all),
-          py::call_guard<py::gil_scoped_release>(), "Block until the completion of all communications in the list.")
+          py::arg("comms"),
+          py::call_guard<py::gil_scoped_release>(),
+          "Block until the completion of all communications in the list.")
+      .def_static("wait_all_for", &simgrid::s4u::Comm::wait_all_for,
+                  py::arg("comms"), py::arg("timeout"),
+                  py::call_guard<py::gil_scoped_release>(),
+                  "Block until the completion of all communications in the list, or raises TimeoutException after "
+                  "the specified timeout.")
       .def_static(
           "wait_any", py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&>(&simgrid::s4u::Comm::wait_any),
+          py::arg("comms"),
           py::call_guard<py::gil_scoped_release>(),
           "Block until the completion of any communication in the list and return the index of the terminated one.")
       .def_static(
           "wait_any_for",
           py::overload_cast<const std::vector<simgrid::s4u::CommPtr>&, double>(&simgrid::s4u::Comm::wait_any_for),
+          py::arg("comms"), py::arg("timeout"),
           py::call_guard<py::gil_scoped_release>(),
           "Block until the completion of any communication in the list and return the index of the terminated "
           "one, or -1 if a timeout occurred."
@@ -786,7 +814,7 @@ PYBIND11_MODULE(simgrid, m)
       .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor (read-only property).")
       .def_property_readonly("ppid", &Actor::get_ppid,
                              "The PID (unique identifier) of the actor that created this one (read-only property).")
-      .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
+      .def_static("by_pid", &Actor::by_pid, py::arg("pid"), "Retrieve an actor by its PID")
       .def("set_auto_restart", &Actor::set_auto_restart, py::call_guard<py::gil_scoped_release>(),
            "Specify whether the actor shall restart when its host reboots.")
       .def("daemonize", &Actor::daemonize, py::call_guard<py::gil_scoped_release>(),
@@ -798,11 +826,11 @@ PYBIND11_MODULE(simgrid, m)
       .def("join", py::overload_cast<double>(&Actor::join, py::const_), py::call_guard<py::gil_scoped_release>(),
            "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
       .def("kill", &Actor::kill, py::call_guard<py::gil_scoped_release>(), "Kill that actor")
-      .def("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(), "Kill all actors but the caller.")
       .def("self", &Actor::self, "Retrieves the current actor.")
       .def("is_suspended", &Actor::is_suspended, "Returns True if that actor is currently suspended.")
       .def("suspend", &Actor::suspend, py::call_guard<py::gil_scoped_release>(),
            "Suspend that actor, that is blocked until resume()ed by another actor.")
       .def("resume", &Actor::resume, py::call_guard<py::gil_scoped_release>(),
-           "Resume that actor, that was previously suspend()ed.");
+           "Resume that actor, that was previously suspend()ed.")
+      .def_static("kill_all", &Actor::kill_all, py::call_guard<py::gil_scoped_release>(), "Kill all actors but the caller.");
 }