Interpreter Module

Interpreter

class TagScriptEngine.interpreter.Interpreter(blocks: List[TagScriptEngine.interface.block.Block])

Bases: object

The TagScript interpreter.

blocks

A list of blocks to be used for TagScript processing.

Type:

List[Block]

process(message: str, seed_variables: Optional[Dict[str, TagScriptEngine.interface.adapter.Adapter]] = None, *, charlimit: Optional[int] = None, dot_parameter: bool = False, **kwargs) → TagScriptEngine.interpreter.Response

Processes a given TagScript string.

Parameters:

• message (str) – A TagScript string to be processed.

• seed_variables (Dict[str, Adapter]) – A dictionary containing strings to adapters to provide context variables for processing.

• charlimit (int) – The maximum characters to process.

• dot_parameter (bool) – Whether the parameter should be followed after a “.” or use the default of parantheses.

• kwargs (Dict[str, Any]) – Additional keyword arguments that may be used by blocks during processing.

Returns:

A response object containing the processed body, actions and variables.

Return type:

Response

Raises:

• TagScriptError – A block intentionally raised an exception, most likely due to invalid user input.

• WorkloadExceededError – Signifies the interpreter reached the character limit, if one was provided.

• ProcessError – An unexpected error occurred while processing blocks.

AsyncInterpreter

class TagScriptEngine.interpreter.AsyncInterpreter(blocks: List[TagScriptEngine.interface.block.Block])

Bases: TagScriptEngine.interpreter.Interpreter

An asynchronous subclass of Interpreter that allows blocks to implement asynchronous methods. Synchronous blocks are still supported.

This subclass has no additional attributes from the Interpreter class. See Interpreter for full documentation.

async process(message: str, seed_variables: Optional[Dict[str, TagScriptEngine.interface.adapter.Adapter]] = None, *, charlimit: Optional[int] = None, dot_parameter: bool = False, **kwargs) → TagScriptEngine.interpreter.Response

Asynchronously process a given TagScript string.

This method has no additional attributes from the Interpreter class. See Interpreter.process for full documentation.

Context

class TagScriptEngine.interpreter.Context(verb: TagScriptEngine.verb.Verb, res: TagScriptEngine.interpreter.Response, interpreter: TagScriptEngine.interpreter.Interpreter, og: str)

Bases: object

An object containing data on the TagScript block processed by the interpreter. This class is passed to adapters and blocks during processing.

verb

The Verb object representing a TagScript block.

Type:

Verb

original_message

The original message passed to the interpreter.

Type:

str

interpreter

The interpreter processing the TagScript.

Type:

Interpreter

Response

class TagScriptEngine.interpreter.Response(*, variables: Optional[Dict[str, TagScriptEngine.interface.adapter.Adapter]] = None, extra_kwargs: Optional[Dict[str, Any]] = None)

Bases: object

An object containing information on a completed TagScript process.

body

The cleaned message with all verbs interpreted.

Type:

str

actions

A dictionary that blocks can access and modify to define post-processing actions.

Type:

Dict[str, Any]

variables

A dictionary of variables that blocks such as the LooseVariableGetterBlock can access.

Type:

Dict[str, Adapter]

extra_kwargs

A dictionary of extra keyword arguments that blocks can use to define their own behavior.

Type:

Dict[str, Any]

Node

class TagScriptEngine.interpreter.Node(coordinates: Tuple[int, int], verb: Optional[TagScriptEngine.verb.Verb] = None)

Bases: object

A low-level object representing a bracketed block.

coordinates

The start and end position of the bracketed text block.

Type:

Tuple[int, int]

verb

The determined Verb for this node.

Type:

Optional[Verb]

output

The Block processed output for this node.

build_node_tree

TagScriptEngine.interpreter.build_node_tree(message: str) → List[TagScriptEngine.interpreter.Node]

Function that finds all possible nodes in a string.

Returns:

A list of all possible text bracket blocks.

Return type:

List[Node]