launch.substitutions.launch_configuration module

Module for the LaunchConfiguration substitution.

class launch.substitutions.launch_configuration.LaunchConfiguration

Bases: Substitution

Substitution that can access launch configuration variables.

__init__(variable_name: str | Path | Substitution | Iterable[str | Path | Substitution], *, default: Any | Iterable[Any] | None = None) → None

Create a LaunchConfiguration substitution.

describe() → str

Return a description of this substitution as a string.

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

Parse FindExecutable substitution.

perform(context: LaunchContext) → str

Perform the substitution by retrieving the launch configuration, as a string.

If the launch configuration is not found and a default has been set, the default will be returned, as a string.

property variable_name: List[Substitution]

Getter for variable_name.