Source code for runway.config.components.runway._deployment_def

"""Runway config deployment definition."""
from __future__ import annotations

import logging
from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Tuple, Union, overload

from ....exceptions import UnresolvedVariable
from ....variables import Variable
from ...models.runway import (
from ._module_def import RunwayModuleDefinition
from .base import ConfigComponentDefinition

    from ...models.base import ConfigProperty
    from ...models.runway import (

LOGGER = logging.getLogger(__name__.replace("._", "."))

[docs]class RunwayDeploymentDefinition(ConfigComponentDefinition): """Runway deployment definition.""" account_alias: Optional[str] account_id: Optional[str] assume_role: RunwayAssumeRoleDefinitionModel environments: RunwayEnvironmentsType env_vars: RunwayEnvVarsType module_options: Dict[str, Any] name: str parallel_regions: List[str] parameters: Dict[str, Any] regions: List[str] _data: RunwayDeploymentDefinitionModel _pre_process_vars: Tuple[str, ...] = ( "account_alias", "account_id", "assume_role", "env_vars", "regions", ) _supports_vars: Tuple[str, ...] = ( "account_alias", "account_id", "assume_role", "env_vars", "environments", "module_options", "regions", "parallel_regions", "parameters", ) def __init__(self, data: RunwayDeploymentDefinitionModel) -> None: """Instantiate class.""" super().__init__(data) @property def menu_entry(self) -> str: """Return menu entry representation of this deployment.""" try: regions = self.regions or self.parallel_regions except UnresolvedVariable as err: LOGGER.debug( "attempted to use variable %s before it was resolved; " "using literal value in menu entry",, ) regions = self._data.regions or self._data.parallel_regions return "{name} - {modules} ({regions})".format(, modules=", ".join( for module in self.modules), regions=", ".join(regions if isinstance(regions, list) else [regions]), ) @property def modules(self) -> List[RunwayModuleDefinition]: """List of Runway modules.""" return [RunwayModuleDefinition(module) for module in self._data.modules] @modules.setter def modules(self, modules: List[RunwayModuleDefinition]) -> None: """Set the value of the property. Args: modules: A list of modules. Raises: TypeError: The provided value does not match the required types. """ if not all(isinstance(i, RunwayModuleDefinition) for i in modules): # type: ignore raise TypeError("modules must be type List[RunwayModuleDefinition]") self._data.modules = [ RunwayModuleDefinitionModel.parse_obj( for mod in modules ]
[docs] def reverse(self): """Reverse the order of modules and regions.""" self._data.modules.reverse() for mod in self._data.modules: mod.parallel.reverse() for prop in [self._data.parallel_regions, self._data.regions]: if isinstance(prop, list): prop.reverse()
[docs] def set_modules( self, modules: List[Union[RunwayModuleDefinition, RunwayModuleDefinitionModel]] ) -> None: """Set the value of modules. Args: modules: A list of modules. Raises: TypeError: The provided value does not match the required types. """ if not isinstance(modules, list): # type: ignore raise TypeError( f"expected List[RunwayModuleDefinition]; got {type(modules)}" ) sanitized: List[RunwayModuleDefinitionModel] = [] for i, mod in enumerate(modules): if isinstance(mod, RunwayModuleDefinition): sanitized.append(RunwayModuleDefinitionModel.parse_obj( elif isinstance(mod, RunwayModuleDefinitionModel): # type: ignore sanitized.append(mod) else: raise TypeError( f"{}.modules[{i}] is type {type(mod)}; " "expected type RunwayModuleDefinition or RunwayModuleDefinitionModel" ) self._data.modules = sanitized
def _register_variable(self, var_name: str, var_value: Any) -> None: """Register a variable. Args: var_name: Name of the config field that can contain a variable lookup. var_value: Literal value supplied in the config to be resolved as a variable if it contains a lookup. """ self._vars[var_name] = Variable( name=f"{}.{var_name}", value=var_value, variable_type="runway" ) @overload @classmethod def parse_obj(cls, obj: List[Dict[str, Any]]) -> List[RunwayDeploymentDefinition]: ... @overload @classmethod def parse_obj( cls, obj: Union[ List[ConfigProperty], Set[ConfigProperty], Tuple[ConfigProperty, ...] ], ) -> List[RunwayDeploymentDefinition]: ... @overload @classmethod def parse_obj( cls, obj: Union[Dict[str, Any], ConfigProperty] ) -> RunwayDeploymentDefinition: ...
[docs] @classmethod def parse_obj( # type: ignore cls, obj: Any ) -> Union[RunwayDeploymentDefinition, List[RunwayDeploymentDefinition]]: """Parse a python object into this class. Args: obj: The object to parse. """ if isinstance(obj, (list, set, tuple)): return [ cls(RunwayDeploymentDefinitionModel.parse_obj(o)) for o in obj # type: ignore ] return cls(RunwayDeploymentDefinitionModel.parse_obj(obj))