Options

Options

In Sierra‑SDK, every Invoker entry‑point parameter must be wrapped with Param[...], supplying a SierraOption to describe its behavior and validation rules.

Options Example

import sierra

def example(foo: sierra.Param[str, sierra.SierraOption(description="Foo is a foo")])->None:
"""
Foo is a string, the options add a metadata called description.
"""
result = sierra.create_tree_result([f"{foo}"])
print(result)

sierra.options

Sierra Options.

Type-safe option descriptors for annotating invoker script parameters.

Usage

import sierra

@invoker.entry_point
def run(
    domain: sierra.Param[
        str,
        sierra.SierraOption(
            description="Target domain to scan",
            mandatory="MANDATORY",
            primary=True,
        )
    ],
) -> None:
    ...

Attributes

Param module-attribute

Python

Param = typing.Annotated

Classes

SierraOption

Python

SierraOption(*, description: str = '', mandatory: typing.Literal['MANDATORY'] | None = None, primary: bool = False, min_value: int | float | None = None, max_value: int | float | None = None, choices: list[typing.Any] | None = None, pattern: str | None = None)

Typed descriptor for marking a function parameter as a SIERRA option.

Provides metadata that controls how the parameter appears in the generated config.yaml and how SIERRA presents it to the user.

PARAMETER	DESCRIPTION
description	Human-readable description of the parameter. Shown as a tooltip in the SIERRA canvas input dialog. TYPE: str DEFAULT: ''
mandatory	Set to "MANDATORY" to block execution when the value is empty. Defaults to None (optional parameter). TYPE: Literal[MANDATORY] or None DEFAULT: None
primary	If True, this parameter is flagged as PRIMARY in the YAML output, meaning SIERRA auto-populates it from the active node's value. Only one parameter per script should be primary. TYPE: bool DEFAULT: False

Examples:

>>> from sierra import SierraOption, Param
>>> def scan(
...     target: Param[str, SierraOption(description="IP address", mandatory="MANDATORY", primary=True)],
...     timeout: Param[int, SierraOption(description="Request timeout in seconds")] = 30,
... ) -> None:
...     ...

Attributes

description instance-attribute

Python

description: str = description

mandatory instance-attribute

Python

mandatory: typing.Literal['MANDATORY'] | None = mandatory

primary instance-attribute

Python

primary: bool = primary

min_value instance-attribute

Python

min_value: int | float | None = min_value

max_value instance-attribute

Python

max_value: int | float | None = max_value

choices instance-attribute

Python

choices: list[typing.Any] | None = choices

pattern instance-attribute

Python

pattern: str | None = pattern