Package io.deephaven.integrations.python

Class PythonDeephavenSession

java.lang.Object

io.deephaven.util.referencecounting.ReferenceCounted

io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

io.deephaven.engine.liveness.ReferenceCountedLivenessNode

io.deephaven.engine.liveness.LivenessScope

io.deephaven.engine.util.AbstractScriptSession<PythonDeephavenSession.PythonSnapshot>

io.deephaven.integrations.python.PythonDeephavenSession

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, ReleasableLivenessManager, ScriptSession, VariableProvider, Serializable

public class PythonDeephavenSession
extends AbstractScriptSession<PythonDeephavenSession.PythonSnapshot>

A ScriptSession that uses a JPy cpython interpreter internally.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PythonDeephavenSession.PythonSnapshot

Nested classes/interfaces inherited from class io.deephaven.engine.util.AbstractScriptSession

AbstractScriptSession.ScriptSessionQueryScope, AbstractScriptSession.Snapshot, AbstractScriptSession.SynchronizedScriptSessionQueryScope, AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

Nested classes/interfaces inherited from interface io.deephaven.engine.util.ScriptSession

ScriptSession.Changes, ScriptSession.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static String	SCRIPT_TYPE

Fields inherited from class io.deephaven.engine.util.AbstractScriptSession

executionContext

Constructor Summary

Constructors

Constructor	Description
PythonDeephavenSession(UpdateGraph updateGraph, OperationInitializer operationInitializer, ThreadInitializationFactory threadInitializationFactory, PythonScope<?> scope)	Creates a Python "ScriptSession", for use where we should only be reading from the scope, such as an IPython kernel session.
PythonDeephavenSession(UpdateGraph updateGraph, OperationInitializer operationInitializer, ThreadInitializationFactory threadInitializationFactory, ObjectTypeLookup objectTypeLookup, @Nullable ScriptSession.Listener listener, boolean runInitScripts, PythonEvaluatorJpy pythonEvaluator)	Create a Python ScriptSession.

Method Summary

Modifier and Type	Method	Description
protected ScriptSession.Changes	createDiff(PythonDeephavenSession.PythonSnapshot from, PythonDeephavenSession.PythonSnapshot to, RuntimeException e)
protected PythonDeephavenSession.PythonSnapshot	emptySnapshot()
protected void	evaluate(String command, String scriptName)	Evaluates command in the context of the current ScriptSession.
@NotNull Object	getVariable(String name)	Retrieve a variable from the script session's bindings.
<T> T	getVariable(String name, T defaultValue)	Retrieve a variable from the script session's bindings.
Set<String>	getVariableNames()	Retrieves all of the variable names present in the session's scope
Map<String,Object>	getVariables()	Retrieves all of the variables present in the session's scope (e.g., Groovy binding, Python globals()).
boolean	hasVariableName(String name)	Check if the scope has the given variable name
QueryScope	newQueryScope()
void	popScope()
void	pushScope(org.jpy.PyObject pydict)
String	scriptType()
void	setVariable(String name, @Nullable Object newValue)	Inserts a value into the script's scope.
protected PythonDeephavenSession.PythonSnapshot	takeSnapshot()
Object	unwrapObject(Object object)	Asks the session to remove any wrapping that exists on scoped objects so that clients can fetch them.

Methods inherited from class io.deephaven.engine.util.AbstractScriptSession

applyVariableChangeToDiff, createScriptCache, destroy, evaluateScript, evaluateScript, getExecutionContext, getTableDefinition, getVariableProvider, getVariableType, observeScopeChanges, publishInitial

Methods inherited from class io.deephaven.engine.liveness.LivenessScope

release, transferTo

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessNode

getWeakReference, initializeTransientFieldsForLiveness, onReferenceCountAtZero, tryManage, tryUnmanage, tryUnmanage

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

dropReference, tryRetainReference

Methods inherited from class io.deephaven.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, forceReferenceCountToZero, getReferenceCountDebug, incrementReferenceCount, resetReferenceCount, toString, tryDecrementReferenceCount, tryIncrementReferenceCount

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.deephaven.engine.liveness.LivenessManager

manage, tryManage

Methods inherited from interface io.deephaven.engine.liveness.LivenessNode

tryUnmanage, tryUnmanage, unmanage, unmanage

Methods inherited from interface io.deephaven.engine.liveness.LivenessReferent

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

Methods inherited from interface io.deephaven.engine.liveness.ReleasableLivenessManager

release

Methods inherited from interface io.deephaven.engine.util.ScriptSession

evaluateScript, sanitizeThrowable

Field Details

SCRIPT_TYPE

public static String SCRIPT_TYPE

Constructor Details

PythonDeephavenSession

public PythonDeephavenSession(UpdateGraph updateGraph,
 OperationInitializer operationInitializer,
 ThreadInitializationFactory threadInitializationFactory,
 ObjectTypeLookup objectTypeLookup,
 @Nullable
 @Nullable ScriptSession.Listener listener,
 boolean runInitScripts,
 PythonEvaluatorJpy pythonEvaluator)
                       throws IOException

Create a Python ScriptSession.

Parameters:

updateGraph - the default update graph to install for the repl

operationInitializer - the default operation initializer to install for the repl

objectTypeLookup - the object type lookup

listener - an optional listener that will be notified whenever the query scope changes

runInitScripts - if init scripts should be executed

pythonEvaluator -

Throws:

IOException - if an IO error occurs running initialization scripts

PythonDeephavenSession

public PythonDeephavenSession(UpdateGraph updateGraph,
 OperationInitializer operationInitializer,
 ThreadInitializationFactory threadInitializationFactory,
 PythonScope<?> scope)

Creates a Python "ScriptSession", for use where we should only be reading from the scope, such as an IPython kernel session.

Method Details

newQueryScope

@VisibleForTesting
public QueryScope newQueryScope()

Specified by:

newQueryScope in class AbstractScriptSession<PythonDeephavenSession.PythonSnapshot>

Returns:

a query scope for this session; only invoked during construction

getVariable

@NotNull
public @NotNull Object getVariable(String name)
                            throws QueryScope.MissingVariableException

Description copied from interface: ScriptSession

Retrieve a variable from the script session's bindings.

Please use ScriptSession.getVariable(String, Object) if you expect the variable may not exist.

Parameters:

name - the variable to retrieve

Returns:

the variable

Throws:

QueryScope.MissingVariableException - if the variable does not exist

getVariable

public <T> T getVariable(String name,
 T defaultValue)

Description copied from interface: ScriptSession

Retrieve a variable from the script session's bindings. If the variable is not present, return defaultValue. If the variable is present, but is not of type (T), a ClassCastException may result.

Type Parameters:

T - the type of the variable

Parameters:

name - the variable to retrieve

defaultValue - the value to use when no value is present in the session's scope

Returns:

the value of the variable, or defaultValue if not present

pushScope

@ScriptApi
public void pushScope(org.jpy.PyObject pydict)

popScope

@ScriptApi
public void popScope()

evaluate

protected void evaluate(String command,
 String scriptName)

Description copied from class: AbstractScriptSession

Evaluates command in the context of the current ScriptSession.

Specified by:

evaluate in class AbstractScriptSession<PythonDeephavenSession.PythonSnapshot>

Parameters:

command - the command to evaluate

scriptName - an optional script name, which may be ignored by the implementation, or used improve error messages or for other internal purposes

getVariables

public Map<String,Object> getVariables()

Description copied from interface: ScriptSession

Retrieves all of the variables present in the session's scope (e.g., Groovy binding, Python globals()).

Returns:

an unmodifiable map with variable names as the keys, and the Objects as the result

emptySnapshot

protected PythonDeephavenSession.PythonSnapshot emptySnapshot()

Specified by:

emptySnapshot in class AbstractScriptSession<PythonDeephavenSession.PythonSnapshot>

takeSnapshot

protected PythonDeephavenSession.PythonSnapshot takeSnapshot()

Specified by:

takeSnapshot in class AbstractScriptSession<PythonDeephavenSession.PythonSnapshot>

createDiff

protected ScriptSession.Changes createDiff(PythonDeephavenSession.PythonSnapshot from,
 PythonDeephavenSession.PythonSnapshot to,
 RuntimeException e)

Specified by:

createDiff in class AbstractScriptSession<PythonDeephavenSession.PythonSnapshot>

getVariableNames

public Set<String> getVariableNames()

Description copied from interface: ScriptSession

Retrieves all of the variable names present in the session's scope

Returns:

an unmodifiable set of variable names

hasVariableName

public boolean hasVariableName(String name)

Description copied from interface: ScriptSession

Check if the scope has the given variable name

Parameters:

name - the variable name

Returns:

True iff the scope has the given variable name

setVariable

public void setVariable(String name,
 @Nullable
 @Nullable Object newValue)

Description copied from interface: ScriptSession

Inserts a value into the script's scope.

Parameters:

name - the variable name to set

newValue - the new value of the variable

scriptType

public String scriptType()

Returns:

a textual description of this script session's language for use in messages.

unwrapObject

public Object unwrapObject(Object object)

Description copied from interface: ScriptSession

Asks the session to remove any wrapping that exists on scoped objects so that clients can fetch them. Defaults to returning the object itself.

Parameters:

object - the scoped object

Returns:

an obj which can be consumed by a client