Skip to main content

RuntimeSnippetsFacade

Agent Runtimes

Agent Runtimes / jupyter/exec/Snippets / RuntimeSnippetsFacade

Class: RuntimeSnippetsFacade

Defined in: src/jupyter/exec/Snippets.ts:55

Facade to interact with kernels by requesting code execution.

Constructors​

Constructor​

new RuntimeSnippetsFacade(language): RuntimeSnippetsFacade

Defined in: src/jupyter/exec/Snippets.ts:84

Create a kernel snippet generator for a given kernel language.

Parameters​

language​

string

Kernel language

Returns​

RuntimeSnippetsFacade

Accessors​

language​

Get Signature​

get language(): string

Defined in: src/jupyter/exec/Snippets.ts:94

Kernel language

Returns​

string

Methods​

changeCurrentWorkingDirectory()​

changeCurrentWorkingDirectory(path): string

Defined in: src/jupyter/exec/Snippets.ts:106

Code snippet to change the current working directory.

The code snippet has no returned value.

Parameters​

path​

string

New current directory

Returns​

string

The code snippet

getOutputCandidates()​

getOutputCandidates(code): string[]

Defined in: src/jupyter/exec/Snippets.ts:151

Extract output variables candidates by parsing the cell content.

Parameters​

code​

string

Cell code source

Returns​

string[]

The output variable candidates

listVariables()​

listVariables(): string

Defined in: src/jupyter/exec/Snippets.ts:117

Code snippet to list the transferable kernel variables.

Returns​

string

The code snippet

loadVariables()​

loadVariables(variables): string

Defined in: src/jupyter/exec/Snippets.ts:127

Code snippet to load kernel variables.

Parameters​

variables​

string

Serialized-JSON dictionary (, )

Returns​

string

The code snippet

saveVariables()​

saveVariables(variables): string

Defined in: src/jupyter/exec/Snippets.ts:139

Code snippet to save kernel variables.

Parameters​

variables​

string[]

Variable names.

Returns​

string

The code snippet

register()​

static register(language, API): void

Defined in: src/jupyter/exec/Snippets.ts:64

Register a facade for a given language

Parameters​

language​

string

Kernel language

API​

IRuntimeSnippets

Kernel API

Returns​

void

supports()​

static supports(language): boolean

Defined in: src/jupyter/exec/Snippets.ts:73

Whether there is an API for the given kernel language

Parameters​

language​

string

Kernel language

Returns​

boolean