launch.substitutions.for_loop_var module

Module for the ForLoopIndex substitution.

class launch.substitutions.for_loop_var.ForEachVar

Bases: Substitution

Substitution for a launch.actions.ForEach iteration variable value.

__init__(name: str | Path | Substitution | Iterable[str | Path | Substitution], *, default_value: str | Path | Substitution | Iterable[str | Path | Substitution] | None = None) → None

Create a ForEachVar.

Parameters:

• name – the name of the launch.actions.ForEach iteration variable

• default_value – a default value for the variable if a value is not available for a given iteration

property default_value: List[Substitution] | None

describe() → str

Return a description of this substitution as a string.

When inherited from, calling this base class’s default method is not required.

classmethod get_local_arg_name(name: str) → str

property name: List[Substitution]

classmethod parse(data: Sequence[str | Path | Substitution | Iterable[str | Path | Substitution]])

perform(context: LaunchContext) → str

Perform the substitution, given the launch context, and return it as a string.

This should be overridden by the derived classes, and the default raises NotImplementedError.

Raises:

NotImplementedError

class launch.substitutions.for_loop_var.ForLoopIndex

Bases: ForEachVar

Substitution for a launch.actions.ForLoop iteration index value.

__init__(name: str | Path | Substitution | Iterable[str | Path | Substitution], **kwargs) → None

Create a ForLoopIndex.

Parameters:

name – the name of the launch.actions.ForLoop index which this substitution is part of