Module cdev.constructs.project

Expand source code 
from enum import Enum
import json
import os
from typing import Any, Dict, List, Optional, TypeVar, Tuple, Callable

from pydantic import BaseModel
from pydantic.types import DirectoryPath

from core.constructs.backend import Backend_Configuration
from core.constructs.mapper import CloudMapper
from core.constructs.components import Component
from core.constructs.types import F
from core.constructs.cloud_output import Cloud_Output
from core.constructs.settings import Settings, Settings_Info

from .environment import environment_info, Environment

_GLOBAL_PROJECT = None

# Global definition that defines a cdev project as having a folder called `.cdev` with a valid `cdev_project.json`
CDEV_FOLDER = ".cdev"
CDEV_PROJECT_FILE = "cdev_project.json"


class Project_Info(BaseModel):
    project_name: str
    environment_infos: List[environment_info]
    default_backend_configuration: Backend_Configuration
    current_environment_name: Optional[str]


class Project_State(str, Enum):
    INFO_LOADED = "INFO_LOADED"
    INITIALIZING = "INITIALIZING"
    INITIALIZED = "INITIALIZED"


###############################
##### Exceptions
###############################
class ProjectError(Exception):
    pass


class NoGlobalProject(ProjectError):
    pass


class IncorrectPhase(ProjectError):
    pass


class EnvironmentDoesNotExist(ProjectError):
    pass


class NoCurrentEnvironment(ProjectError):
    pass


class BackendError(ProjectError):
    pass


class FilesystemError(ProjectError):
    pass


def wrap_phases(phases: List[Project_State]) -> Callable[[F], F]:
    """
    Annotation that denotes when a function can be executed within the life cycle of a Project. Throws exception if the Project is not in the correct
    phase.
    """

    def inner_wrap(func: F) -> F:
        def wrapper_func(project: "Project", *func_posargs, **func_kwargs):
            current_state = project.get_state()
            if not current_state in phases:
                raise IncorrectPhase(
                    f"Trying to call {func} while in project state {current_state} but need to be in {phases}"
                )

            else:

                return func(project, *func_posargs, **func_kwargs)

        return wrapper_func

    return inner_wrap


class Project:
    """
    Global class that defines the functionality for the Project object. The Project object is a global object that is created
    by Cdev to provide access to helpful API's for developers to use in their projects. The object is created and managed by
    the Cdev framework and follows a set of lifecycle rules (link to documentation).

    Developers can access the object in their projects by calling `Project.instance()`. When using the Project Object, developers
    should keep in mind the lifecycle rules around each API and how it fits into their project.

    """

    _settings: Settings

    @classmethod
    def instance(cls) -> "Project":
        """Method to retrieve the global instance of the Project object.

        Raises:
            NoGlobalProject
        """
        if not _GLOBAL_PROJECT:
            raise NoGlobalProject

        return _GLOBAL_PROJECT

    @classmethod
    def set_global_instance(cls, project: "Project") -> None:
        """Method to set the global Project object. Should only be used by sub-classes to register themselves as the global `Project` within the
        cdev execution steps.

        Args:
            project (Project): Object to register as global Project
        """
        global _GLOBAL_PROJECT
        _GLOBAL_PROJECT = project

    def get_name(self) -> str:
        """Get the name of this Project

        Returns:
            name (str)

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def get_state(self) -> Project_State:
        """Get the current lifecycle state of the Project.

        Returns:
            state (Project_State)

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def set_state(self, new_state: Project_State) -> None:
        """Set the current lifecycle state of the Project

        Args:
            new_state (Project_State): new project state
        """
        raise NotImplementedError

    def initialize_project(self) -> None:
        """Initialize the Project object. This function can only be called when in the `LOAD_INFO` state. It will transition into the `INITIALIZING` phase
        while the function is executing. Then it will transition to the `INITIALIZED` phase as the final action.

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def create_environment(
        self, environment_name: str, backend_configuration: Backend_Configuration = None
    ) -> None:
        """Create a new environment for this project.

        Args:
            environment_name (str): Name of the `Environment` to create
            backend_configuration (Backend_Configuration, optional): Backend configuration to associate with the created `Environment`. Defaults to None.

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def destroy_environment(self, environment_name: str) -> None:
        """Destroy an environment. This function should only be used to delete the information about an environment. To delete actual cloud resources in an,
        an environment you should use the `cdev destroy` command.

        Args:
            environment_name (str): Name of the `Environment` to destroy

        Raises:
            ProjectError
            EnvironmentDoesNotExist
        """
        raise NotImplementedError

    def get_all_environment_names(self) -> List[str]:
        """Get all the available environments in the Project.

        Returns:
            environment_names (List[str]): environments

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def get_current_environment_name(self) -> str:
        """Get the environment name that is currently active for this Project.

        Returns:
            environment_name (str)

        Raises:
            EnvironmentDoesNotExist
            NoCurrentEnvironment
        """
        raise NotImplementedError

    def set_current_environment(self, environment_name: str) -> None:
        """Change the currently active environment for this Project. This should only be called when the Project is
        in the Uninitialized state to prevent it from being called during operations that modify an environment.

        Args:
            environment_name (str): The environment name to switch to

        Raises:
            EnvironmentDoesNotExist
        """
        raise NotImplementedError

    def get_environment_settings_info(
        self, environment_name: str = None
    ) -> Settings_Info:
        """Get the information about an Environments Settings Modules

        Args:
            environment_name (str, optional): Name of the Environment. Defaults to None.

        Raises:
            ProjectError
            EnvironmentDoesNotExist

        Returns:
            Settings_Info
        """
        raise NotImplementedError

    def update_environment_settings_info(
        self, new_value: Settings_Info, environment_name: str = None
    ):
        """Update the information Settings Module Information for a given Environment

        Args:
            new_value (Settings_Info): New Settings Info for the Environment
            environment_name (str, optional): Environment name to update. Defaults to None.

        Raises:
            ProjectError
            EnvironmentDoesNotExist
        """
        raise NotImplementedError

    def get_environment(self, environment_name: str) -> Environment:
        """Get the environment object for a specified environment name. Note that the environment will be in a state
        based on when this function is called within the Cdev lifecycle.

        Args:
            environment_name (str): The environment name to switch to

        Raises:
            EnvironmentDoesNotExist
        """
        raise NotImplementedError

    def get_current_environment(self) -> Environment:
        """Get the environment object for the currently active Environment. Note that the Environment will be in a state
        based on when this function is called within the Cdev lifecycle.

        Raises:
            EnvironmentDoesNotExist
            NoCurrentEnvironment
        """
        raise NotImplementedError

    ############################
    ##### Settings
    ############################
    @property
    def settings(self) -> Settings:
        raise NotImplementedError

    @settings.setter
    def settings(self, value: Settings):
        raise NotImplementedError

    #######################
    ##### Display Output
    #######################

    def display_output(self, tag: str, output: Cloud_Output) -> None:
        """Display the output from a Resource or Reference after a `Deployment` process has completed

        Args:
            tag: A key value to display with the output
            output: The Cloud Output to render
        """
        raise NotImplementedError

    #################
    ##### Mappers
    #################
    def add_mapper(self, mapper: CloudMapper) -> None:
        """Add a CloudMapper to the project. The order that the Mappers are added to the Project defines the precedence give when
        determining which CloudMapper to use.

        Args:
            mapper (CloudMapper): The mapper to add

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def add_mappers(self, mappers: List[CloudMapper]) -> None:
        """Add a List of CloudMappers to the project. The order that the Mappers are added to the Project defines the precedence
        give when determining which CloudMapper to use.

        Args:
            mappers (List[CloudMapper]): The mapper to add

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def get_mappers(self) -> List[CloudMapper]:
        """Return the List of CloudMappers for this Project.

        Returns:
            mappers (List[CloudMapper]): mappers for this Project

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def get_mapper_namespace(self) -> Dict[str, CloudMapper]:
        """Return the Dictionary that maps Resource ID's (ruuid) to the mapper that will be used to deploy the resource into the cloud.

        Returns:
            ruuid_to_mapper (Dict[str, CloudMapper]): Resource ID to CloudMapper
        """
        raise NotImplementedError

    #################
    ##### Commands
    #################
    def add_command(self, command_location: str):
        """Add a Command Location to the Project. The order that the Command is added to the Project defines the precedence
        give when searching for Commands. Command Locations should adhere to the defined form to ensure that they can be
        found within the Project.

        Args:
            command_location (Command): The command location to add
        """
        raise NotImplementedError

    def add_commands(self, command_locations: List[str]):
        """Add a List of Command Locations to the Project. The order that the Commands are added to the Project defines the precedence
        give when searching for a Command. Command Locations should adhere to the defined form to ensure that they can be
        found within the Project.

        Args:
            command_locations (Command): The command locations to add
        """
        raise NotImplementedError

    def get_commands(self) -> List[str]:
        """Get the Command Locations for this Project.

        Returns:
            command_locations (List[str])
        """
        raise NotImplementedError

    #################
    ##### Components
    #################
    def add_component(self, component: Component) -> None:
        """Add a Component to the Project. Components are used to determine the desired state of the Project. They should represent
        a logical separation for the Resources in a project.

        Args:
            component (Component): Component to add
        """
        raise NotImplementedError

    def add_components(self, components: List[Component]) -> None:
        """Add a List of Components to the Project. Components are used to determine the desired state of the Project. They
        should represent a logical separation for the Resources in a project.

        Args:
            components (Component): Components to add
        """
        raise NotImplementedError

    def get_components(self) -> List[Component]:
        """Return the Components for this Project.

        Returns:
            components (List[Component])
        """
        raise NotImplementedError


def check_if_project_exists(base_directory: DirectoryPath) -> bool:
    """
    This function checks for an existing Cdev project at the given directory. A Cdev project is defined by the existence of a valid
    'cdev_project.json' file (can be loaded as project_info) at the location of <base_directory>/.cdev/.

    Args:
        base_directory: Directory to start search from
    """
    if not os.path.isdir(base_directory):
        raise Exception(f"Given base directory is not a directory {base_directory}")

    if not os.path.isdir(os.path.join(base_directory, CDEV_FOLDER)):
        return False

    if not os.path.isfile(os.path.join(base_directory, CDEV_FOLDER, CDEV_PROJECT_FILE)):
        return False

    try:
        with open(
            os.path.join(base_directory, CDEV_FOLDER, CDEV_PROJECT_FILE), "r"
        ) as fh:
            Project_Info(**json.load(fh))

        return True

    except Exception as e:
        return False

Functions

def check_if_project_exists(base_directory: pydantic.types.DirectoryPath) ‑> bool

This function checks for an existing Cdev project at the given directory. A Cdev project is defined by the existence of a valid 'cdev_project.json' file (can be loaded as project_info) at the location of /.cdev/.

Args

base_directory
Directory to start search from
Expand source code 
def check_if_project_exists(base_directory: DirectoryPath) -> bool:
    """
    This function checks for an existing Cdev project at the given directory. A Cdev project is defined by the existence of a valid
    'cdev_project.json' file (can be loaded as project_info) at the location of <base_directory>/.cdev/.

    Args:
        base_directory: Directory to start search from
    """
    if not os.path.isdir(base_directory):
        raise Exception(f"Given base directory is not a directory {base_directory}")

    if not os.path.isdir(os.path.join(base_directory, CDEV_FOLDER)):
        return False

    if not os.path.isfile(os.path.join(base_directory, CDEV_FOLDER, CDEV_PROJECT_FILE)):
        return False

    try:
        with open(
            os.path.join(base_directory, CDEV_FOLDER, CDEV_PROJECT_FILE), "r"
        ) as fh:
            Project_Info(**json.load(fh))

        return True

    except Exception as e:
        return False
def wrap_phases(phases: List[Project_State]) ‑> Callable[[~F], ~F]

Annotation that denotes when a function can be executed within the life cycle of a Project. Throws exception if the Project is not in the correct phase.

Expand source code 
def wrap_phases(phases: List[Project_State]) -> Callable[[F], F]:
    """
    Annotation that denotes when a function can be executed within the life cycle of a Project. Throws exception if the Project is not in the correct
    phase.
    """

    def inner_wrap(func: F) -> F:
        def wrapper_func(project: "Project", *func_posargs, **func_kwargs):
            current_state = project.get_state()
            if not current_state in phases:
                raise IncorrectPhase(
                    f"Trying to call {func} while in project state {current_state} but need to be in {phases}"
                )

            else:

                return func(project, *func_posargs, **func_kwargs)

        return wrapper_func

    return inner_wrap

Classes

class BackendError (*args, **kwargs)

Common base class for all non-exit exceptions.

Expand source code 
class BackendError(ProjectError):
    pass

Ancestors

class EnvironmentDoesNotExist (*args, **kwargs)

Common base class for all non-exit exceptions.

Expand source code 
class EnvironmentDoesNotExist(ProjectError):
    pass

Ancestors

class FilesystemError (*args, **kwargs)

Common base class for all non-exit exceptions.

Expand source code 
class FilesystemError(ProjectError):
    pass

Ancestors

class IncorrectPhase (*args, **kwargs)

Common base class for all non-exit exceptions.

Expand source code 
class IncorrectPhase(ProjectError):
    pass

Ancestors

class NoCurrentEnvironment (*args, **kwargs)

Common base class for all non-exit exceptions.

Expand source code 
class NoCurrentEnvironment(ProjectError):
    pass

Ancestors

class NoGlobalProject (*args, **kwargs)

Common base class for all non-exit exceptions.

Expand source code 
class NoGlobalProject(ProjectError):
    pass

Ancestors

class Project

Global class that defines the functionality for the Project object. The Project object is a global object that is created by Cdev to provide access to helpful API's for developers to use in their projects. The object is created and managed by the Cdev framework and follows a set of lifecycle rules (link to documentation).

Developers can access the object in their projects by calling Project.instance(). When using the Project Object, developers should keep in mind the lifecycle rules around each API and how it fits into their project.

Expand source code 
class Project:
    """
    Global class that defines the functionality for the Project object. The Project object is a global object that is created
    by Cdev to provide access to helpful API's for developers to use in their projects. The object is created and managed by
    the Cdev framework and follows a set of lifecycle rules (link to documentation).

    Developers can access the object in their projects by calling `Project.instance()`. When using the Project Object, developers
    should keep in mind the lifecycle rules around each API and how it fits into their project.

    """

    _settings: Settings

    @classmethod
    def instance(cls) -> "Project":
        """Method to retrieve the global instance of the Project object.

        Raises:
            NoGlobalProject
        """
        if not _GLOBAL_PROJECT:
            raise NoGlobalProject

        return _GLOBAL_PROJECT

    @classmethod
    def set_global_instance(cls, project: "Project") -> None:
        """Method to set the global Project object. Should only be used by sub-classes to register themselves as the global `Project` within the
        cdev execution steps.

        Args:
            project (Project): Object to register as global Project
        """
        global _GLOBAL_PROJECT
        _GLOBAL_PROJECT = project

    def get_name(self) -> str:
        """Get the name of this Project

        Returns:
            name (str)

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def get_state(self) -> Project_State:
        """Get the current lifecycle state of the Project.

        Returns:
            state (Project_State)

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def set_state(self, new_state: Project_State) -> None:
        """Set the current lifecycle state of the Project

        Args:
            new_state (Project_State): new project state
        """
        raise NotImplementedError

    def initialize_project(self) -> None:
        """Initialize the Project object. This function can only be called when in the `LOAD_INFO` state. It will transition into the `INITIALIZING` phase
        while the function is executing. Then it will transition to the `INITIALIZED` phase as the final action.

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def create_environment(
        self, environment_name: str, backend_configuration: Backend_Configuration = None
    ) -> None:
        """Create a new environment for this project.

        Args:
            environment_name (str): Name of the `Environment` to create
            backend_configuration (Backend_Configuration, optional): Backend configuration to associate with the created `Environment`. Defaults to None.

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def destroy_environment(self, environment_name: str) -> None:
        """Destroy an environment. This function should only be used to delete the information about an environment. To delete actual cloud resources in an,
        an environment you should use the `cdev destroy` command.

        Args:
            environment_name (str): Name of the `Environment` to destroy

        Raises:
            ProjectError
            EnvironmentDoesNotExist
        """
        raise NotImplementedError

    def get_all_environment_names(self) -> List[str]:
        """Get all the available environments in the Project.

        Returns:
            environment_names (List[str]): environments

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def get_current_environment_name(self) -> str:
        """Get the environment name that is currently active for this Project.

        Returns:
            environment_name (str)

        Raises:
            EnvironmentDoesNotExist
            NoCurrentEnvironment
        """
        raise NotImplementedError

    def set_current_environment(self, environment_name: str) -> None:
        """Change the currently active environment for this Project. This should only be called when the Project is
        in the Uninitialized state to prevent it from being called during operations that modify an environment.

        Args:
            environment_name (str): The environment name to switch to

        Raises:
            EnvironmentDoesNotExist
        """
        raise NotImplementedError

    def get_environment_settings_info(
        self, environment_name: str = None
    ) -> Settings_Info:
        """Get the information about an Environments Settings Modules

        Args:
            environment_name (str, optional): Name of the Environment. Defaults to None.

        Raises:
            ProjectError
            EnvironmentDoesNotExist

        Returns:
            Settings_Info
        """
        raise NotImplementedError

    def update_environment_settings_info(
        self, new_value: Settings_Info, environment_name: str = None
    ):
        """Update the information Settings Module Information for a given Environment

        Args:
            new_value (Settings_Info): New Settings Info for the Environment
            environment_name (str, optional): Environment name to update. Defaults to None.

        Raises:
            ProjectError
            EnvironmentDoesNotExist
        """
        raise NotImplementedError

    def get_environment(self, environment_name: str) -> Environment:
        """Get the environment object for a specified environment name. Note that the environment will be in a state
        based on when this function is called within the Cdev lifecycle.

        Args:
            environment_name (str): The environment name to switch to

        Raises:
            EnvironmentDoesNotExist
        """
        raise NotImplementedError

    def get_current_environment(self) -> Environment:
        """Get the environment object for the currently active Environment. Note that the Environment will be in a state
        based on when this function is called within the Cdev lifecycle.

        Raises:
            EnvironmentDoesNotExist
            NoCurrentEnvironment
        """
        raise NotImplementedError

    ############################
    ##### Settings
    ############################
    @property
    def settings(self) -> Settings:
        raise NotImplementedError

    @settings.setter
    def settings(self, value: Settings):
        raise NotImplementedError

    #######################
    ##### Display Output
    #######################

    def display_output(self, tag: str, output: Cloud_Output) -> None:
        """Display the output from a Resource or Reference after a `Deployment` process has completed

        Args:
            tag: A key value to display with the output
            output: The Cloud Output to render
        """
        raise NotImplementedError

    #################
    ##### Mappers
    #################
    def add_mapper(self, mapper: CloudMapper) -> None:
        """Add a CloudMapper to the project. The order that the Mappers are added to the Project defines the precedence give when
        determining which CloudMapper to use.

        Args:
            mapper (CloudMapper): The mapper to add

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def add_mappers(self, mappers: List[CloudMapper]) -> None:
        """Add a List of CloudMappers to the project. The order that the Mappers are added to the Project defines the precedence
        give when determining which CloudMapper to use.

        Args:
            mappers (List[CloudMapper]): The mapper to add

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def get_mappers(self) -> List[CloudMapper]:
        """Return the List of CloudMappers for this Project.

        Returns:
            mappers (List[CloudMapper]): mappers for this Project

        Raises:
            ProjectError
        """
        raise NotImplementedError

    def get_mapper_namespace(self) -> Dict[str, CloudMapper]:
        """Return the Dictionary that maps Resource ID's (ruuid) to the mapper that will be used to deploy the resource into the cloud.

        Returns:
            ruuid_to_mapper (Dict[str, CloudMapper]): Resource ID to CloudMapper
        """
        raise NotImplementedError

    #################
    ##### Commands
    #################
    def add_command(self, command_location: str):
        """Add a Command Location to the Project. The order that the Command is added to the Project defines the precedence
        give when searching for Commands. Command Locations should adhere to the defined form to ensure that they can be
        found within the Project.

        Args:
            command_location (Command): The command location to add
        """
        raise NotImplementedError

    def add_commands(self, command_locations: List[str]):
        """Add a List of Command Locations to the Project. The order that the Commands are added to the Project defines the precedence
        give when searching for a Command. Command Locations should adhere to the defined form to ensure that they can be
        found within the Project.

        Args:
            command_locations (Command): The command locations to add
        """
        raise NotImplementedError

    def get_commands(self) -> List[str]:
        """Get the Command Locations for this Project.

        Returns:
            command_locations (List[str])
        """
        raise NotImplementedError

    #################
    ##### Components
    #################
    def add_component(self, component: Component) -> None:
        """Add a Component to the Project. Components are used to determine the desired state of the Project. They should represent
        a logical separation for the Resources in a project.

        Args:
            component (Component): Component to add
        """
        raise NotImplementedError

    def add_components(self, components: List[Component]) -> None:
        """Add a List of Components to the Project. Components are used to determine the desired state of the Project. They
        should represent a logical separation for the Resources in a project.

        Args:
            components (Component): Components to add
        """
        raise NotImplementedError

    def get_components(self) -> List[Component]:
        """Return the Components for this Project.

        Returns:
            components (List[Component])
        """
        raise NotImplementedError

Subclasses

Static methods

def instance() ‑> Project

Method to retrieve the global instance of the Project object.

Raises

NoGlobalProject

Expand source code 
@classmethod
def instance(cls) -> "Project":
    """Method to retrieve the global instance of the Project object.

    Raises:
        NoGlobalProject
    """
    if not _GLOBAL_PROJECT:
        raise NoGlobalProject

    return _GLOBAL_PROJECT
def set_global_instance(project: Project) ‑> None

Method to set the global Project object. Should only be used by sub-classes to register themselves as the global Project within the cdev execution steps.

Args

project : Project
Object to register as global Project
Expand source code 
@classmethod
def set_global_instance(cls, project: "Project") -> None:
    """Method to set the global Project object. Should only be used by sub-classes to register themselves as the global `Project` within the
    cdev execution steps.

    Args:
        project (Project): Object to register as global Project
    """
    global _GLOBAL_PROJECT
    _GLOBAL_PROJECT = project

Instance variables

var settings : core.constructs.settings.Settings
Expand source code 
@property
def settings(self) -> Settings:
    raise NotImplementedError

Methods

def add_command(self, command_location: str)

Add a Command Location to the Project. The order that the Command is added to the Project defines the precedence give when searching for Commands. Command Locations should adhere to the defined form to ensure that they can be found within the Project.

Args

command_location : Command
The command location to add
Expand source code 
def add_command(self, command_location: str):
    """Add a Command Location to the Project. The order that the Command is added to the Project defines the precedence
    give when searching for Commands. Command Locations should adhere to the defined form to ensure that they can be
    found within the Project.

    Args:
        command_location (Command): The command location to add
    """
    raise NotImplementedError
def add_commands(self, command_locations: List[str])

Add a List of Command Locations to the Project. The order that the Commands are added to the Project defines the precedence give when searching for a Command. Command Locations should adhere to the defined form to ensure that they can be found within the Project.

Args

command_locations : Command
The command locations to add
Expand source code 
def add_commands(self, command_locations: List[str]):
    """Add a List of Command Locations to the Project. The order that the Commands are added to the Project defines the precedence
    give when searching for a Command. Command Locations should adhere to the defined form to ensure that they can be
    found within the Project.

    Args:
        command_locations (Command): The command locations to add
    """
    raise NotImplementedError
def add_component(self, component: core.constructs.components.Component) ‑> None

Add a Component to the Project. Components are used to determine the desired state of the Project. They should represent a logical separation for the Resources in a project.

Args

component : Component
Component to add
Expand source code 
def add_component(self, component: Component) -> None:
    """Add a Component to the Project. Components are used to determine the desired state of the Project. They should represent
    a logical separation for the Resources in a project.

    Args:
        component (Component): Component to add
    """
    raise NotImplementedError
def add_components(self, components: List[core.constructs.components.Component]) ‑> None

Add a List of Components to the Project. Components are used to determine the desired state of the Project. They should represent a logical separation for the Resources in a project.

Args

components : Component
Components to add
Expand source code 
def add_components(self, components: List[Component]) -> None:
    """Add a List of Components to the Project. Components are used to determine the desired state of the Project. They
    should represent a logical separation for the Resources in a project.

    Args:
        components (Component): Components to add
    """
    raise NotImplementedError
def add_mapper(self, mapper: core.constructs.mapper.CloudMapper) ‑> None

Add a CloudMapper to the project. The order that the Mappers are added to the Project defines the precedence give when determining which CloudMapper to use.

Args

mapper : CloudMapper
The mapper to add

Raises

ProjectError

Expand source code 
def add_mapper(self, mapper: CloudMapper) -> None:
    """Add a CloudMapper to the project. The order that the Mappers are added to the Project defines the precedence give when
    determining which CloudMapper to use.

    Args:
        mapper (CloudMapper): The mapper to add

    Raises:
        ProjectError
    """
    raise NotImplementedError
def add_mappers(self, mappers: List[core.constructs.mapper.CloudMapper]) ‑> None

Add a List of CloudMappers to the project. The order that the Mappers are added to the Project defines the precedence give when determining which CloudMapper to use.

Args

mappers : List[CloudMapper]
The mapper to add

Raises

ProjectError

Expand source code 
def add_mappers(self, mappers: List[CloudMapper]) -> None:
    """Add a List of CloudMappers to the project. The order that the Mappers are added to the Project defines the precedence
    give when determining which CloudMapper to use.

    Args:
        mappers (List[CloudMapper]): The mapper to add

    Raises:
        ProjectError
    """
    raise NotImplementedError
def create_environment(self, environment_name: str, backend_configuration: core.constructs.backend.Backend_Configuration = None) ‑> None

Create a new environment for this project.

Args

environment_name : str
Name of the Environment to create
backend_configuration : Backend_Configuration, optional
Backend configuration to associate with the created Environment. Defaults to None.

Raises

ProjectError

Expand source code 
def create_environment(
    self, environment_name: str, backend_configuration: Backend_Configuration = None
) -> None:
    """Create a new environment for this project.

    Args:
        environment_name (str): Name of the `Environment` to create
        backend_configuration (Backend_Configuration, optional): Backend configuration to associate with the created `Environment`. Defaults to None.

    Raises:
        ProjectError
    """
    raise NotImplementedError
def destroy_environment(self, environment_name: str) ‑> None

Destroy an environment. This function should only be used to delete the information about an environment. To delete actual cloud resources in an, an environment you should use the cdev destroy command.

Args

environment_name : str
Name of the Environment to destroy

Raises

ProjectError EnvironmentDoesNotExist

Expand source code 
def destroy_environment(self, environment_name: str) -> None:
    """Destroy an environment. This function should only be used to delete the information about an environment. To delete actual cloud resources in an,
    an environment you should use the `cdev destroy` command.

    Args:
        environment_name (str): Name of the `Environment` to destroy

    Raises:
        ProjectError
        EnvironmentDoesNotExist
    """
    raise NotImplementedError
def display_output(self, tag: str, output: core.constructs.cloud_output.Cloud_Output) ‑> None

Display the output from a Resource or Reference after a Deployment process has completed

Args

tag
A key value to display with the output
output
The Cloud Output to render
Expand source code 
def display_output(self, tag: str, output: Cloud_Output) -> None:
    """Display the output from a Resource or Reference after a `Deployment` process has completed

    Args:
        tag: A key value to display with the output
        output: The Cloud Output to render
    """
    raise NotImplementedError
def get_all_environment_names(self) ‑> List[str]

Get all the available environments in the Project.

Returns

environment_names (List[str]): environments

Raises

ProjectError

Expand source code 
def get_all_environment_names(self) -> List[str]:
    """Get all the available environments in the Project.

    Returns:
        environment_names (List[str]): environments

    Raises:
        ProjectError
    """
    raise NotImplementedError
def get_commands(self) ‑> List[str]

Get the Command Locations for this Project.

Returns

command_locations (List[str])

Expand source code 
def get_commands(self) -> List[str]:
    """Get the Command Locations for this Project.

    Returns:
        command_locations (List[str])
    """
    raise NotImplementedError
def get_components(self) ‑> List[core.constructs.components.Component]

Return the Components for this Project.

Returns

components (List[Component])

Expand source code 
def get_components(self) -> List[Component]:
    """Return the Components for this Project.

    Returns:
        components (List[Component])
    """
    raise NotImplementedError
def get_current_environment(self) ‑> Environment

Get the environment object for the currently active Environment. Note that the Environment will be in a state based on when this function is called within the Cdev lifecycle.

Raises

EnvironmentDoesNotExist NoCurrentEnvironment

Expand source code 
def get_current_environment(self) -> Environment:
    """Get the environment object for the currently active Environment. Note that the Environment will be in a state
    based on when this function is called within the Cdev lifecycle.

    Raises:
        EnvironmentDoesNotExist
        NoCurrentEnvironment
    """
    raise NotImplementedError
def get_current_environment_name(self) ‑> str

Get the environment name that is currently active for this Project.

Returns

environment_name (str)

Raises

EnvironmentDoesNotExist NoCurrentEnvironment

Expand source code 
def get_current_environment_name(self) -> str:
    """Get the environment name that is currently active for this Project.

    Returns:
        environment_name (str)

    Raises:
        EnvironmentDoesNotExist
        NoCurrentEnvironment
    """
    raise NotImplementedError
def get_environment(self, environment_name: str) ‑> Environment

Get the environment object for a specified environment name. Note that the environment will be in a state based on when this function is called within the Cdev lifecycle.

Args

environment_name : str
The environment name to switch to

Raises

EnvironmentDoesNotExist

Expand source code 
def get_environment(self, environment_name: str) -> Environment:
    """Get the environment object for a specified environment name. Note that the environment will be in a state
    based on when this function is called within the Cdev lifecycle.

    Args:
        environment_name (str): The environment name to switch to

    Raises:
        EnvironmentDoesNotExist
    """
    raise NotImplementedError
def get_environment_settings_info(self, environment_name: str = None) ‑> core.constructs.settings.Settings_Info

Get the information about an Environments Settings Modules

Args

environment_name : str, optional
Name of the Environment. Defaults to None.

Raises

ProjectError EnvironmentDoesNotExist

Returns

Settings_Info

Expand source code 
def get_environment_settings_info(
    self, environment_name: str = None
) -> Settings_Info:
    """Get the information about an Environments Settings Modules

    Args:
        environment_name (str, optional): Name of the Environment. Defaults to None.

    Raises:
        ProjectError
        EnvironmentDoesNotExist

    Returns:
        Settings_Info
    """
    raise NotImplementedError
def get_mapper_namespace(self) ‑> Dict[str, core.constructs.mapper.CloudMapper]

Return the Dictionary that maps Resource ID's (ruuid) to the mapper that will be used to deploy the resource into the cloud.

Returns

ruuid_to_mapper (Dict[str, CloudMapper]): Resource ID to CloudMapper

Expand source code 
def get_mapper_namespace(self) -> Dict[str, CloudMapper]:
    """Return the Dictionary that maps Resource ID's (ruuid) to the mapper that will be used to deploy the resource into the cloud.

    Returns:
        ruuid_to_mapper (Dict[str, CloudMapper]): Resource ID to CloudMapper
    """
    raise NotImplementedError
def get_mappers(self) ‑> List[core.constructs.mapper.CloudMapper]

Return the List of CloudMappers for this Project.

Returns

mappers (List[CloudMapper]): mappers for this Project

Raises

ProjectError

Expand source code 
def get_mappers(self) -> List[CloudMapper]:
    """Return the List of CloudMappers for this Project.

    Returns:
        mappers (List[CloudMapper]): mappers for this Project

    Raises:
        ProjectError
    """
    raise NotImplementedError
def get_name(self) ‑> str

Get the name of this Project

Returns

name (str)

Raises

ProjectError

Expand source code 
def get_name(self) -> str:
    """Get the name of this Project

    Returns:
        name (str)

    Raises:
        ProjectError
    """
    raise NotImplementedError
def get_state(self) ‑> Project_State

Get the current lifecycle state of the Project.

Returns

state (Project_State)

Raises

ProjectError

Expand source code 
def get_state(self) -> Project_State:
    """Get the current lifecycle state of the Project.

    Returns:
        state (Project_State)

    Raises:
        ProjectError
    """
    raise NotImplementedError
def initialize_project(self) ‑> None

Initialize the Project object. This function can only be called when in the LOAD_INFO state. It will transition into the INITIALIZING phase while the function is executing. Then it will transition to the INITIALIZED phase as the final action.

Raises

ProjectError

Expand source code 
def initialize_project(self) -> None:
    """Initialize the Project object. This function can only be called when in the `LOAD_INFO` state. It will transition into the `INITIALIZING` phase
    while the function is executing. Then it will transition to the `INITIALIZED` phase as the final action.

    Raises:
        ProjectError
    """
    raise NotImplementedError
def set_current_environment(self, environment_name: str) ‑> None

Change the currently active environment for this Project. This should only be called when the Project is in the Uninitialized state to prevent it from being called during operations that modify an environment.

Args

environment_name : str
The environment name to switch to

Raises

EnvironmentDoesNotExist

Expand source code 
def set_current_environment(self, environment_name: str) -> None:
    """Change the currently active environment for this Project. This should only be called when the Project is
    in the Uninitialized state to prevent it from being called during operations that modify an environment.

    Args:
        environment_name (str): The environment name to switch to

    Raises:
        EnvironmentDoesNotExist
    """
    raise NotImplementedError
def set_state(self, new_state: Project_State) ‑> None

Set the current lifecycle state of the Project

Args

new_state : Project_State
new project state
Expand source code 
def set_state(self, new_state: Project_State) -> None:
    """Set the current lifecycle state of the Project

    Args:
        new_state (Project_State): new project state
    """
    raise NotImplementedError
def update_environment_settings_info(self, new_value: core.constructs.settings.Settings_Info, environment_name: str = None)

Update the information Settings Module Information for a given Environment

Args

new_value : Settings_Info
New Settings Info for the Environment
environment_name : str, optional
Environment name to update. Defaults to None.

Raises

ProjectError EnvironmentDoesNotExist

Expand source code 
def update_environment_settings_info(
    self, new_value: Settings_Info, environment_name: str = None
):
    """Update the information Settings Module Information for a given Environment

    Args:
        new_value (Settings_Info): New Settings Info for the Environment
        environment_name (str, optional): Environment name to update. Defaults to None.

    Raises:
        ProjectError
        EnvironmentDoesNotExist
    """
    raise NotImplementedError
class ProjectError (*args, **kwargs)

Common base class for all non-exit exceptions.

Expand source code 
class ProjectError(Exception):
    pass

Ancestors

  • builtins.Exception
  • builtins.BaseException

Subclasses

class Project_Info (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code 
class Project_Info(BaseModel):
    project_name: str
    environment_infos: List[environment_info]
    default_backend_configuration: Backend_Configuration
    current_environment_name: Optional[str]

Ancestors

  • pydantic.main.BaseModel
  • pydantic.utils.Representation

Subclasses

Class variables

var current_environment_name : Optional[str]
var default_backend_configuration : core.constructs.backend.Backend_Configuration
var environment_infos : List[environment_info]
var project_name : str
class Project_State (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code 
class Project_State(str, Enum):
    INFO_LOADED = "INFO_LOADED"
    INITIALIZING = "INITIALIZING"
    INITIALIZED = "INITIALIZED"

Ancestors

  • builtins.str
  • enum.Enum

Class variables

var INFO_LOADED
var INITIALIZED
var INITIALIZING