X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ed6bf64097b3255e9253d02a735ec025d32929fe..3c19254bcc639fa7d14122d705a6bf977411137f:/src/bindings/python/simgrid_python.cpp diff --git a/src/bindings/python/simgrid_python.cpp b/src/bindings/python/simgrid_python.cpp index cb20aaa326..81ca2895b1 100644 --- a/src/bindings/python/simgrid_python.cpp +++ b/src/bindings/python/simgrid_python.cpp @@ -146,20 +146,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", + [](pybind11::object& self) // XBT_ATTRIB_DEPRECATED_v334 + { + PyErr_WarnEx(PyExc_DeprecationWarning, + "get_clock() is deprecated and will be dropped after v3.33, use clock instead.", 1); + return self.attr("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", + [](pybind11::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", + [](pybind11::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", + [](pybind11::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", + [](pybind11::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(), "Run the simulation until its end") @@ -241,10 +276,19 @@ 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", + [](pybind11::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(); }, "The name of this network zone"); + "name", [](const simgrid::s4u::NetZone* self) { return self->get_name(); }, + "The name of this network zone (read-only property)."); /* Class ClusterCallbacks */ py::class_(m, "ClusterCallbacks", "Callbacks used to create cluster zones") @@ -311,12 +355,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", + [](pybind11::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", + [](pybind11::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(), + "Retrieve the maximal speed at the given pstate") + .def("get_netpoint", + [](pybind11::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(), - "Set the number of cores in the CPU") + .def("set_core_count", + [](pybind11::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(), "Set the coordinates of this host") .def("set_sharing_policy", &simgrid::s4u::Host::set_sharing_policy, py::call_guard(), @@ -333,7 +414,7 @@ PYBIND11_MODULE(simgrid, m) py::gil_scoped_release gil_guard; h->set_pstate(i); }, - "The current pstate") + "The current pstate (read/write property).") .def("current", &Host::current, py::call_guard(), "Retrieves the host on which the running actor is located.") .def_property_readonly( @@ -341,18 +422,18 @@ PYBIND11_MODULE(simgrid, m) [](const Host* self) { return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC }, - "The name of this host") + "The name of this host (read-only property).") .def_property_readonly("load", &Host::get_load, "Returns the current computation load (in flops per second), NOT taking the external load " - "into account. This is the currently achieved speed.") + "into account. This is the currently achieved speed (read-only property).") .def_property_readonly( "speed", &Host::get_speed, "The peak computing speed in flops/s at the current pstate, NOT taking the external load into account. " - "This is the max potential speed.") - .def_property_readonly( - "available_speed", &Host::get_available_speed, - "Get the available speed ratio, between 0 and 1.\n" - "This accounts for external load (see :py:func:`set_speed_profile() `).") + "This is the max potential speed (read-only property).") + .def_property_readonly("available_speed", &Host::get_available_speed, + "Get the available speed ratio, between 0 and 1.\n" + "This accounts for external load (see :py:func:`set_speed_profile() " + "`) (read-only property).") .def( "on_creation_cb", [](py::object cb) { @@ -389,7 +470,8 @@ PYBIND11_MODULE(simgrid, m) py::arg("cb") = simgrid::s4u::NonLinearResourceCb()) .def("seal", &simgrid::s4u::Disk::seal, py::call_guard(), "Seal this disk") .def_property_readonly( - "name", [](const simgrid::s4u::Disk* self) { return self->get_name(); }, "The name of this disk"); + "name", [](const simgrid::s4u::Disk* self) { return self->get_name(); }, + "The name of this disk (read-only property)."); py::enum_(disk, "SharingPolicy") .value("NONLINEAR", simgrid::s4u::Disk::SharingPolicy::NONLINEAR) .value("LINEAR", simgrid::s4u::Disk::SharingPolicy::LINEAR) @@ -480,7 +562,7 @@ PYBIND11_MODULE(simgrid, m) "Set concurrency limit for this link") .def("set_host_wifi_rate", &Link::set_host_wifi_rate, py::call_guard(), "Set level of communication speed of given host on this Wi-Fi link") - .def("by_name", &Link::by_name, "Retrieves a Link from its name, or dies") + .def_static("by_name", &Link::by_name, "Retrieves a Link from its name, or dies") .def("seal", &Link::seal, py::call_guard(), "Seal this link") .def_property_readonly( "name", @@ -488,8 +570,9 @@ PYBIND11_MODULE(simgrid, m) return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC }, "The name of this link") - .def_property_readonly("bandwidth", &Link::get_bandwidth, "The bandwidth (in bytes per second)") - .def_property_readonly("latency", &Link::get_latency, "The latency (in seconds)"); + .def_property_readonly("bandwidth", &Link::get_bandwidth, + "The bandwidth (in bytes per second) (read-only property).") + .def_property_readonly("latency", &Link::get_latency, "The latency (in seconds) (read-only property)."); py::enum_(link, "SharingPolicy") .value("NONLINEAR", Link::SharingPolicy::NONLINEAR) @@ -512,8 +595,22 @@ PYBIND11_MODULE(simgrid, m) /* Class Split-Duplex Link */ py::class_>( 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", + [](pybind11::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", + [](pybind11::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_>( @@ -527,7 +624,7 @@ PYBIND11_MODULE(simgrid, m) [](const Mailbox* self) { return std::string(self->get_name().c_str()); // Convert from xbt::string because of MC }, - "The name of that mailbox") + "The name of that mailbox (read-only property).") .def( "put", [](Mailbox* self, py::object data, int size, double timeout) { @@ -613,7 +710,7 @@ PYBIND11_MODULE(simgrid, m) py::gil_scoped_release gil_guard; return self->get_remaining(); }, - "Amount of flops that remain to be computed until completion.") + "Amount of flops that remain to be computed until completion (read-only property).") .def_property_readonly( "remaining_ratio", [](simgrid::s4u::ExecPtr self) { @@ -621,9 +718,10 @@ PYBIND11_MODULE(simgrid, m) return self->get_remaining_ratio(); }, "Amount of work remaining until completion from 0 (completely done) to 1 (nothing done " - "yet).") + "yet) (read-only property).") .def_property("host", &simgrid::s4u::Exec::get_host, &simgrid::s4u::Exec::set_host, - "Host on which this execution runs. Only the first host is returned for parallel executions.") + "Host on which this execution runs. Only the first host is returned for parallel executions. " + "Changing this value migrates the execution.") .def("test", &simgrid::s4u::Exec::test, py::call_guard(), "Test whether the execution is terminated.") .def("cancel", &simgrid::s4u::Exec::cancel, py::call_guard(), "Cancel that execution.") @@ -661,11 +759,16 @@ PYBIND11_MODULE(simgrid, m) py::gil_scoped_release gil_guard; a->set_host(h); }, - "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.") + "The host on which this actor is located. Changing this value migrates the actor.\n\n" + "If the actor is currently blocked on an execution activity, the activity is also migrated to the new host. " + "If it’s blocked on another kind of activity, an error is raised as the mandated code is not written yet. " + "Please report that bug if you need it.\n\n" + "Asynchronous activities started by the actor are not migrated automatically, so you have to take care of " + "this yourself (only you knows which ones should be migrated). ") + .def_property_readonly("name", &Actor::get_cname, "The name of this actor (read-only property).") + .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.") + "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("set_auto_restart", &Actor::set_auto_restart, py::call_guard(), "Specify whether the actor shall restart when its host reboots.")