getml.project

@module_function
def load(bundle: str, name: Optional[str] = None) -> None:
    """
    Loads a project from a bundle and connects to it.

    Args:
        bundle: The `.getml` bundle file to load.

        name: A name for the project contained in the bundle.
            If None, the name will be extracted from the bundle.
    """
    return comm._load_project(bundle, name)

@module_function
def delete() -> None:
    """
    Deletes the currently connected project. All related pipelines,
    data frames and hyperopts will be irretrievably deleted.
    """
    comm._delete_project(_name())

@module_function
def restart() -> None:
    """
    Suspends and then relaunches the currently connected project.
    This will kill all jobs currently running on that process.
    """
    comm._set_project(_name(), restart=True)

@module_function
def save(
    filename: Optional[Union[PathLike, str]] = None,
    target_dir: Optional[str] = None,
    replace: bool = False,
) -> None:
    """
    Saves the currently connected project to disk.

    Args:
        filename: The name of the `.getml` bundle file

        replace: Whether to replace an existing bundle.

    Deprecated:
        1.5: The `target_dir` argument is deprecated.
    """
    if target_dir is not None:
        warnings.warn(
            "The target_dir argument is deprecated. Use filename with a path instead.",
            DeprecationWarning,
        )
        bundle_name = filename if filename else f"{_name()}.getml"
        filename = Path(target_dir) / bundle_name
    return comm._save_project(_name(), filename, replace)

@module_function
def suspend() -> None:
    """
    Suspends the currently connected project.
    """
    return comm._suspend_project(_name())

@module_function
def switch(name: str) -> None:
    """Creates a new project or loads an existing one.

    If there is no project called `name` present on the Engine, a new one will
    be created. See the [User guide][project-management] for more
    information.

    Args:
        name: Name of the new project.
    """
    comm._set_project(name)