Context Class Reference

Global python scripting context. More...

Inherits INativeHandle.

Public Member Functions
void	Dispose ()
	IDisposable implementation.
void	AppendSysPath (string path)
	Adds additional items to the python search path.
PythonObject	GetItem (string itemName)
	Get the given itemName from this context. Use this to get function and type objects from evaluated code.
PythonObject	Import (string moduleName)
	Imports the given python moduleName .
PythonObject	Eval (string code, string fileName="<string>")
	Compiles and evaluates the given python code .

Static Public Member Functions
static Context	CreateOrGet ()
	Creates (or retrieves) the process-wide PyScript context for the chosen environment.

Properties
Version	InterpreterVersion [get]
	Gets the Python interpreter version.
IntPtr	Handle [get]
	Native handle of the Context.
bool	IsDisposed [get]
	Gets if the native handle has been disposed.

Events
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method.
Events inherited from INativeHandle
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method.

Detailed Description

Global python scripting context.

Member Function Documentation

AppendSysPath()

void AppendSysPath

(

string

path

)

Adds additional items to the python search path.

Parameters

path	Path to add.

Exceptions

ArgumentNullException

When path is null.

CreateOrGet()

static Context CreateOrGet ( )

static

Creates (or retrieves) the process-wide PyScript context for the chosen environment.

The context automatically attaches to the interpreter found on the command line. This may be a system package or pyenv.If a virtual environment is activated, the context will try to attach to this environment, and falls back to the base python if there is an error.

Exceptions

CvbException

When an error during context creation occurred.

Eval()

PythonObject Eval	(	string	code,
		string	fileName = "<string>" )

Compiles and evaluates the given python code .

Parameters

code	The code to compile and evaluate.
fileName	The filename to use for the evaluated code.

Returns

A code object - usually not needed. Function and type objects from the evaluated code are available as attributes from the returned object.

Exceptions

ArgumentNullException

When code is null.

GetItem()

PythonObject GetItem

(

string

itemName

)

Get the given itemName from this context. Use this to get function and type objects from evaluated code.

Parameters

itemName

The item to get.

Returns

The item.

Exceptions

ArgumentNullException

When itemName is null.

Import()

PythonObject Import

(

string

moduleName

)

Imports the given python moduleName .

Parameters

moduleName

Name of the module to import.

Returns

The module object. Function and type objects from the module code are available as attributes from the returned module object.

Exceptions

ArgumentNullException

Event Documentation

ObjectDisposing

NativeHandleEventDelegate ObjectDisposing

Raised when this object is about to be disposed via the IDisposable.Dispose method.

This event is raised right before this object is disposed. The dispose itself cannot be canceled.