Remove Sofa.Components (#456)

* Remove Sofa.Components. I suspect this code to have been integrated in the SofaPython3 by mistake and to have never worked. By looking at it it may be an experiment to allow syntax like this import Sofa.Components Sofa.Components.MechanicalObject() ... * Example on how to fix pybind11 type forward declaration so stubgens knows about them. The problem: Depending on the definition order of the binded classes, there may have incorrect types if Base is useing BaseData... but BaseData is only binded after Base. The PR propose a solution for that using a decidcated "forward" registration patter. * Update tests to take into account removal of Sofa.Components. * FIXUP
sofa-framework · Oct 15, 2024 · 9514a08 · 9514a08
1 parent e858992
commit 9514a08
Show file tree

Hide file tree

Showing 16 changed files with 36 additions and 216 deletions.
diff --git a/bindings/Modules/tests/SofaConstraintSolver/matrix_access.py b/bindings/Modules/tests/SofaConstraintSolver/matrix_access.py
@@ -1,6 +1,5 @@
 import unittest
 import Sofa.Core
-import Sofa.Components
 from Sofa import SofaConstraintSolver
 
 class Test(unittest.TestCase):

diff --git a/bindings/Modules/tests/SofaLinearSolver/matrix_access.py b/bindings/Modules/tests/SofaLinearSolver/matrix_access.py
@@ -1,6 +1,5 @@
 import unittest
 import Sofa.Core
-import Sofa.Components
 from Sofa import SofaLinearSolver
 
 class Test(unittest.TestCase):

diff --git a/bindings/Sofa/Bindings.SofaConfig.cmake.in b/bindings/Sofa/Bindings.SofaConfig.cmake.in
@@ -8,7 +8,7 @@ find_package(SofaPython3 QUIET REQUIRED COMPONENTS Plugin)
 # Required by Bindings.Sofa.Helper, Bindings.Sofa.Types
 find_package(Sofa.Core QUIET REQUIRED)
 
-# Required by Bindings.Sofa.Core, Bindings.Sofa.Components
+# Required by Bindings.Sofa.Core
 find_package(Sofa.Simulation.Core QUIET REQUIRED)
 
 # Required by Bindings.Sofa.Core

diff --git a/bindings/Sofa/CMakeLists.txt b/bindings/Sofa/CMakeLists.txt
@@ -1,7 +1,6 @@
 project(Bindings.Sofa)
 
 set(SOFABINDINGS_MODULE_LIST
-    Components
     Core
     Helper
     Simulation

diff --git a/bindings/Sofa/package/__init__.py b/bindings/Sofa/package/__init__.py
@@ -161,7 +161,6 @@
 import Sofa.Core
 import Sofa.Simulation
 import Sofa.Types
-import Sofa.Components
 import SofaTypes
 
 from .prefab import *

diff --git a/bindings/Sofa/src/SofaPython3/Sofa/Components/CMakeLists.txt b/bindings/Sofa/src/SofaPython3/Sofa/Components/CMakeLists.txt
diff --git a/bindings/Sofa/src/SofaPython3/Sofa/Components/Submodule_Components.cpp b/bindings/Sofa/src/SofaPython3/Sofa/Components/Submodule_Components.cpp
diff --git a/bindings/Sofa/src/SofaPython3/Sofa/Components/Submodule_Components.h b/bindings/Sofa/src/SofaPython3/Sofa/Components/Submodule_Components.h
diff --git a/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Base.cpp b/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Base.cpp
@@ -34,6 +34,8 @@ using sofa::helper::WriteOnlyAccessor;
 
 #include <SofaPython3/PythonFactory.h>
 
+#include <SofaPython3/Sofa/Core/Binding_BaseData.h>
+#include <SofaPython3/Sofa/Core/Binding_BaseLink.h>
 #include <SofaPython3/Sofa/Core/Binding_LinkPath.h>
 #include <SofaPython3/Sofa/Core/Binding_Base.h>
 #include <SofaPython3/Sofa/Core/Binding_Base_doc.h>
@@ -449,6 +451,9 @@ py::object BindingBase::setDataValues(Base& self, py::kwargs kwargs)
 
 void moduleAddBase(py::module &m)
 {
+    moduleForwardAddBaseData(m);
+    moduleForwardAddBaseLink(m);
+
     py::class_<Base, py_shared_ptr<Base>> base(m, "Base", py::dynamic_attr(), doc::base::BaseClass);
     /// set & get the name as string. The alternative is to access the data field using
     /// obj.name.value = "aName"

diff --git a/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseData.cpp b/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseData.cpp
@@ -192,10 +192,24 @@ std::string getValueTypeString(BaseData* data)
     return data->getValueTypeInfo()->name();
 }
 
+auto getPythonClassForBaseData(py::module& m)
+{
+    /// Register the BaseData binding into the pybind11 system.
+    static py::class_<BaseData, std::unique_ptr<sofa::core::objectmodel::BaseData, pybind11::nodelete>> data(m, "Data", sofapython3::doc::baseData::BaseDataClass);
+    return data;
+}
+
+void moduleForwardAddBaseData(py::module& m)
+{
+    getPythonClassForBaseData(m);
+}
+
 void moduleAddBaseData(py::module& m)
 {
     /// Register the BaseData binding into the pybind11 system.
-    py::class_<BaseData, std::unique_ptr<sofa::core::objectmodel::BaseData, pybind11::nodelete>> data(m, "Data", sofapython3::doc::baseData::BaseDataClass);
+    //py::class_<BaseData, std::unique_ptr<sofa::core::objectmodel::BaseData, pybind11::nodelete>> data(m, "Data", sofapython3::doc::baseData::BaseDataClass);
+
+    auto data =getPythonClassForBaseData(m);
     data.def("getName", [](BaseData& b){ return b.getName(); }, sofapython3::doc::baseData::getName);
     data.def("setName", [](BaseData& b, const std::string& s){ b.setName(s); }, sofapython3::doc::baseData::setName);
     data.def("getCounter", [](BaseData& self) { return self.getCounter(); }, sofapython3::doc::baseData::getCounter);

diff --git a/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseData.h b/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseData.h
@@ -24,6 +24,7 @@
 
 namespace sofapython3 {
 
+    void moduleForwardAddBaseData(pybind11::module& m);
     void moduleAddBaseData(pybind11::module& m);
 
 } /// sofapython3
diff --git a/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseLink.cpp b/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseLink.cpp
@@ -91,9 +91,21 @@ void __setattr__(py::object self, const std::string& s, py::object value)
 }
 }
 
+auto getPythonClassForBaseLink(py::module& m)
+{
+    /// Register the BaseData binding into the pybind11 system.
+    static py::class_<BaseLink> link(m, "Link", sofapython3::doc::baseLink::baseLinkClass);
+    return link;
+}
+
+void moduleForwardAddBaseLink(py::module& m)
+{
+    getPythonClassForBaseLink(m);
+}
+
 void moduleAddBaseLink(py::module& m)
 {
-    py::class_<BaseLink> link(m, "Link", sofapython3::doc::baseLink::baseLinkClass);
+    auto link = getPythonClassForBaseLink(m);
     link.def("getName", &BaseLink::getName, sofapython3::doc::baseLink::getName);
     link.def("setName", &BaseLink::setName, sofapython3::doc::baseLink::setName);
     link.def("isMultiLink", &BaseLink::isMultiLink, sofapython3::doc::baseLink::isMultiLink);

diff --git a/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseLink.h b/bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseLink.h
@@ -24,6 +24,7 @@
 
 namespace sofapython3 {
 
+    void moduleForwardAddBaseLink(pybind11::module& m);
     void moduleAddBaseLink(pybind11::module& m);
 
 } /// sofapython3
diff --git a/bindings/Sofa/tests/CMakeLists.txt b/bindings/Sofa/tests/CMakeLists.txt
@@ -10,7 +10,6 @@ set(SOURCE_FILES
 )
 
 set(PYTHON_FILES
-    ${CMAKE_CURRENT_SOURCE_DIR}/Components/Components.py
     ${CMAKE_CURRENT_SOURCE_DIR}/Core/Base.py
     ${CMAKE_CURRENT_SOURCE_DIR}/Core/BaseData.py
     ${CMAKE_CURRENT_SOURCE_DIR}/Core/BaseLink.py
@@ -51,7 +50,6 @@ sofa_auto_set_target_rpath(
 add_test(NAME ${PROJECT_NAME} COMMAND ${PROJECT_NAME})
 
 set(DIR_BINDING_LIST
-    Components
     Core
     Helper
     Simulation

diff --git a/bindings/Sofa/tests/Components/Components.py b/bindings/Sofa/tests/Components/Components.py
diff --git a/bindings/Sofa/tests/PythonModule_Sofa_test.cpp b/bindings/Sofa/tests/PythonModule_Sofa_test.cpp
@@ -58,7 +58,6 @@ static struct PythonModule_Sofa_tests : public PythonTestExtractor
         addTestDirectory(executable_directory+"/Bindings.Sofa.Tests.d/Helper", "Sofa_Helper_");
         addTestDirectory(executable_directory+"/Bindings.Sofa.Tests.d/Simulation", "Sofa_Simulation_");
         addTestDirectory(executable_directory+"/Bindings.Sofa.Tests.d/Types", "Sofa_Types_");
-        addTestDirectory(executable_directory+"/Bindings.Sofa.Tests.d/Components", "Sofa_Components_");
     }
 } python_tests;