Skip to content

[Plugin] Refactor PythonEnvironment init #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fredroy merged 1 commit into from
Sep 23, 2021
Merged

[Plugin] Refactor PythonEnvironment init #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 38 additions & 40 deletions Plugin/src/SofaPython3/PythonEnvironment.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,17 +221,17 @@ void PythonEnvironment::Init()
while(std::getline(ss, path, ':'))
{
if (FileSystem::exists(path))
addPythonModulePathsForPlugins(path);
addPythonModulePathsFromDirectory(path);
else
msg_warning("SofaPython3") << "no such directory: '" + path + "'";
}
}

// Add sites-packages wrt the plugin
addPythonModulePathsForPluginsByName("SofaPython3");
addPythonModulePathsFromPlugin("SofaPython3");

// Lastly, we (try to) add modules from the root of sofa
addPythonModulePathsFromSofaRoot();
// Lastly, we (try to) add modules from the root of SOFA
addPythonModulePathsFromDirectory( Utils::getSofaPathPrefix() );

py::module::import("SofaRuntime");
getStaticData()->m_sofamodule = py::module::import("Sofa");
Expand Down Expand Up @@ -313,42 +313,44 @@ void PythonEnvironment::addPythonModulePathsFromConfigFile(const std::string& pa
}
}

void PythonEnvironment::addPythonModulePathsForPlugins(const std::string& pluginsDirectory)
void PythonEnvironment::addPythonModulePathsFromDirectory(const std::string& directory)
{
bool added = false;
if ( ! (FileSystem::exists(directory) && FileSystem::isDirectory(directory)) )
{
return;
}

std::vector<std::string> pythonDirs = {
pluginsDirectory,
pluginsDirectory + "/lib",
pluginsDirectory + "/python3"
std::vector<std::string> searchDirs = {
directory,
directory + "/lib",
directory + "/python3"
};

/// Iterate in the pluginsDirectory and add each sub directory with a 'python' name
/// this is mostly for in-tree builds.
// Iterate in the pluginsDirectory and add each sub directory with a 'python' name
// this is mostly for in-tree builds.
std::vector<std::string> files;
FileSystem::listDirectory(pluginsDirectory, files);
FileSystem::listDirectory(directory, files);
for (std::vector<std::string>::iterator i = files.begin(); i != files.end(); ++i)
{
const std::string pluginSubdir = pluginsDirectory + "/" + *i;
if (FileSystem::exists(pluginSubdir) && FileSystem::isDirectory(pluginSubdir))
const std::string subdir = directory + "/" + *i;
if (FileSystem::exists(subdir) && FileSystem::isDirectory(subdir))
{
pythonDirs.push_back(pluginSubdir + "/python3");
searchDirs.push_back(subdir + "/python3");
}
}

/// For each of the directories in pythonDirs, search for a site-packages entry
for(std::string pythonDir : pythonDirs)
// For each of the directories in pythonDirs, search for a site-packages entry
for(std::string searchDir : searchDirs)
{
// Search for a subdir "site-packages"
if (FileSystem::exists(pythonDir+"/site-packages") && FileSystem::isDirectory(pythonDir+"/site-packages"))
if (FileSystem::exists(searchDir + "/site-packages") && FileSystem::isDirectory(searchDir + "/site-packages"))
{
addPythonModulePath(pythonDir+"/site-packages");
added = true;
addPythonModulePath(searchDir + "/site-packages");
}
}
}

void PythonEnvironment::addPythonModulePathsForPluginsByName(const std::string& pluginName)
void PythonEnvironment::addPythonModulePathsFromPlugin(const std::string& pluginName)
{
std::map<std::string, Plugin>& map = PluginManager::getInstance().getPluginMap();
for( const auto& elem : map)
Expand All @@ -357,40 +359,36 @@ void PythonEnvironment::addPythonModulePathsForPluginsByName(const std::string&
if ( p.getModuleName() == pluginName )
{
std::string pluginLibraryPath = elem.first;
// moduleRoot should be 2 levels above the library (plugin_name/lib/plugin_name.so)
std::string moduleRoot = FileSystem::getParentDirectory(FileSystem::getParentDirectory(pluginLibraryPath));

addPythonModulePathsForPlugins(moduleRoot);
// moduleRoot can be 1 or 2 levels above the library directory
// like "plugin_name/lib/plugin_name.so"
// or "sofa_root/bin/Release/plugin_name.dll"
std::string moduleRoot = FileSystem::getParentDirectory(pluginLibraryPath);
int maxDepth = 0;
while(!FileSystem::exists(moduleRoot + "/lib") && maxDepth < 2)
{
moduleRoot = FileSystem::getParentDirectory(moduleRoot);
maxDepth++;
}

addPythonModulePathsFromDirectory(moduleRoot);
return;
}
}
msg_info("SofaPython3") << pluginName << " not found in PluginManager's map.";
}

void PythonEnvironment::addPythonModulePathsFromSofaRoot()
{
// this will either use SOFA_ROOT (very often in install mode)
// or if SOFA_ROOT is not set (very often in build-mode), using the root of the build-dir
// to find /lib/python3/site-packages
const auto sofaRoot = Utils::getSofaPathPrefix();

if (FileSystem::exists(sofaRoot + "/lib/python3/site-packages"))
{
addPythonModulePath(sofaRoot + "/lib/python3/site-packages");
}
}

void PythonEnvironment::addPluginManagerCallback()
{
PluginManager::getInstance().addOnPluginLoadedCallback(pluginLibraryPath,
[](const std::string& pluginLibraryPath, const Plugin& plugin) {
// WARNING: loaded plugin must be organized like plugin_name/lib/plugin_name.so
// search for plugin with PluginRepository
for ( auto path : sofa::helper::system::PluginRepository.getPaths() )
{
std::string pluginRoot = FileSystem::cleanPath( path + "/" + plugin.getModuleName() );
if ( FileSystem::exists(pluginRoot) && FileSystem::isDirectory(pluginRoot) )
{
addPythonModulePathsForPlugins(pluginRoot);
addPythonModulePathsFromDirectory(pluginRoot);
return;
}
}
Expand Down
5 changes: 2 additions & 3 deletions Plugin/src/SofaPython3/PythonEnvironment.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,8 @@ class SOFAPYTHON3_API PythonEnvironment

/// Add all the directories matching <pluginsDirectory>/*/python to sys.path
/// NB: can also be used for projects <projectDirectory>/*/python
static void addPythonModulePathsForPlugins(const std::string& pluginsDirectory);
static void addPythonModulePathsForPluginsByName(const std::string& pluginName);
static void addPythonModulePathsFromSofaRoot();
static void addPythonModulePathsFromDirectory(const std::string& directory);
static void addPythonModulePathsFromPlugin(const std::string& pluginName);

/// set the content of sys.argv.
static void setArguments(const std::string& filename,
Expand Down