1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
#include <BALL/PYTHON/pyInterpreter.h>
#include <BALL/FORMAT/lineBasedFile.h>
#include <BALL/PYTHON/BALLPythonConfig.h>
#include <BALL/PYTHON/pyCAPIKernel.h>
using std::string;
using std::tie;
using std::unique_ptr;
namespace BALL
{
unique_ptr<PyKernel> PyInterpreter::kernel_(nullptr);
unique_ptr<PyServer> PyInterpreter::server_(nullptr);
PyInterpreter::PathStrings PyInterpreter::sys_path_;
void PyInterpreter::finalize()
{
kernel_.reset();
}
void PyInterpreter::initialize()
{
// finalize the interpreter if it is already running
if(kernel_) finalize();
kernel_.reset(new PyCAPIKernel());
// import sys
run("import sys");
// Add the BALL library path to the Python search path
// to make sure Python can find the BALL extensions.
Path p;
#ifndef BALL_COMPILER_MSVC
run("sys.path.append('" BALL_PATH "/lib/')");
#ifdef BALL_OS_DARWIN
// on MacOS, try to find the python packages in the frameworks directory of our bundle
String site_path = String(p.find("../Frameworks"));
if (site_path != "")
sys_path_.push_back(site_path);
#endif
#else
// first, make sure that the site packages of our python installation will be found
String site_path = String(p.find("Python\\lib"));
site_path.trim();
while (site_path.substitute("\\", "/") != String::EndPos) {};
if (site_path != "")
sys_path_.push_back(site_path);
// on windows, we put our python packages one step above the data directory
String python_path = String(p.find("..\\BALL.py")).before("BALL.py");
python_path.trim();
while (python_path.substitute("\\", "/") != String::EndPos) {};
if (python_path != "")
sys_path_.push_back(python_path);
#endif
// Add additional paths (user-defined) to the end of the search path.
for (const auto& s: sys_path_)
{
run(string("sys.path.append(\"") + s.c_str() + "\")");
}
// make sure that we found the correct sip version
run("import sip");
bool ok;
string res;
tie(ok, res) = run("sys.stdout.write(str(sip.SIP_VERSION))");
unsigned long module_sip_version = 0ul;
try
{
module_sip_version = std::stoul(res);
}
catch(const std::invalid_argument& e)
{
Log.error() << "[PyInterpreter] ERROR: Could not read SIP version string" << std::endl;
}
string module_sip_version_str;
tie(ok, module_sip_version_str) = run("sys.stdout.write(sip.SIP_VERSION_STR)");
auto module_major_minor = module_sip_version & 0xFFFFFF00;
auto module_bugfix = module_sip_version & 0x000000FF;
unsigned ball_major_minor = BALL_SIP_VERSION & 0xFFFFFF00;
unsigned ball_bugfix = BALL_SIP_VERSION & 0x000000FF;
if ((module_major_minor != ball_major_minor) || (module_bugfix < ball_bugfix))
{
tie(ok, res) = run("sip");
Log.error() << "[PyInterpreter] ERROR: Version of imported sip module is not compatible with "
<< "the version BALL was built against.\n"
<< "If BALL was compiled using SIP version x.y.z then it can be used with any SIP "
<< "version x.y.z' where 'z' >= z.\n"
<< "Got (from " + res + ") " + module_sip_version_str + "; Expected "
<< BALL_SIP_VERSION_STR << std::endl;
finalize();
return;
}
// import the BALL module
tie(ok, res) = run("from BALL import *");
if (!ok)
{
Log.error() << "[PyInterpreter] ERROR: Could not import the BALL library! "
<< "No Python support available." << std::endl;
finalize();
}
}
std::pair<bool, string> PyInterpreter::run(const string& s)
{
if (!isInitialized())
{
Log.error() << "[PyInterpreter] ERROR: Interpreter is not initialized; "
<< "Code cannot be executed." << std::endl;
return { false, "" };
}
auto res = kernel_->run(s);
if (!res.first) Log.error() << "[PyInterpreter] ERROR: " << kernel_->getErrorMessage() << std::endl;
return res;
}
String PyInterpreter::run(const String& s, bool& state)
{
String ret;
tie(state, ret) = run(string(s.c_str()));
return ret;
}
String PyInterpreter::runFile(const String& filename)
{
if (!isInitialized()) return "";
kernel_->runFile(filename.c_str());
return "";
}
bool PyInterpreter::execute(const string& module, const string& func_name, const PyKernel::KeyValArgs& params)
{
if (!isInitialized())
{
Log.error() << "[PyInterpreter] ERROR: Interpreter is not initialized; "
<< func_name << " cannot be executed." << std::endl;
return false;
}
return kernel_->execute(module, func_name, params);
}
bool PyInterpreter::execute(const QString& module, const QString& func_name, const QList<QPair<QString, QString> >& params)
{
if (!isInitialized()) return false;
PyKernel::KeyValArgs args;
for (const auto& pair: params)
{
if (pair.first == "action" || pair.first == "module" || pair.first == "method") continue;
args[pair.first.toStdString()] = pair.second.toStdString();
}
return execute(module.toStdString(), func_name.toStdString(), args);
}
string PyInterpreter::getErrorMessage()
{
return isInitialized() ? kernel_->getErrorMessage() : "Interpreter is not initialized";
}
void PyInterpreter::startServer()
{
if (!isInitialized())
{
Log.error() << "[PyInterpreter] ERROR: Interpreter is not initialized; "
<< "refusing to start PyServer" << std::endl;
return;
}
// Server is already running
if (serverIsRunning()) return;
server_.reset(new PyServer);
}
void PyInterpreter::stopServer()
{
// Server is not running
if (!serverIsRunning()) return;
server_.reset();
}
} // namespace BALL
|