runway.lookups.handlers.var module

Retrieve a variable from the variables file or definition.

class runway.lookups.handlers.var.VarLookup[source]

Bases: LookupHandler[Any]

Variable definition Lookup.

TYPE_NAME: ClassVar[str] = 'var'

Name that the Lookup is registered as.

classmethod handle(value: str, *_args: Any, variables: MutableMap, **_kwargs: Any) Any[source]

Retrieve a variable from the variable definition.

The value is retrieved from the variables passed to Runway using either a variables file or the variables directive of the config file.

Parameters:
  • value – The value passed to the Lookup.

  • variables – The resolved variables pass to Runway.

Raises:

ValueError – Unable to find a value for the provided query and a default value was not provided.