Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Constify pointer and reference parameters in src/bindings/.
[simgrid.git] / src / bindings / python / simgrid_python.cpp
index 4b70a2d..1f3acfd 100644 (file)
 #include <simgrid/Exception.hpp>
 #include <simgrid/s4u/Actor.hpp>
 #include <simgrid/s4u/Comm.hpp>
-#include <simgrid/s4u/Exec.hpp>
 #include <simgrid/s4u/Engine.hpp>
+#include <simgrid/s4u/Exec.hpp>
 #include <simgrid/s4u/Host.hpp>
 #include <simgrid/s4u/Mailbox.hpp>
+#include <simgrid/version.h>
 
 #include <memory>
 #include <string>
@@ -43,7 +44,7 @@ using simgrid::s4u::Mailbox;
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(python, "python");
 
-PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>);
+PYBIND11_DECLARE_HOLDER_TYPE(T, boost::intrusive_ptr<T>)
 
 namespace {
 
@@ -62,7 +63,6 @@ static std::string simgrid_version = get_simgrid_version();
 
 PYBIND11_MODULE(simgrid, m)
 {
-
   m.doc() = "SimGrid userspace API";
 
   m.attr("simgrid_version") = simgrid_version;
@@ -83,8 +83,9 @@ PYBIND11_MODULE(simgrid, m)
          py::arg("flops"), py::arg("priority") = 1);
   m2.def("exec_init", [](double flops){return simgrid::s4u::this_actor::exec_init(flops);});
   m2.def("get_host", &simgrid::s4u::this_actor::get_host, "Retrieves host on which the current actor is located");
-  m2.def("migrate", &simgrid::s4u::this_actor::migrate, "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::migrate()`",
-      py::arg("dest"));
+  m2.def("set_host", &simgrid::s4u::this_actor::set_host,
+         "Moves the current actor to another host, see :cpp:func:`void simgrid::s4u::this_actor::set_host()`",
+         py::arg("dest"));
   m2.def("sleep_for", sleep_for_fun,
       "Block the actor sleeping for that amount of seconds, see :cpp:func:`void simgrid::s4u::this_actor::sleep_for`", py::arg("duration"));
   m2.def("sleep_until", sleep_until_fun,
@@ -99,7 +100,7 @@ PYBIND11_MODULE(simgrid, m)
            simgrid::s4u::this_actor::on_exit([act, fun](bool /*failed*/) {
              try {
                fun();
-             } catch (py::error_already_set& e) {
+             } catch (const py::error_already_set& e) {
                xbt_die("Error while executing the on_exit lambda: %s", e.what());
              }
            });
@@ -140,7 +141,7 @@ PYBIND11_MODULE(simgrid, m)
                  /* If I was passed a class, I just built an instance, so I need to call it now */
                  if (py::isinstance<py::function>(res))
                    res();
-               } catch (py::error_already_set& ex) {
+               } catch (const py::error_already_set& ex) {
                  if (ex.matches(pyForcefulKillEx)) {
                    XBT_VERB("Actor killed");
                    /* Stop here that ForcefulKill exception which was meant to free the RAII stuff on the stack */
@@ -160,7 +161,7 @@ PYBIND11_MODULE(simgrid, m)
       .def_property("pstate", &Host::get_pstate, &Host::set_pstate, "The current pstate")
 
       .def("current", &Host::current, "Retrieves the host on which the running actor is located, see :cpp:func:`simgrid::s4u::Host::current()`")
-      .def_property_readonly("name", [](Host* self) -> const std::string {
+      .def_property_readonly("name", [](const Host* self) -> const std::string {
           return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
         }, "The name of this host")
       .def_property_readonly("load", &Host::get_load,
@@ -170,11 +171,11 @@ PYBIND11_MODULE(simgrid, m)
 
   /* Class Mailbox */
   py::class_<simgrid::s4u::Mailbox, std::unique_ptr<Mailbox, py::nodelete>>(m, "Mailbox", "Mailbox, see :ref:`class s4u::Mailbox <API_s4u_Mailbox>`")
-      .def("__str__", [](Mailbox* self) -> const std::string {
+      .def("__str__", [](const Mailbox* self) -> const std::string {
          return std::string("Mailbox(") + self->get_cname() + ")";
       }, "Textual representation of the Mailbox`")
       .def("by_name", &Mailbox::by_name, "Retrieve a Mailbox from its name, see :cpp:func:`simgrid::s4u::Mailbox::by_name()`")
-      .def_property_readonly("name", [](Mailbox* self) -> const std::string {
+      .def_property_readonly("name", [](const Mailbox* self) -> const std::string {
          return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC
       }, "The name of that mailbox, see :cpp:func:`simgrid::s4u::Mailbox::get_name()`")
       .def("put", [](Mailbox* self, py::object data, int size) {
@@ -232,15 +233,12 @@ PYBIND11_MODULE(simgrid, m)
   py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor",
                                             "An actor is an independent stream of execution in your distributed "
                                             "application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
-
       .def("create",
            [](py::str name, py::object host, py::object fun, py::args args) {
-
              return simgrid::s4u::Actor::create(name, host.cast<Host*>(), [fun, args]() {
-
                try {
                  fun(*args);
-               } catch (py::error_already_set& ex) {
+               } catch (const py::error_already_set& ex) {
                  if (ex.matches(pyForcefulKillEx)) {
                    XBT_VERB("Actor killed");
                    /* Stop here that ForcefulKill exception which was meant to free the RAII stuff on the stack */
@@ -250,20 +248,24 @@ PYBIND11_MODULE(simgrid, m)
                }
              });
            },
-           "Create an actor from a function or an object, see :cpp:func:`simgrid::s4u::Actor::create()`")
-      .def_property("host", &Actor::get_host, &Actor::migrate, "The host on which this actor is located")
+           "Create an actor from a function or an object.")
+      .def_property("host", &Actor::get_host, &Actor::set_host, "The host on which this actor is located")
+      .def_property_readonly("name", &Actor::get_cname, "The name of this actor.")
       .def_property_readonly("pid", &Actor::get_pid, "The PID (unique identifier) of this actor.")
+      .def_property_readonly("ppid", &Actor::get_ppid,
+                             "The PID (unique identifier) of the actor that created this one.")
       .def("by_pid", &Actor::by_pid, "Retrieve an actor by its PID")
       .def("daemonize", &Actor::daemonize,
-           "This actor will be automatically terminated when the last non-daemon actor finishes, see :cpp:func:`void "
-           "simgrid::s4u::Actor::daemonize()`")
+           "This actor will be automatically terminated when the last non-daemon actor finishes (more info in the C++ "
+           "documentation).")
+      .def("is_daemon", &Actor::is_daemon,
+           "Returns True if that actor is a daemon and will be terminated automatically when the last non-daemon actor "
+           "terminates.")
       .def("join", py::overload_cast<double>(&Actor::join),
-           "Wait for the actor to finish, see :cpp:func:`void simgrid::s4u::Actor::join(double)`", py::arg("timeout"))
+           "Wait for the actor to finish (more info in the C++ documentation).", py::arg("timeout"))
       .def("kill", [](ActorPtr act) { act->kill(); }, "Kill that actor")
       .def("kill_all", &Actor::kill_all, "Kill all actors but the caller.")
-      .def("migrate", &Actor::migrate,
-           "Moves that actor to another host, see :cpp:func:`void simgrid::s4u::Actor::migrate()`", py::arg("dest"))
-      .def("self", &Actor::self, "Retrieves the current actor, see :cpp:func:`void simgrid::s4u::Actor::self()`")
+      .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, "Suspend that actor, that is blocked until resume()ed by another actor.")
       .def("resume", &Actor::resume, "Resume that actor, that was previously suspend()ed.");