Merge remote-tracking branch 'upstream/master' into pr-add-createobject-behavior

Author: damienmarchal

.github/workflows/macos.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-10.15]
-        sofa_branch: [master, v21.06]
+        sofa_branch: [master]
     env:
       SOFA_ROOT: /opt/sofa
       SOFA_OS: MacOS

.github/workflows/ubuntu.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-20.04]
-        sofa_branch: [master, v21.06]
+        sofa_branch: [master]
     env:
       SOFA_ROOT: /opt/sofa
       SOFA_OS: Linux

Plugin/CMakeLists.txt

@@ -48,7 +48,7 @@ add_library(SofaPython3::${PROJECT_NAME} ALIAS ${PROJECT_NAME})
 
 target_compile_definitions(${PROJECT_NAME} PRIVATE "-DSOFA_BUILD_SOFAPYTHON3")
 
-target_link_libraries(${PROJECT_NAME} PUBLIC SofaCore SofaDefaultType SofaSimulationCore SofaSimulationGraph SofaHelper)
+target_link_libraries(${PROJECT_NAME} PUBLIC SofaCore SofaDefaultType SofaSimulationCore SofaSimulationGraph Sofa.Helper)
 target_link_libraries(${PROJECT_NAME} PUBLIC pybind11::module pybind11::embed)
 
 if(SP3_BUILD_TEST AND Sofa.Testing_FOUND)

Plugin/src/SofaPython3/PythonEnvironment.cpp

@@ -233,7 +233,15 @@ void PythonEnvironment::Init()
     // Lastly, we (try to) add modules from the root of SOFA
     addPythonModulePathsFromDirectory( Utils::getSofaPathPrefix() );
 
-    py::module::import("SofaRuntime");
+    try
+    {
+        py::module::import("SofaRuntime");
+    }
+    catch (pybind11::error_already_set)
+    {
+        msg_error("SofaPython3") << "Could not import SofaRuntime module, initializing python3 for SOFA is not possible";
+        return;
+    }
     getStaticData()->m_sofamodule = py::module::import("Sofa");
 
 
@@ -255,20 +263,43 @@ void PythonEnvironment::Init()
             pluginLibraryPath = elem.first;
         }
     }
+
+    s_isInitialized = true;
 }
 
-void PythonEnvironment::executePython(std::function<void()> cb)
+// Single implementation for the three different versions
+template<class T>
+void executePython_(const T& emitter, std::function<void()> cb)
 {
     sofapython3::PythonEnvironment::gil acquire;
 
     try{
         cb();
-    }catch(std::exception& e)
+    }catch(py::error_already_set& e)
     {
-        msg_error("SofaPython3") << e.what() ;
+        std::stringstream tmp;
+        tmp << "Unable to execute code." << msgendl
+                     << "Python exception:" << msgendl
+                     << "  " << e.what()
+                     << PythonEnvironment::getPythonCallingPointString();
+        msg_error(emitter) << tmp.str();
     }
 }
 
+void PythonEnvironment::executePython(const std::string& emitter, std::function<void()> cb)
+{
+    return executePython_(emitter, cb);
+}
+
+void PythonEnvironment::executePython(std::function<void()> cb)
+{
+    return executePython_("SofaPython3::executePython", cb);
+}
+
+void PythonEnvironment::executePython(const sofa::core::objectmodel::Base* b, std::function<void()> cb)
+{
+    return executePython_(b, cb);
+}
 
 void PythonEnvironment::Release()
 {

Plugin/src/SofaPython3/PythonEnvironment.h

@@ -59,6 +59,11 @@ class SOFAPYTHON3_API PythonEnvironment
     static void Init();
     static void Release();
 
+    static bool isInitialized()
+    {
+        return s_isInitialized;
+    };
+
     static pybind11::module importFromFile(const std::string& module,
                                      const std::string& path,
                                      pybind11::object* globals = nullptr);
@@ -104,7 +109,11 @@ class SOFAPYTHON3_API PythonEnvironment
     /// excluding a module from automatic reload
     static void excludeModuleFromReload( const std::string& moduleName );
 
-    static void executePython(std::function<void()>);
+    /// execute a function 'f' after acquiring the GIL and having installed
+    /// an handler to catch python exception.
+    static void executePython(std::function<void()> f);
+    static void executePython(const sofa::core::objectmodel::Base* emitter, std::function<void()> f);
+    static void executePython(const std::string& emitter, std::function<void()> cb);
 
     /// to be able to react when a scene is loaded
     struct SceneLoaderListerner : public SceneLoader::Listener
@@ -146,6 +155,7 @@ class SOFAPYTHON3_API PythonEnvironment
 private:
     static PythonEnvironmentData* getStaticData() ;
     static std::string pluginLibraryPath;
+    static inline bool s_isInitialized{false};
 };
 
 } // namespace sofapython3

Plugin/src/SofaPython3/SceneLoaderPY3.cpp

@@ -106,9 +106,11 @@ void SceneLoaderPY3::loadSceneWithArguments(const char *filename,
 
         py::object createScene = module.attr("createScene");
         createScene( PythonFactory::toPython(root_out.get()) );
-    }catch(std::exception& e)
+    }catch(py::error_already_set& e)
     {
-        msg_error() << e.what();
+        msg_error() << "Unable to completely load the scene from file '"<< filename << "'." << msgendl
+                    << "Python exception: " << msgendl
+                    << "  " << e.what();
     }
 
 }

Plugin/src/SofaPython3/initModule.cpp

@@ -37,6 +37,7 @@ SOFAPYTHON3_API const char* getModuleVersion();
 SOFAPYTHON3_API const char* getModuleLicense();
 SOFAPYTHON3_API const char* getModuleDescription();
 SOFAPYTHON3_API const char* getModuleComponentList();
+SOFAPYTHON3_API bool moduleIsInitialized();
 
 void initExternalModule()
 {
@@ -80,4 +81,9 @@ const char* getModuleComponentList()
     return "";
 }
 
+bool moduleIsInitialized()
+{
+    return PythonEnvironment::isInitialized();
+}
+
 }

bindings/Modules/tests/CMakeLists.txt

@@ -14,7 +14,7 @@ find_package(SofaFramework REQUIRED)
 
 enable_testing()
 add_executable(${PROJECT_NAME} ${SOURCE_FILES} ${PYTHON_FILES})
-target_link_libraries(${PROJECT_NAME} SofaGTestMain SofaHelper SofaPython3::Plugin)
+target_link_libraries(${PROJECT_NAME} SofaGTestMain Sofa.Helper SofaPython3::Plugin)
 target_compile_definitions(${PROJECT_NAME} PRIVATE "PYTHON_TESTFILES_DIR=\"${CMAKE_CURRENT_SOURCE_DIR}/\"")
 set_target_properties(${PROJECT_NAME} PROPERTIES FOLDER "Bindings/Tests")
 

bindings/Sofa/package/__init__.py

@@ -34,6 +34,72 @@
 import traceback
 import importlib
 
+print("---------------------------------------")
+print("Checking SOFA_ROOT and SOFAPYTHON3_ROOT")
+
+# check if SOFA_ROOT has been (well) set
+sofa_root = os.environ.get('SOFA_ROOT')
+if sofa_root:
+    print("Using environment variable SOFA_ROOT: " + sofa_root)
+else:
+    print("Warning: environment variable SOFA_ROOT is empty. Trying to guess it.")
+    # try a guess from <sofa_root>/plugins/SofaPython3/lib/python3/site-packages/Sofa
+    sofa_root_guess = os.path.abspath(os.path.dirname(os.path.realpath(__file__)) + '/../../../../../..') 
+    if os.path.isdir(os.path.abspath(sofa_root_guess + '/lib' )):
+        print("Guessed SOFA_ROOT: " + sofa_root_guess)
+        sofa_root = sofa_root_guess
+    else:
+        print("Warning: cannot guess SOFA_ROOT", 
+        "Loading SOFA libraries will likely fail and/or SOFA won't find its resources.")
+
+# check if SOFAPYTHON3_ROOT has been (well) set
+sofapython3_root = os.environ.get('SOFAPYTHON3_ROOT')
+if sofapython3_root:
+    print("Using environment variable SOFAPYTHON3_ROOT: " + sofapython3_root)
+else:
+    print("Warning: environment variable SOFAPYTHON3_ROOT is empty. Trying to guess it.")
+    # try a guess from <sofapython3_root>/lib/python3/site-packages/Sofa
+    sofapython3_root_guess = os.path.abspath(os.path.dirname(os.path.realpath(__file__)) + '/../../../..') 
+    if os.path.isdir(os.path.abspath(sofapython3_root_guess + '/lib' )):
+        print("Guessed SOFAPYTHON3_ROOT: " + sofapython3_root_guess)
+        sofapython3_root = sofapython3_root_guess
+    else:
+        print("Warning: cannot guess SOFAPYTHON3_ROOT", 
+        "Loading SofaPython3 modules will likely fail.")
+
+if sofa_root and sys.platform == 'win32':
+    # Windows-only: starting from python 3.8, python wont read the env. variable PATH to get SOFA's dlls. 
+    # os.add_dll_directory() is the new way to add paths for python to get external libraries.
+    sofa_bin_path = sofa_root + "\\bin"
+    sofa_file_test = sofa_bin_path + "\\Sofa.Helper.dll"
+    sofapython3_bin_path = sofapython3_root + "\\bin"
+    sofapython3_file_test = sofapython3_bin_path + "\\SofaPython3.dll"
+    
+    if not os.path.isfile(sofa_file_test):
+        print("Warning: environment variable SOFA_ROOT is set but seems invalid.",
+        "Loading SOFA libraries will likely fail.")
+        print("SOFA_ROOT is currently: " + sofa_root)
+    if not os.path.isfile(sofapython3_file_test):
+        print("Warning: cannot find SofaPython3.dll at path: " + sofapython3_bin_path)
+        print("This path will NOT be added to the DLL search path.", 
+        "Loading SofaPython3 python modules will likely fail.")
+    
+    if sys.version_info.minor >= 8:
+        # Starting from python3.8 we need to explicitly find SOFA libraries
+        if os.path.isfile(sofa_file_test):
+            os.add_dll_directory(sofa_bin_path)
+        if os.path.isfile(sofapython3_file_test):
+            os.add_dll_directory(sofapython3_bin_path)
+    else:
+        # Add temporarily the bin/lib path to the env variable PATH
+        if os.path.isfile(sofa_file_test):
+            os.environ['PATH'] = sofa_bin_path + os.pathsep + os.environ['PATH']
+        if os.path.isfile(sofapython3_file_test):
+            os.environ['PATH'] = sofapython3_bin_path + os.pathsep + os.environ['PATH']
+
+print("---------------------------------------")
+sys.stdout.flush()
+
 import Sofa.constants
 import Sofa.Helper
 import Sofa.Core

bindings/Sofa/src/SofaPython3/Sofa/Components/CMakeLists.txt

@@ -17,5 +17,5 @@ SP3_add_python_module(
         DESTINATION  Sofa
         SOURCES      ${SOURCE_FILES}
         HEADERS      ${HEADER_FILES}
-        DEPENDS      SofaCore SofaHelper SofaSimulationCore SofaPython3::Plugin
-)
+        DEPENDS      Sofa.Core Sofa.Helper Sofa.SimulationCore SofaPython3::Plugin
+)