HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pyInterpreter.h File Reference
#include "pxr/pxr.h"
#include "pxr/base/tf/api.h"
#include <hboost/python/handle.hpp>
#include <hboost/python/object.hpp>
#include <string>
+ Include dependency graph for pyInterpreter.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

PXR_NAMESPACE_OPEN_SCOPE
TF_API void 
TfPyInitialize ()
 
TF_API int TfPyRunSimpleString (const std::string &cmd)
 
TF_API hboost::python::handle TfPyRunString (const std::string &cmd, int start, hboost::python::object const &globals=hboost::python::object(), hboost::python::object const &locals=hboost::python::object())
 
TF_API hboost::python::handle TfPyRunFile (const std::string &filename, int start, hboost::python::object const &globals=hboost::python::object(), hboost::python::object const &locals=hboost::python::object())
 
TF_API std::string TfPyGetModulePath (const std::string &moduleName)
 

Detailed Description

Python runtime utilities.

Definition in file pyInterpreter.h.

Function Documentation

TF_API std::string TfPyGetModulePath ( const std::string moduleName)

Returns the disk path to the given module as an NSString.

Starts the interpreter if necessary. Deals with necessary thread state setup.

PXR_NAMESPACE_OPEN_SCOPE TF_API void TfPyInitialize ( )

Starts up the python runtime. IMPORTANT: The GIL will NOT be held when this returns. (If Python is already initialized, the GIL will be unchanged)

The program name and arguments are set automatically. sys.argv has no arguments other than an argv[0] matching the program name.

TF_API hboost::python::handle TfPyRunFile ( const std::string filename,
int  start,
hboost::python::object const globals = hboost::python::object(),
hboost::python::object const locals = hboost::python::object() 
)

Runs the given file using PyRun_File().

start is Py_eval_input, Py_single_input or Py_file_input. globals and locals can be dictionaries to use when evaluating the string in python. Defaults to reusing globals from main module. If only the globals are provided, they will also be used as locals.

Starts the interpreter if necessary. Deals with necessary thread state setup.

TF_API int TfPyRunSimpleString ( const std::string cmd)

Runs the given string using PyRun_SimpleString().

Starts the interpreter if necessary. Deals with necessary thread state setup.

TF_API hboost::python::handle TfPyRunString ( const std::string cmd,
int  start,
hboost::python::object const globals = hboost::python::object(),
hboost::python::object const locals = hboost::python::object() 
)

Runs the given string using PyRun_String().

start is Py_eval_input, Py_single_input or Py_file_input. globals and locals can be dictionaries to use when evaluating the string in python. Defaults to reusing globals from main module. If only the globals are provided, they will also be used as locals.

Starts the interpreter if necessary. Deals with necessary thread state setup.