[Bindings] Remove static SofaInitializer, call unload into each respective module and clear cache

.github/workflows/ci.yml

@@ -106,9 +106,12 @@ jobs:
  echo "$WORKSPACE_ARTIFACT_PATH/lib" >> $GITHUB_PATH
  echo "$WORKSPACE_ARTIFACT_PATH/bin" >> $GITHUB_PATH
  elif [[ "$RUNNER_OS" == "macOS" ]]; then
+ echo "SOFA_PLUGIN_PATH=$WORKSPACE_ARTIFACT_PATH/lib" | tee -a $GITHUB_ENV
  echo "DYLD_LIBRARY_PATH=$WORKSPACE_ARTIFACT_PATH/lib:$SOFA_ROOT/lib:$DYLD_LIBRARY_PATH" | tee -a $GITHUB_ENV
+ else # Linux
+ echo "SOFA_PLUGIN_PATH=$WORKSPACE_ARTIFACT_PATH/lib" | tee -a $GITHUB_ENV
+ echo "LD_LIBRARY_PATH=$WORKSPACE_ARTIFACT_PATH/lib:$SOFA_ROOT/lib:$LD_LIBRARY_PATH" | tee -a $GITHUB_ENV
  fi
- echo "LD_LIBRARY_PATH=$WORKSPACE_ARTIFACT_PATH/lib:$SOFA_ROOT/lib:$LD_LIBRARY_PATH" | tee -a $GITHUB_ENV
  echo "PYTHONPATH=$WORKSPACE_ARTIFACT_PATH/lib/python3/site-packages" | tee -a $GITHUB_ENV
  # Add execution right on the tests
  chmod +x $WORKSPACE_ARTIFACT_PATH/bin/*.Tests${{ steps.sofa.outputs.exe }}

Plugin/src/SofaPython3/DataHelper.cpp

@@ -249,10 +249,17 @@ py::slice toSlice(const py::object& o)
 
 std::map<void*, std::pair<int, py::array>>& getObjectCache()
 {
- static std::map<void*, std::pair<int, py::array>> s_objectcache {} ;
+ static std::map<void*, std::pair<int, py::array>>  s_objectcache{};
  return s_objectcache;
 }
 
+
+void clearCache()
+{
+ msg_info("SofaPython3") << "Clearing Sofa.Core cache...";
+ getObjectCache().clear();
+}
+
 void trimCache()
 {
  auto& memcache = getObjectCache();

Plugin/src/SofaPython3/DataHelper.h

@@ -194,6 +194,7 @@ SOFAPYTHON3_API std::string getPathTo(Base* b);
 SOFAPYTHON3_API const char* getFormat(const AbstractTypeInfo& nfo);
 
 SOFAPYTHON3_API std::map<void*, std::pair<int, pybind11::array>>& getObjectCache();
+SOFAPYTHON3_API void clearCache();
 SOFAPYTHON3_API void trimCache();
 
 SOFAPYTHON3_API bool hasArrayFor(BaseData* d);

Plugin/src/SofaPython3/PythonEnvironment.cpp

@@ -324,7 +324,10 @@ void PythonEnvironment::Release()
 {
  /// Finish the Python Interpreter
  /// obviously can't use raii here
- if( Py_IsInitialized() ) {
+ static bool isReleased = false;
+ if( Py_IsInitialized() && !isReleased) {
+ isReleased = true;
+
  PyGILState_Ensure();
  py::finalize_interpreter();
  getStaticData()->reset();
@@ -480,6 +483,12 @@ void PythonEnvironment::addPluginManagerCallback()
  }
  }
  );
+ PluginManager::getInstance().addOnPluginCleanupCallbacks(pluginLibraryPath,
+ []()
+ {
+ PythonEnvironment::Release();
+ }
+ );
 }
 
 void PythonEnvironment::removePluginManagerCallback()

Plugin/src/SofaPython3/PythonEnvironment.h

@@ -23,6 +23,7 @@
 #include <vector>
 #include <string>
 #include <sofa/helper/logging/FileInfo.h>
+#include <SofaPython3/DataHelper.h>
 
 /// Fixes compile errors:
 /// removing all slots macros is necessary if embedded in a Qt project

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

@@ -51,6 +51,8 @@ using sofa::helper::logging::Message;
 #include <SofaPython3/Sofa/Core/Data/Binding_DataVectorString.h>
 #include <SofaPython3/Sofa/Core/Data/Binding_DataContainer.h>
 
+#include <sofa/core/init.h>
+
 namespace sofapython3
 {
 
@@ -130,6 +132,18 @@ PYBIND11_MODULE(Core, core)
  moduleAddBaseMeshTopology(core);
  moduleAddPointSetTopologyModifier(core);
  moduleAddTaskScheduler(core);
+
+ // called when the module is unloaded
+ auto atexit = py::module_::import("atexit");
+ atexit.attr("register")(py::cpp_function([]() {
+
+ clearCache();
+
+ sofa::core::cleanup();
+
+ msg_info("SofaPython3.Core") << "Sofa.Core unload()";
+ }));
+
 }
 
 } ///namespace sofapython3

bindings/Sofa/src/SofaPython3/Sofa/Helper/Submodule_Helper.cpp

@@ -18,7 +18,6 @@
 * Contact information: [email protected] *
 ******************************************************************************/
 
-#include <sofa/core/init.h>
 #include <sofa/helper/init.h>
 #include <sofa/helper/logging/Messaging.h>
 #include <SofaPython3/PythonEnvironment.h>
@@ -108,7 +107,6 @@ static void parse_emitter_message_then(py::args args, const Action& action) {
 PYBIND11_MODULE(Helper, helper)
 {
  // These are needed to force the dynamic loading of module dependencies (found in CMakeLists.txt)
- sofa::core::init();
  sofa::helper::init();
 
  helper.doc() = R"doc(
@@ -155,6 +153,12 @@ PYBIND11_MODULE(Helper, helper)
  moduleAddMessageHandler(helper);
  moduleAddVector(helper);
  moduleAddSystem(helper);
+
+ auto atexit = py::module_::import("atexit");
+ atexit.attr("register")(py::cpp_function([]() {
+ sofa::helper::cleanup();
+ msg_info("SofaPython3.Helper") << "Sofa.Helper unload()";
+ }));
 }
 
 } ///namespace sofapython3

bindings/Sofa/src/SofaPython3/Sofa/Simulation/Submodule_Simulation.cpp

@@ -42,6 +42,7 @@ using sofa::simulation::Simulation;
 
 #include <sofa/core/init.h>
 #include <sofa/simulation/init.h>
+#include <sofa/simulation/common/init.h>
 #include <sofa/simulation/graph/init.h>
 
 namespace py = pybind11;
@@ -83,6 +84,17 @@ PYBIND11_MODULE(Simulation, simulation)
  {
  sofa::simulation::node::initTextures(n);
  });
+
+ // called when the module is unloaded
+ auto atexit = py::module_::import("atexit");
+ atexit.attr("register")(py::cpp_function([]() {
+
+ sofa::simulation::core::cleanup();
+ sofa::simulation::common::cleanup();
+ sofa::simulation::graph::cleanup();
+
+ msg_info("SofaPython3.Simulation") << "Sofa.Simulation unload()";
+ }));
 }
 
 } /// namespace sofapython3

bindings/SofaRuntime/src/SofaPython3/SofaRuntime/Module_SofaRuntime.cpp

@@ -72,23 +72,6 @@ using sofa::helper::logging::MainConsoleMessageHandler;
 namespace sofapython3
 {
 
-
-class SofaInitializer
-{
-public:
- // TODO, ces trucs sont fort laid. Normalement ce devrait être une joli plugin qui
- // appelle le init.
- SofaInitializer(){
- sofa::simulation::common::init();
- sofa::simulation::graph::init();
- }
-
- ~SofaInitializer(){
- sofa::simulation::common::cleanup();
- sofa::simulation::graph::cleanup();
- }
-};
-
 static std::vector<std::string> getCategories(const std::string& className)
 {
  std::vector<std::string> categories;
@@ -109,8 +92,6 @@ static std::vector<std::string> getCategories(const std::string& className)
  return categories ;
 }
 
-static SofaInitializer s;
-
 /// The first parameter must be named the same as the module file to load.
 PYBIND11_MODULE(SofaRuntime, m) {
 
@@ -132,13 +113,6 @@ PYBIND11_MODULE(SofaRuntime, m) {
 
  )doc";
 
- // These are needed to force the dynamic loading of module dependencies (found in CMakeLists.txt)
- sofa::core::init();
- sofa::helper::init();
- sofa::simulation::core::init();
- sofa::simulation::graph::init();
- sofa::simulation::common::init();
-
  // Add the plugin directory to PluginRepository
  const std::string& pluginDir = Utils::getExecutableDirectory();
  PluginRepository.addFirstPath(pluginDir);
@@ -198,6 +172,7 @@ PYBIND11_MODULE(SofaRuntime, m) {
  m.def("getCategories", &getCategories);
 
  addSubmoduleTimer(m);
+
 }
 
 } // namespace sofapython3