Scripts

parse_script

bare_script.parse_script(script_text, start_line_number=1, script_name=None)

Parse a BareScript script

Parameters:

  • script_text (str or Iterable(str)) – The script text

  • start_line_number (int, optional) – The script’s starting line number

  • script_name (str or None, optional) – The script name

Returns:

The BareScript model

Return type:

dict

Raises:

BareScriptParserError – A parsing error occurred

execute_script

bare_script.execute_script(script, options=None)

Execute a BareScript model

Parameters:
Returns:

The script result

Raises:

BareScriptRuntimeError – A script runtime error occurred

validate_script

bare_script.validate_script(script)

Validate a BareScript script model

Parameters:

script (dict) – The BareScript model

Returns:

The validated BareScript model

Return type:

dict

Raises:

ValidationError – A validation error occurred

lint_script

bare_script.lint_script(script, globals_=None)

Lint a BareScript script model

Parameters:
Returns:

The list of lint warnings

Return type:

list[str]