Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove deprecated features for the new next release (3.34).
[simgrid.git] / src / bindings / python / simgrid_python.cpp
index 0b7fd84..9f0c715 100644 (file)
@@ -11,7 +11,6 @@
 #include "simgrid/kernel/ProfileBuilder.hpp"
 #include "simgrid/kernel/routing/NetPoint.hpp"
 #include <simgrid/Exception.hpp>
-#include <simgrid/plugins/operation.hpp>
 #include <simgrid/s4u/Actor.hpp>
 #include <simgrid/s4u/Barrier.hpp>
 #include <simgrid/s4u/Comm.hpp>
@@ -25,6 +24,7 @@
 #include <simgrid/s4u/Mutex.hpp>
 #include <simgrid/s4u/NetZone.hpp>
 #include <simgrid/s4u/Semaphore.hpp>
+#include <simgrid/s4u/Task.hpp>
 #include <simgrid/version.h>
 
 #include <algorithm>
 #include <vector>
 
 namespace py = pybind11;
-using simgrid::plugins::CommOp;
-using simgrid::plugins::CommOpPtr;
-using simgrid::plugins::ExecOp;
-using simgrid::plugins::ExecOpPtr;
-using simgrid::plugins::IoOp;
-using simgrid::plugins::IoOpPtr;
-using simgrid::plugins::Operation;
-using simgrid::plugins::OperationPtr;
+using simgrid::s4u::CommTask;
+using simgrid::s4u::CommTaskPtr;
+using simgrid::s4u::ExecTask;
+using simgrid::s4u::ExecTaskPtr;
+using simgrid::s4u::IoTask;
+using simgrid::s4u::IoTaskPtr;
+using simgrid::s4u::Task;
+using simgrid::s4u::TaskPtr;
 using simgrid::s4u::Actor;
 using simgrid::s4u::ActorPtr;
 using simgrid::s4u::Barrier;
@@ -171,54 +171,16 @@ 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",
-                  []() // XBT_ATTRIB_DEPRECATED_v334
-                  {
-                    PyErr_WarnEx(
-                        PyExc_DeprecationWarning,
-                        "get_clock() is deprecated and  will be dropped after v3.33, use `Engine.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("host_by_name", &Engine::host_by_name_or_null,
            "Retrieve a host by its name, or None if it does not exist in the platform.")
       .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.33, 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)
@@ -311,13 +273,6 @@ 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",
-           [](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")
@@ -392,42 +347,11 @@ 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",
-           [](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, "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_property_readonly("disks", &Host::get_disks, "The list of disks on this host (read-only).")
       .def("get_disks", &Host::get_disks, "Retrieve the list of disks in this host")
-      .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,
                     py::cpp_function(&Host::set_core_count, py::call_guard<py::gil_scoped_release>()),
                     "Manage the number of cores in the CPU")
@@ -622,21 +546,7 @@ 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",
-           [](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 */
@@ -919,92 +829,89 @@ PYBIND11_MODULE(simgrid, m)
       .value("READ", simgrid::s4u::Io::OpType::READ)
       .value("WRITE", simgrid::s4u::Io::OpType::WRITE);
 
-  /* Class Operation */
-  py::class_<Operation, OperationPtr>(m, "Operation", "Operation. See the C++ documentation for details.")
-      .def_static("init", &Operation::init)
+  /* Class Task */
+  py::class_<Task, TaskPtr>(m, "Task", "Task. See the C++ documentation for details.")
       .def_static(
           "on_start_cb",
           [](py::object cb) {
             cb.inc_ref(); // keep alive after return
             const py::gil_scoped_release gil_release;
-            Operation::on_start_cb([cb](Operation* op) {
+            Task::on_start_cb([cb_p = cb.ptr()](Task* op) {
               const py::gil_scoped_acquire py_context; // need a new context for callback
-              py::reinterpret_borrow<py::function>(cb.ptr())(op);
+              py::reinterpret_borrow<py::function>(cb_p)(op);
             });
           },
-          "Add a callback called when each operation starts.")
+          "Add a callback called when each task starts.")
       .def_static(
-          "on_end_cb",
+          "on_completion_cb",
           [](py::object cb) {
             cb.inc_ref(); // keep alive after return
             const py::gil_scoped_release gil_release;
-            Operation::on_end_cb([cb](Operation* op) {
+            Task::on_completion_cb([cb_p = cb.ptr()](Task* op) {
               const py::gil_scoped_acquire py_context; // need a new context for callback
-              py::reinterpret_borrow<py::function>(cb.ptr())(op);
+              py::reinterpret_borrow<py::function>(cb_p)(op);
             });
           },
-          "Add a callback called when each operation ends.")
-      .def_property_readonly("name", &Operation::get_name, "The name of this operation (read-only).")
-      .def_property_readonly("count", &Operation::get_count, "The execution count of this operation (read-only).")
-      .def_property_readonly("successors", &Operation::get_successors, "The successors of this operation (read-only).")
-      .def_property("amount", &Operation::get_amount, &Operation::set_amount,
-                    "The amount of work to do for this operation.")
-      .def("enqueue_execs", py::overload_cast<int>(&Operation::enqueue_execs), py::call_guard<py::gil_scoped_release>(),
-           py::arg("n"), "Enqueue executions for this operation.")
-      .def("add_successor", py::overload_cast<OperationPtr>(&Operation::add_successor),
-           py::call_guard<py::gil_scoped_release>(), py::arg("op"), "Add a successor to this operation.")
-      .def("remove_successor", py::overload_cast<OperationPtr>(&Operation::remove_successor),
-           py::call_guard<py::gil_scoped_release>(), py::arg("op"), "Remove a successor of this operation.")
-      .def("remove_all_successors", &Operation::remove_all_successors, py::call_guard<py::gil_scoped_release>(),
-           "Remove all successors of this operation.")
-      .def("on_this_start", py::overload_cast<const std::function<void(Operation*)>&>(&Operation::on_this_start),
-           py::arg("func"), "Add a callback called when this operation starts.")
-      .def("on_this_end", py::overload_cast<const std::function<void(Operation*)>&>(&Operation::on_this_end),
-           py::arg("func"), "Add a callback called when this operation ends.")
+          "Add a callback called when each task ends.")
+      .def_property_readonly("name", &Task::get_name, "The name of this task (read-only).")
+      .def_property_readonly("count", &Task::get_count, "The execution count of this task (read-only).")
+      .def_property_readonly("successors", &Task::get_successors, "The successors of this task (read-only).")
+      .def_property("amount", &Task::get_amount, &Task::set_amount, "The amount of work to do for this task.")
+      .def("enqueue_firings", py::overload_cast<int>(&Task::enqueue_firings), py::call_guard<py::gil_scoped_release>(),
+           py::arg("n"), "Enqueue firings for this task.")
+      .def("add_successor", py::overload_cast<TaskPtr>(&Task::add_successor), py::call_guard<py::gil_scoped_release>(),
+           py::arg("op"), "Add a successor to this task.")
+      .def("remove_successor", py::overload_cast<TaskPtr>(&Task::remove_successor),
+           py::call_guard<py::gil_scoped_release>(), py::arg("op"), "Remove a successor of this task.")
+      .def("remove_all_successors", &Task::remove_all_successors, py::call_guard<py::gil_scoped_release>(),
+           "Remove all successors of this task.")
+      .def("on_this_start_cb", py::overload_cast<const std::function<void(Task*)>&>(&Task::on_this_start_cb),
+           py::arg("func"), "Add a callback called when this task starts.")
+      .def("on_this_completion_cb", py::overload_cast<const std::function<void(Task*)>&>(&Task::on_this_completion_cb),
+           py::arg("func"), "Add a callback called when this task ends.")
       .def(
-          "__repr__", [](const OperationPtr op) { return "Operation(" + op->get_name() + ")"; },
-          "Textual representation of the Operation");
-
-  /* Class CommOp */
-  py::class_<CommOp, CommOpPtr, Operation>(m, "CommOp",
-                                           "Communication Operation. See the C++ documentation for details.")
-      .def_static("init", py::overload_cast<const std::string&>(&CommOp::init),
-                  py::call_guard<py::gil_scoped_release>(), py::arg("name"), "CommOp constructor")
-      .def_static("init", py::overload_cast<const std::string&, double, Host*, Host*>(&CommOp::init),
+          "__repr__", [](const TaskPtr op) { return "Task(" + op->get_name() + ")"; },
+          "Textual representation of the Task");
+
+  /* Class CommTask */
+  py::class_<CommTask, CommTaskPtr, Task>(m, "CommTask", "Communication Task. See the C++ documentation for details.")
+      .def_static("init", py::overload_cast<const std::string&>(&CommTask::init),
+                  py::call_guard<py::gil_scoped_release>(), py::arg("name"), "CommTask constructor")
+      .def_static("init", py::overload_cast<const std::string&, double, Host*, Host*>(&CommTask::init),
                   py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("bytes"), py::arg("source"),
-                  py::arg("destination"), "CommOp constructor")
-      .def_property("source", &CommOp::get_source, &CommOp::set_source, "The source of the communication.")
-      .def_property("destination", &CommOp::get_destination, &CommOp::set_destination,
+                  py::arg("destination"), "CommTask constructor")
+      .def_property("source", &CommTask::get_source, &CommTask::set_source, "The source of the communication.")
+      .def_property("destination", &CommTask::get_destination, &CommTask::set_destination,
                     "The destination of the communication.")
-      .def_property("bytes", &CommOp::get_bytes, &CommOp::set_bytes, "The amount of bytes to send.")
+      .def_property("bytes", &CommTask::get_bytes, &CommTask::set_bytes, "The amount of bytes to send.")
       .def(
-          "__repr__", [](const CommOpPtr c) { return "CommOp(" + c->get_name() + ")"; },
-          "Textual representation of the CommOp");
-
-  /* Class ExecOp */
-  py::class_<ExecOp, ExecOpPtr, Operation>(m, "ExecOp", "Execution Operation. See the C++ documentation for details.")
-      .def_static("init", py::overload_cast<const std::string&>(&ExecOp::init),
-                  py::call_guard<py::gil_scoped_release>(), py::arg("name"), "ExecOp constructor")
-      .def_static("init", py::overload_cast<const std::string&, double, Host*>(&ExecOp::init),
+          "__repr__", [](const CommTaskPtr c) { return "CommTask(" + c->get_name() + ")"; },
+          "Textual representation of the CommTask");
+
+  /* Class ExecTask */
+  py::class_<ExecTask, ExecTaskPtr, Task>(m, "ExecTask", "Execution Task. See the C++ documentation for details.")
+      .def_static("init", py::overload_cast<const std::string&>(&ExecTask::init),
+                  py::call_guard<py::gil_scoped_release>(), py::arg("name"), "ExecTask constructor")
+      .def_static("init", py::overload_cast<const std::string&, double, Host*>(&ExecTask::init),
                   py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("flops"), py::arg("host"),
-                  "CommOp constructor.")
-      .def_property("host", &ExecOp::get_host, &ExecOp::set_host, "The host of the execution.")
-      .def_property("flops", &ExecOp::get_flops, &ExecOp::set_flops, "The amount of flops to execute.")
+                  "CommTask constructor.")
+      .def_property("host", &ExecTask::get_host, &ExecTask::set_host, "The host of the execution.")
+      .def_property("flops", &ExecTask::get_flops, &ExecTask::set_flops, "The amount of flops to execute.")
       .def(
-          "__repr__", [](const ExecOpPtr e) { return "ExecOp(" + e->get_name() + ")"; },
-          "Textual representation of the ExecOp");
-
-  /* Class IoOp */
-  py::class_<IoOp, IoOpPtr, Operation>(m, "IoOp", "IO Operation. See the C++ documentation for details.")
-      .def_static("init", py::overload_cast<const std::string&>(&IoOp::init), py::call_guard<py::gil_scoped_release>(),
-                  py::arg("name"), "IoOp constructor")
-      .def_static("init", py::overload_cast<const std::string&, double, Disk*, Io::OpType>(&IoOp::init),
+          "__repr__", [](const ExecTaskPtr e) { return "ExecTask(" + e->get_name() + ")"; },
+          "Textual representation of the ExecTask");
+
+  /* Class IoTask */
+  py::class_<IoTask, IoTaskPtr, Task>(m, "IoTask", "IO Task. See the C++ documentation for details.")
+      .def_static("init", py::overload_cast<const std::string&>(&IoTask::init),
+                  py::call_guard<py::gil_scoped_release>(), py::arg("name"), "IoTask constructor")
+      .def_static("init", py::overload_cast<const std::string&, double, Disk*, Io::OpType>(&IoTask::init),
                   py::call_guard<py::gil_scoped_release>(), py::arg("name"), py::arg("bytes"), py::arg("disk"),
-                  py::arg("type"), "IoOp constructor.")
-      .def_property("disk", &IoOp::get_disk, &IoOp::set_disk, "The disk of the IO.")
-      .def_property("bytes", &IoOp::get_bytes, &IoOp::set_bytes, "The amount of bytes to process.")
-      .def_property("type", &IoOp::get_bytes, &IoOp::set_bytes, "The type of IO.")
+                  py::arg("type"), "IoTask constructor.")
+      .def_property("disk", &IoTask::get_disk, &IoTask::set_disk, "The disk of the IO.")
+      .def_property("bytes", &IoTask::get_bytes, &IoTask::set_bytes, "The amount of bytes to process.")
+      .def_property("type", &IoTask::get_bytes, &IoTask::set_bytes, "The type of IO.")
       .def(
-          "__repr__", [](const IoOpPtr io) { return "IoOp(" + io->get_name() + ")"; },
-          "Textual representation of the IoOp");
+          "__repr__", [](const IoTaskPtr io) { return "IoTask(" + io->get_name() + ")"; },
+          "Textual representation of the IoTask");
 }