BALL::PyInterpreter Class Reference
[Python extensions]
#include <BALL/PYTHON/pyInterpreter.h>
List of all members.
Detailed Description
Embedded Python interpreter. There's just one global instance of the interpreter, so all methods are static. The use of subinterpreters is not yet supported.
Member Typedef Documentation
Used to encode the individual paths appended to sys.path for dynamic loading of modules.
Constructor & Destructor Documentation
BALL::PyInterpreter::PyInterpreter |
( |
|
) |
[private] |
BALL::PyInterpreter::~PyInterpreter |
( |
|
) |
[inline, private] |
Member Function Documentation
static void BALL::PyInterpreter::finalize |
( |
|
) |
[static] |
Stop the interpreter. Deallocate all memory occupied by the interpreter (by calling PY_Finalize
.
static String BALL::PyInterpreter::getStartupLog |
( |
|
) |
[inline, static] |
static const PathStrings& BALL::PyInterpreter::getSysPath |
( |
|
) |
[static] |
Get the current paths added to sys.path.
static bool BALL::PyInterpreter::importModule |
( |
const String & |
module_name |
) |
[static] |
Import a module. The module with name module_name
is imported using PyImport_ImportModule
and initialized. When called
- Returns:
- true if the modules was found an initialized correctly
static void BALL::PyInterpreter::initialize |
( |
|
) |
[static] |
Initialize the interpreter. Initialize the interpreter (by calling Py_Initialize
) and load the modules sys
, site
, and BALL
. A second call to initialize
may be used to restart the intepreter. Upon start, the paths defined by setSysPath are added to sys.path. If your interpreter cannot load specific modules, add the location of your modules here.
static bool BALL::PyInterpreter::isInitialized |
( |
|
) |
[static] |
Determine the interpreter state.
- Returns:
- true if the interpreter is correctly initialized
static bool BALL::PyInterpreter::isValid |
( |
|
) |
[inline, static] |
static String BALL::PyInterpreter::run |
( |
const String & |
s, |
|
|
bool & |
result | |
|
) |
| | [static] |
Execute a string.
- Parameters:
-
| s | the string to run (may contain multiple lines with correct indentation) |
| result | bool reference which contains the result after call of function |
- Returns:
- the output of the interpreter (may also contain error messages)
Run a Python program from a file.
- Parameters:
-
| file_name | the name of the program file |
static void BALL::PyInterpreter::setSysPath |
( |
const PathStrings & |
path_strings |
) |
[static] |
Append additional search paths to sys.path upon initialization.
Member Data Documentation