Verb

class TagScriptEngine.verb.Verb(verb_string: str | None = None, *, limit: int = 2000, dot_parameter: bool = False)[source]

Bases: _Verb

Represents the passed TagScript block.

Parameters:
  • verb_string (Optional[str]) – The string to parse into a verb.

  • limit (int) – The maximum number of characters to parse.

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

declaration

The text used to declare the block.

Type:

Optional[str]

parameter

The text passed to the block parameter in the parentheses.

Type:

Optional[str]

payload

The text passed to the block payload after the colon.

Type:

Optional[str]

Example

Below is a visual representation of a block and its attributes:

{declaration(parameter):payload}

# dot_parameter = True
{declaration.parameter:payload}