runway.config.components.runway package

Runway config components.

class runway.config.components.runway.RunwayDeploymentDefinition

Bases: ConfigComponentDefinition[RunwayDeploymentDefinitionModel]

Runway deployment definition.

__init__(data: RunwayDeploymentDefinitionModel) → None

Instantiate class.

property menu_entry: str

Return menu entry representation of this deployment.

property modules: list[RunwayModuleDefinition]

List of Runway modules.

classmethod parse_obj(obj: list[dict[str, Any]]) → list[Self]

classmethod parse_obj(obj: list[ConfigProperty] | set[ConfigProperty] | tuple[ConfigProperty, ...]) → list[Self]

classmethod parse_obj(obj: dict[str, Any] | ConfigProperty) → Self

Parse a python object into this class.

Parameters:

obj – The object to parse.

reverse() → None

Reverse the order of modules and regions.

set_modules(modules: list[RunwayModuleDefinition | RunwayModuleDefinitionModel]) → None

Set the value of modules.

Parameters:

modules – A list of modules.

Raises:

TypeError – The provided value does not match the required types.

class runway.config.components.runway.RunwayModuleDefinition

Bases: ConfigComponentDefinition[RunwayModuleDefinitionModel]

Runway module definition.

__init__(data: RunwayModuleDefinitionModel) → None

Instantiate class.

property child_modules: list[RunwayModuleDefinition]

List of child modules.

property is_parent: bool

Assess if the modules contains child modules (e.g. run in parallel).

property menu_entry: str

Return menu entry representation of this module.

classmethod parse_obj(obj: object) → Self

Parse a python object into this class.

Parameters:

obj – The object to parse.

reverse() → None

Reverse the order of child/parallel modules.

class runway.config.components.runway.RunwayTestDefinition

Bases: ConfigComponentDefinition[RunwayTestDefinitionModel]

Runway test definition.

__init__(data: RunwayTestDefinitionModel) → None

Instantiate class.

classmethod parse_obj(obj: object) → Self

Parse a python object into this class.

Parameters:

obj – The object to parse.

class runway.config.components.runway.RunwayVariablesDefinition

Bases: MutableMap

Runway variables definition.

__init__(data: RunwayVariablesDefinitionModel) → None

Instantiate class.

classmethod parse_obj(obj: Any) → Self

Parse a python object into this class.

Parameters:

obj – The object to parse.

Submodules

• runway.config.components.runway.base module
  • ConfigComponentDefinition
    • ConfigComponentDefinition.__contains__()
    • ConfigComponentDefinition.__getattr__()
    • ConfigComponentDefinition.__getitem__()
    • ConfigComponentDefinition.__init__()
    • ConfigComponentDefinition.__setattr__()
    • ConfigComponentDefinition.__setitem__()
    • ConfigComponentDefinition.data
    • ConfigComponentDefinition.get()
    • ConfigComponentDefinition.parse_obj()
    • ConfigComponentDefinition.resolve()