Merge pull request #321 from sofa-framework/revert-314-pr-add-difflib-support

damienmarchal · web-flow · commit 2d62f4e30818 · 2022-12-07T15:48:22.000+01:00
Revert "[Sofa.Core] Add spelling suggestion to addObject &amp; addChild"
diff --git a/Plugin/CMakeLists.txt b/Plugin/CMakeLists.txt
@@ -5,7 +5,6 @@ set(HEADER_FILES
     ${CMAKE_CURRENT_SOURCE_DIR}/src/SofaPython3/initModule.h
     ${CMAKE_CURRENT_SOURCE_DIR}/src/SofaPython3/PythonEnvironment.h
     ${CMAKE_CURRENT_SOURCE_DIR}/src/SofaPython3/SceneLoaderPY3.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/src/SofaPython3/SpellingSuggestionHelper.h
 
     ${CMAKE_CURRENT_SOURCE_DIR}/src/SofaPython3/DataCache.h
     ${CMAKE_CURRENT_SOURCE_DIR}/src/SofaPython3/DataHelper.h
diff --git a/Plugin/src/SofaPython3/SpellingSuggestionHelper.h b/Plugin/src/SofaPython3/SpellingSuggestionHelper.h
diff --git a/Plugin/src/SofaPython3/config.h.in b/Plugin/src/SofaPython3/config.h.in
@@ -55,18 +55,3 @@
 #else
 #define SOFAPYTHON3_BIND_ATTRIBUTE_ERROR() namespace pybind11 { PYBIND11_RUNTIME_EXCEPTION(attribute_error, PyExc_AttributeError) }
 #endif // PYBIND11_SOFA_VERSION >= 20801
-
-#if PYBIND11_SOFA_VERSION >= 20801
-#define SOFAPYTHON3_ADD_PYBIND_TYPE_FOR_OLD_VERSION()
-#else
-#define SOFAPYTHON3_ADD_PYBIND_TYPE_FOR_OLD_VERSION() namespace pybind11 { \
-class type : public pybind11::object { \
-public: \
-    PYBIND11_OBJECT(type, pybind11::object, PyType_Check) \
-    static pybind11::handle handle_of(pybind11::handle h) { return handle((PyObject*) Py_TYPE(h.ptr())); } \
-    static type of(pybind11::handle h) { return type(type::handle_of(h), borrowed_t{}); } \
-    template<typename T> static handle handle_of(); \
-    template<typename T> static type of() {return type(type::handle_of<T>(), borrowed_t{}); } \
-}; \
-}
-#endif // PYBIND11_SOFA_VERSION >= 20801
diff --git a/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Base.cpp b/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Base.cpp
@@ -18,7 +18,6 @@
 * Contact information: contact@sofa-framework.org                             *
 ******************************************************************************/
 
-#include "SofaPython3/SpellingSuggestionHelper.h"
 #include <pybind11/pybind11.h>
 
 #include <pybind11/numpy.h>
@@ -45,9 +44,7 @@ using sofa::simulation::Node;
 
 #include <SofaPython3/DataHelper.h>
 
-// These two lines are there to handle deprecated version of pybind.
 SOFAPYTHON3_BIND_ATTRIBUTE_ERROR()
-SOFAPYTHON3_ADD_PYBIND_TYPE_FOR_OLD_VERSION()
 
 /// Makes an alias for the pybind11 namespace to increase readability.
 namespace py { using namespace pybind11; }
@@ -342,39 +339,15 @@ py::list BindingBase::__dir__(Base* self)
     return list;
 }
 
-py::object BindingBase::__getattr__(py::object self, const std::string& attributeName)
+py::object BindingBase::__getattr__(py::object self, const std::string& s)
 {
-    // Search for attribute s.
-    py::object res = BindingBase::GetAttr( py::cast<Base*>(self), attributeName, false );
-
-    // If there is one, then return it
-    if( !res.is_none() )
-        return res;
-
-   // If there is none, then search into the python dictionnary
-    if( py::hasattr(self.attr("__dict__"), attributeName.c_str()) )
-        return self.attr("__dict__")[attributeName.c_str()];
-
-    // If we reach this line, this indicate that no attribute was found. Maybe it is a misspelling
-    // so let's build misspelling hints for the user.
-    Base* selfbase = py::cast<Base*>(self);
-    std::stringstream tmp;
-    emitSpellingMessage(tmp, "   - The data field named ", selfbase->getDataFields(), attributeName, 2, 0.6);
-    emitSpellingMessage(tmp, "   - The link named ", selfbase->getLinks(), attributeName, 2, 0.6);
-
-    // Also provide spelling hints on python functions.
-    emitSpellingMessage(tmp, "   - The python attribute named ", py::cast<py::dict>(py::type::of(self).attr("__dict__")), attributeName, 5, 0.8,
-                        [](const std::pair<py::handle, py::handle>& kv) { return py::cast<std::string>(std::get<0>(kv)); });
-
-    std::stringstream message;
-    message << "Unable to find attribute: "+attributeName;
-    if(!tmp.str().empty())
+    py::object res = BindingBase::GetAttr( py::cast<Base*>(self), s, false );
+    if( res.is_none() )
     {
-        message << msgendl;
-        message << "   You possibly wanted to access: " << msgendl;
-        message << tmp.rdbuf();
+        return self.attr("__dict__")[s.c_str()];
     }
-    throw py::attribute_error(message.str());
+
+    return res;
 }
 
 void BindingBase::__setattr__(py::object self, const std::string& s, py::object value)
diff --git a/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Node.cpp b/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Node.cpp
@@ -17,9 +17,11 @@
 *******************************************************************************
 * Contact information: contact@sofa-framework.org                             *
 ******************************************************************************/
+
+
 /// Neede to have automatic conversion from pybind types to stl container.
 #include <pybind11/stl.h>
-#include <pybind11/numpy.h>
+#include <pybind11/eval.h>
 
 #include <sofa/simulation/Simulation.h>
 #include <sofa/core/ComponentNameHelper.h>
@@ -33,9 +35,6 @@ namespace simpleapi = sofa::simpleapi;
 #include <sofa/helper/logging/Messaging.h>
 using sofa::helper::logging::Message;
 
-#include <sofa/helper/DiffLib.h>
-using sofa::helper::getClosestMatch;
-
 #include <sofa/simulation/graph/DAGNode.h>
 using sofa::core::ExecParams;
 
@@ -60,67 +59,41 @@ using sofapython3::PythonEnvironment;
 #include <SofaPython3/Sofa/Core/Binding_NodeIterator.h>
 #include <SofaPython3/Sofa/Core/Binding_PythonScriptEvent.h>
 
-#include <SofaPython3/SpellingSuggestionHelper.h>
-
 using sofa::core::objectmodel::BaseObjectDescription;
 
 #include <queue>
 #include <sofa/core/objectmodel/Link.h>
 
-// These two lines are there to handle deprecated version of pybind.
-SOFAPYTHON3_BIND_ATTRIBUTE_ERROR()
-SOFAPYTHON3_ADD_PYBIND_TYPE_FOR_OLD_VERSION()
-
 /// Makes an alias for the pybind11 namespace to increase readability.
 namespace py { using namespace pybind11; }
 
 using sofa::simulation::Node;
 
-namespace sofapython3
-{
+namespace sofapython3 {
 
-namespace
-{
-bool checkParamUsage(BaseObjectDescription& desc, const Base* base)
+bool checkParamUsage(BaseObjectDescription& desc)
 {
-    std::vector<std::tuple<std::string, std::string>> paramErrors;
+    bool hasFailure = false;
+    std::stringstream tmp;
+    tmp <<"Unknown Attribute(s): " << msgendl;
     for( auto& it : desc.getAttributeMap() )
     {
         if (!it.second.isAccessed())
         {
-            paramErrors.emplace_back(std::make_tuple(it.first, it.second));
+            hasFailure = true;
+            tmp << " - \""<<it.first <<"\" with value: \"" <<std::string(it.second) << msgendl;
         }
     }
-
-    if(!paramErrors.empty() || !desc.getErrors().empty())
+    if(!desc.getErrors().empty())
+    {
+        hasFailure = true;
+        tmp << desc.getErrors()[0];
+    }
+    if(hasFailure)
     {
-        std::stringstream tmp;
-        tmp << "Unknown Attribute(s): " << msgendl;
-
-        std::vector<std::string> possibleNames;
-        if(base)
-        {
-            fillVectorOfStringFrom(base->getDataFields(), std::back_inserter(possibleNames), [](const BaseData* d){return d->getName();});
-            fillVectorOfStringFrom(base->getLinks(), std::back_inserter(possibleNames), [](const BaseLink* l){return l->getName();});
-        }
-
-        for(auto& [name, value] : paramErrors)
-        {
-            tmp << "  - Unable to set attribute '"<< name <<"' with value: " << value;
-            const auto& v = getClosestMatch(name, possibleNames);
-            if(!v.empty())
-                tmp << ". Possible misspelling of attribute '" << std::get<0>(v[0]) << "' ?";
-            else
-                tmp << ".";
-            tmp << msgendl;
-        }
-
-        if(!desc.getErrors().empty())
-            tmp << desc.getErrors()[0];
         throw py::type_error(tmp.str());
     }
-
-    return false;
+    return hasFailure;
 }
 
 py::object getItem(Node& self, std::list<std::string>& path)
@@ -206,7 +179,7 @@ py::object getObject(Node &n, const std::string &name, const py::kwargs& kwargs)
         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"
                            << msgendl
-                           << PythonEnvironment::getPythonCallingPointString() ;
+                            << PythonEnvironment::getPythonCallingPointString() ;
     }
 
     BaseObject *object = n.getObject(name);
@@ -274,7 +247,7 @@ py::object addObjectKwargs(Node* self, const std::string& type, const py::kwargs
 
     setFieldsFromPythonValues(object.get(), kwargs);
 
-    checkParamUsage(desc, object.get());
+    checkParamUsage(desc);
 
     // Convert the logged messages in the object's internal logging into python exception.
     // this is not a very fast way to do that...but well...python is slow anyway. And serious
@@ -369,7 +342,7 @@ py::object addChildKwargs(Node* self, const std::string& name, const py::kwargs&
     node->setInstanciationSourceFileName(finfo->filename);
     node->setInstanciationSourceFilePos(finfo->line);
 
-    checkParamUsage(desc, node.get());
+    checkParamUsage(desc);
 
     for(auto a : kwargs)
     {
@@ -425,79 +398,56 @@ py::object removeChildByName(Node& n, const std::string name)
 std::unique_ptr<NodeIterator> property_children(Node* node)
 {
     return std::make_unique<NodeIterator>(node,
-                                          [](Node* n) -> size_t { return n->child.size(); },
-    [](Node* n, unsigned int index) -> Base::SPtr { return n->child[index]; },
-[](const Node* n, const std::string& name) { return n->getChild(name); },
-[](Node* n, unsigned int index) { n->removeChild(n->child[index]); }
-);
+                            [](Node* n) -> size_t { return n->child.size(); },
+                            [](Node* n, unsigned int index) -> Base::SPtr { return n->child[index]; },
+                            [](const Node* n, const std::string& name) { return n->getChild(name); },
+                            [](Node* n, unsigned int index) { n->removeChild(n->child[index]); }
+                            );
 }
 
 std::unique_ptr<NodeIterator> property_parents(Node* node)
 {
     return std::make_unique<NodeIterator>(node,
-                                          [](Node* n) -> size_t { return n->getNbParents(); },
-    [](Node* n, unsigned int index) -> Node::SPtr {
-    auto p = n->getParents();
-    return static_cast<Node*>(p[index]);
-},
-[](const Node* n, const std::string& name) -> sofa::core::Base* {
-    const auto& parents = n->getParents();
-    return *std::find_if(parents.begin(),
-                         parents.end(),
-                         [name](BaseNode* child){ return child->getName() == name; });
-},
-[](Node*, unsigned int) {
-    throw std::runtime_error("Removing a parent is not a supported operation. Please detach the node from the corresponding graph node.");
-});
+                            [](Node* n) -> size_t { return n->getNbParents(); },
+                            [](Node* n, unsigned int index) -> Node::SPtr {
+                                auto p = n->getParents();
+                                return static_cast<Node*>(p[index]);
+                                },
+                            [](const Node* n, const std::string& name) -> sofa::core::Base* {
+                                    const auto& parents = n->getParents();
+                                    return *std::find_if(parents.begin(),
+                                                     parents.end(),
+                                                     [name](BaseNode* child){ return child->getName() == name; });
+                                },
+                            [](Node*, unsigned int) {
+                                throw std::runtime_error("Removing a parent is not a supported operation. Please detach the node from the corresponding graph node.");
+                            });
 }
 
 std::unique_ptr<NodeIterator> property_objects(Node* node)
 {
     return std::make_unique<NodeIterator>(node,
-                                          [](Node* n) -> size_t { return n->object.size(); },
-    [](Node* n, unsigned int index) -> Base::SPtr { return (n->object[index]);},
-[](const Node* n, const std::string& name) { return n->getObject(name); },
-[](Node* n, unsigned int index) { n->removeObject(n->object[index]);}
-);
+                            [](Node* n) -> size_t { return n->object.size(); },
+                            [](Node* n, unsigned int index) -> Base::SPtr { return (n->object[index]);},
+                            [](const Node* n, const std::string& name) { return n->getObject(name); },
+                            [](Node* n, unsigned int index) { n->removeObject(n->object[index]);}
+                            );
 }
 
-py::object __getattr__(py::object pyself, const std::string& name)
+py::object __getattr__(Node& self, const std::string& name)
 {
-    Node* selfnode = py::cast<Node*>(pyself);
     /// Search in the object lists
-    BaseObject *object = selfnode->getObject(name);
+    BaseObject *object = self.getObject(name);
     if (object)
         return PythonFactory::toPython(object);
 
     /// Search in the child lists
-    Node *child = selfnode->getChild(name);
+    Node *child = self.getChild(name);
     if (child)
         return PythonFactory::toPython(child);
 
     /// Search in the data & link lists
-    py::object result = BindingBase::GetAttr(selfnode, name, false);
-    if(!result.is_none())
-        return result;
-
-    std::stringstream tmp;
-    emitSpellingMessage(tmp, "   - The data field named ", selfnode->getDataFields(), name, 2, 0.8);
-    emitSpellingMessage(tmp, "   - The link named ", selfnode->getDataFields(), name, 2, 0.8);
-    emitSpellingMessage(tmp, "   - The object named ", selfnode->getNodeObjects(), name, 2, 0.8);
-    emitSpellingMessage(tmp, "   - The child node named ", selfnode->getChildren(), name, 2, 0.8);
-
-    // Also provide spelling hints on python functions.
-    emitSpellingMessage(tmp, "   - The python attribute named ", py::cast<py::dict>(py::type::of(pyself).attr("__dict__")), name, 5, 0.8,
-                        [](const std::pair<py::handle, py::handle>& kv) { return py::cast<std::string>(std::get<0>(kv)); });
-
-    std::stringstream message;
-    message << "Unable to find attribute: "+name;
-    if(!tmp.str().empty())
-    {
-        message << msgendl;
-        message << "   You possibly wanted to access: " << msgendl;
-        message << tmp.rdbuf();
-    }
-    throw pybind11::attribute_error(message.str());
+    return BindingBase::GetAttr(&self, name, true);
 }
 
 /// gets an item using its path (path is dot-separated, relative to the object
@@ -599,8 +549,6 @@ void sendEvent(Node* self, py::object pyUserData, char* eventName)
     self->propagateEvent(sofa::core::execparams::defaultInstance(), &event);
 }
 
-}
-
 void moduleAddNode(py::module &m) {
     /// Register the complete parent-child relationship between Base and Node to the pybind11
     /// typing system.
