Invoker

Invoker

Define and manage invoker scripts in the Sierra Dev. Invoker scripts are used to execute specific actions in a controlled environment.

Invoker Example

import sierra

# Define an InvokerScript with dependencies and an entry point
invoker = sierra.InvokerScript(
    name="example",
    description="An example invoker script."
)

@invoker.dependency
def helper_function(param: int) -> int:
    return param + 1

@invoker.entry_point
def run(param: sierra.Param[int, sierra.SierraOption(description="An integer parameter.")]) -> None:
    result = helper_function(param)
    print(f"Result: {result}")

# Register the invoker
sierra.register_invoker(invoker)

sierra.invoker

Classes

InvokerScript

Python

InvokerScript(name: str, description: str | None = None)

A wrapper for creating Sierra invoker scripts that generates config.yaml and argparse-compatible scripts.

This class is used to define a script with its parameters, then generate: 1. A standalone Python script with argparse handling 2. A YAML configuration for Sierra 3. Proper JSON output formatting

ATTRIBUTE	DESCRIPTION
name	The unique name of the script. TYPE: str
description	A short description of the script. TYPE: str | None
params	List of parameter metadata. TYPE: list[SierraInvokerParam]
http_client	Optional HTTP client used for external requests. TYPE: httpx.Client | None
logger	Logger instance for capturing script activity. TYPE: UniversalLogger
_entry_point	The registered Python function. TYPE: _TCallable | None
_output_dir	Directory to output generated files. TYPE: Path | None

Attributes

name instance-attribute

Python

name = name

description instance-attribute

Python

description = description

params instance-attribute

Python

params: list[sierra_abc_sierra.SierraInvokerParam] = []

deps instance-attribute

Python

deps: list[_TCallable] = []

requirements instance-attribute

Python

requirements: list[str] = []

command instance-attribute

Python

command: str = ''

filename instance-attribute

Python

filename: pathlib.Path

Functions

verify_signature staticmethod

Python

verify_signature(func: _TCallable) -> None

Verifies that all parameters are properly typed with SierraOption metadata. Raises TypeError if any parameter lacks SierraOption typing.

PARAMETER	DESCRIPTION
func	The function to verify. TYPE: _TCallable

RAISES	DESCRIPTION
TypeError	If any parameter lacks proper SierraOption annotation.

entry_point

Python

entry_point(func: _TCallable) -> _TCallable

Register a Python function as an invoker script.

This extracts parameter metadata and prepares the function for code generation.

PARAMETER	DESCRIPTION
func	The function to register. TYPE: _TCallable

RETURNS	DESCRIPTION
_TCallable	The original function (unchanged).

dependancy

Python

dependancy(func: _TCallable) -> _TCallable

requirement

Python

requirement(requirement: list[str]) -> None

set_command

Python

set_command(command_string: str) -> None