PY/PY_Python.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 *      This file contains functions to run python code.
 */

#ifndef __PY_Python_h__
#define __PY_Python_h__

#include "PY_API.h"
#include "PY_Result.h"
#include <UT/UT_String.h>
class PY_EvaluationContext;

// Expressions cannot contain multiple statements (defs, classes, print
// statements, etc.) and they cannot contain multiple expressions.
PY_API PY_Result PYrunPythonExpression(
    const char *python_code, PY_Result::Type desired_result_type,
    PY_EvaluationContext *context = NULL);

// The result type from running statements in the current thread can
// be none (indicating normal completion), error, or exit.
PY_API PY_Result PYrunPythonStatements(
    const char *python_code,
    PY_EvaluationContext *context = NULL);
PY_API PY_Result PYrunPythonStatementsFromFile(
    const char *filename,
    PY_EvaluationContext *context = NULL);

// This version of PYrunPythonStatementsFromFile will set Python's
// sys.argv to the arguments you supply.  argv[0] will be the name of the
// Python file.
PY_API PY_Result PYrunPythonStatementsFromFile(
    int argc, char *argv[],
    PY_EvaluationContext *context = NULL);
PY_API PY_Result PYrunPythonStatements(
    const char *python_code,
    int argc, char *argv[],
    PY_EvaluationContext *context = NULL);

// A non-empty string is returned if there are parse errors, a new thread
// could not be started, or the file could not be loaded.
PY_API UT_String PYrunPythonStatementsInNewThread(
    const char *python_code);
PY_API UT_String PYrunPythonStatementsFromFileInNewThread(
    const char *file_name);

// Return the python result containing a stack trace and exception information.
// If no exception occurred, the result type is none.
PY_API PY_Result PYextractPythonException();

// Given a python object and a desired type, try to convert it to that type.
// python_object should be a PyObject*, but it's a void* to avoid having to
// include Python.h from here.
//
// There are two versions: a performance-sensitive version that takes the
// return PY_Result object by reference, and a convenience version one that
// returns it by value.
PY_API PY_Result PYextractResultFromPythonObject(
    void *opaque_python_object, PY_Result::Type desired_result_type);
PY_API void PYextractResultFromPythonObject(
    void *opaque_python_object, PY_Result::Type desired_result_type,
    PY_Result &result);

// We don't want to have to prefix things with "hou." in expressions.
// So, we create a separate evaluation context for expressions where
// "from hou import *" has been run.
PY_API PY_EvaluationContext &PYgetPythonExpressionEvaluationContext();

// Given a string containing the contents of a module and the module's name,
// compile the string and import that as a module.  If no exception occurred,
// the result type is none.
PY_API PY_Result PYimportModuleFromString(
    const char *module_name, const char *module_contents);

// Return a PyCodeObject * corresponding to the frame before the current eval
// frame.
PY_API void *PYgetCodeObjectForPrevFrame();

// Return a PyCodeObject * corresponding to the specified PyObject
PY_API void *PYgetCodeObjectForFunction(void *opaque_python_object);

// This function controls whether running Python code automatically sets the
// HOM_Module implementation (by importing the hou Python module).  Call
// PYsetAutoInitializeFromPython to false if you don't hou to be imported
// automatically; otherwise, it will.  You must call this static method
// before running any Python code.  Once any Python code is run, this
// setting has no effect.
PY_API void PYsetAutoInitializeFromPython(bool auto_initialize);

// This function is used by PY_InterpreterAutoLock to determine if
// it should automatically import the hou module
PY_API bool PYautoInitializeFromPython();

#endif

---