[Binding/Sofa.Core] add getObject method to Sofa.Node. (#175)

Author: damienmarchal

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Node.cpp

@@ -167,14 +167,28 @@ py::object hasObject(Node &n, const std::string &name)
     return py::cast(false);
 }
 
+py::object getObject(Node &n, const std::string &name, const py::kwargs& kwargs)
+{
+    if(kwargs.size()!=0)
+    {
+        msg_deprecated(&n) << "Calling the method getObject() with extra arguments is not supported anymore."
+                           << "To remove this message please refer to the documentation of the getObject method";
+    }
+
+    BaseObject *object = n.getObject(name);
+    if (object)
+        return PythonFactory::toPython(object);
+    return py::none();
+}
+
 /// Implement the addObject function.
 py::object addObjectKwargs(Node* self, const std::string& type, const py::kwargs& kwargs)
 {
     if (kwargs.contains("name"))
     {
         std::string name = py::str(kwargs["name"]);
         if (sofapython3::isProtectedKeyword(name))
-            throw py::value_error("addObject: Cannot call addObject with name " + name + ": Protected keyword");
+            throw py::value_error("Cannot call addObject with name " + name + ": Protected keyword");
     }
     /// Prepare the description to hold the different python attributes as data field's
     /// arguments then create the object.
@@ -230,7 +244,6 @@ py::object addKwargs(Node* self, const py::object& callable, const py::kwargs& k
         self->addChild(node);
         return py::cast(node);
     }
-
     if(py::isinstance<py::str>(callable))
     {
         py::str type = callable;
@@ -507,6 +520,7 @@ void moduleAddNode(py::module &m) {
     p.def("addObject", &addObject, sofapython3::doc::sofa::core::Node::addObject, py::keep_alive<0, 2>());
     p.def("createObject", &createObject, sofapython3::doc::sofa::core::Node::createObject);
     p.def("hasObject", &hasObject, sofapython3::doc::sofa::core::Node::hasObject);
+    p.def("getObject", &getObject, sofapython3::doc::sofa::core::Node::getObject);
     p.def("addChild", &addChildKwargs, sofapython3::doc::sofa::core::Node::addChildKwargs);
     p.def("addChild", &addChild, sofapython3::doc::sofa::core::Node::addChild);
     p.def("createChild", &createChild, sofapython3::doc::sofa::core::Node::createChild);

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Node_doc.h

@@ -161,6 +161,34 @@ static auto hasObject =
         :type name: string
         :return: True if the node has an object with correspdonding name.
         )";
+static auto getObject =
+        R"(
+        Get a sofa component hold by a node.
+
+        :param n
+        :param name
+        :type n: Sofa.Simulation.Node
+        :type name: string
+        :return: the component with 'name', None otherwise
+
+        .. note::
+        The extra arguments allowed in the SofaPython (warning=True/False) binding are not supported SofaPython3.
+
+        .. code-block:: python
+            # SofaPython2:
+            if node.getObject("MyObject",warning=False):
+                pass
+
+            # SofaPython3:
+            if node.getObject("MyObject") != None:
+                pass
+
+            if node.hasObject("MyObject"):
+                pass
+
+            if "MyObject" in node.objects:
+                pass
+        )";
 
 static auto addChildKwargs =
         R"(