Environments

add_environment_external_library_from_pypi(workspace, environment, libraries)

Add external libraries to an environment from PyPI.

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID of the workspace.	required
environment	str	The name or ID of the environment.	required
libraries	List[tuple[str, str]]	A list of tuples containing library names and their versions.	required

Returns:

Type	Description
	None

Examples:

    add_environment_external_library_from_pypi(
        workspace='FabricOpsFlow-DEV',
        environment='Default',
        libraries=[
            ('pyFabricOps', '0.3.3'),
            ('pandas', '1.5.3'),
            ('numpy', '1.24.2')
        ]
    )

Source code in src/pyfabricops/helpers/environments.py

def add_environment_external_library_from_pypi(
    workspace: str,
    environment: str,
    libraries: list[tuple[str, str]],
):
    """
    Add external libraries to an environment from PyPI.

    Args:
        workspace (str): The name or ID of the workspace.
        environment (str): The name or ID of the environment.
        libraries (List[tuple[str, str]]): A list of tuples containing library names and their versions.

    Returns:
        None

    Examples:
    ```python
        add_environment_external_library_from_pypi(
            workspace='FabricOpsFlow-DEV',
            environment='Default',
            libraries=[
                ('pyFabricOps', '0.3.3'),
                ('pandas', '1.5.3'),
                ('numpy', '1.24.2')
            ]
        )
    ```
    """
    target_path = "../tmp/env"

    definition = get_environment_definition(
        workspace,
        environment,
    )

    delete_path("../tmp")

    unpack_item_definition(
        definition,
        path=target_path,
    )

    _create_environment_external_library_yaml(libraries)

    update_environment_definition(
        workspace=workspace,
        environment=environment,
        environment_definition=pack_item_definition(target_path),
    )

    logger.success(
        f"External libraries were added to environment {environment} successfully."
    )
    return None

deploy_all_environments(workspace, path, start_path=None)

Deploy all environments to workspace.

Shortcut for deploy_all_items(..., item_types=["Environment"]).

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID of the workspace.	required
path	str	The path to the environments.	required
start_path	Optional[str]	The starting path for folder creation.	None

Returns:

Name	Type	Description
DeploymentReport	DeploymentReport	The outcome of each environment.

Source code in src/pyfabricops/helpers/environments.py

def deploy_all_environments(
    workspace: str,
    path: str,
    start_path: str | None = None,
) -> DeploymentReport:
    """
    Deploy all environments to workspace.

    Shortcut for ``deploy_all_items(..., item_types=["Environment"])``.

    Args:
        workspace (str): The name or ID of the workspace.
        path (str): The path to the environments.
        start_path (Optional[str]): The starting path for folder creation.

    Returns:
        DeploymentReport: The outcome of each environment.
    """
    return deploy_all_items(
        workspace, path, start_path, item_types=["Environment"]
    )

deploy_environment(workspace, path, start_path=None, description=None, df=True)

Deploy a environment to workspace.

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID of the workspace.	required
path	str	The path to the environment.	required
start_path	Optional[str]	The starting path for folder creation.	None
description	Optional[str]	Description for the environment.	None
df	Optional[bool]	If True, returns a DataFrame, otherwise returns a dictionary.	True

Returns:

Type	Description
Union[DataFrame, Dict[str, Any], None]	The deployed environment or None if deployment fails.

Source code in src/pyfabricops/helpers/environments.py

@df
def deploy_environment(
    workspace: str,
    path: str,
    start_path: str | None = None,
    description: str | None = None,
    df: bool | None = True,
) -> DataFrame | dict[str, Any] | None:
    """
    Deploy a environment to workspace.

    Args:
        workspace (str): The name or ID of the workspace.
        path (str): The path to the environment.
        start_path (Optional[str]): The starting path for folder creation.
        description (Optional[str]): Description for the environment.
        df (Optional[bool]): If True, returns a DataFrame, otherwise returns a dictionary.

    Returns:
        (Union[DataFrame, Dict[str, Any], None]): The deployed environment or None if deployment fails.
    """
    workspace_id = resolve_workspace(workspace)
    if workspace_id is None:
        return None

    display_name = extract_display_name_from_platform(path)
    if display_name is None:
        return None

    environment_id = resolve_environment(workspace_id, display_name)

    folder_path_string = extract_middle_path(path, start_path=start_path)
    folder_id = create_folders_from_path_string(
        workspace_id, folder_path_string
    )

    item_definition = pack_item_definition(path)

    if environment_id is None:
        return create_environment(
            workspace_id,
            display_name=display_name,
            environment_definition=item_definition,
            description=description,
            folder=folder_id,
            df=False,
        )

    else:
        if folder_id:
            move_item(workspace_id, environment_id, target_folder=folder_id)
        return update_environment_definition(
            workspace_id,
            environment_id,
            environment_definition=item_definition,
            df=False,
        )

export_all_environments(workspace, path)

Export all environments to path.

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID of the workspace.	required
path	Union[str, Path]	The path to export to.	required

Source code in src/pyfabricops/helpers/environments.py

def export_all_environments(
    workspace: str,
    path: str | Path,
) -> None:
    """
    Export all environments to path.

    Args:
        workspace (str): The name or ID of the workspace.
        path (Union[str, Path]): The path to export to.
    """
    workspace_id = resolve_workspace(workspace)
    if workspace_id is None:
        return None

    items = list_environments(workspace_id, df=False)
    if items is None:
        return None

    failed = []

    for item in items:
        try:
            folder_path = resolve_folder_from_id_to_path(
                workspace_id, item["folderId"]
            )
        except Exception:
            logger.info(
                f"{item['displayName']}.Environment is not inside a folder."
            )
            folder_path = None

        if folder_path is None:
            item_path = Path(path) / (item["displayName"] + ".Environment")
        else:
            item_path = (
                Path(path)
                / folder_path
                / (item["displayName"] + ".Environment")
            )

        definition = get_environment_definition(workspace_id, item["id"])
        if definition is None:
            logger.error(
                f"Could not get the definition of "
                f"{item['displayName']}.Environment; skipping it."
            )
            failed.append(item["displayName"])
            continue

        os.makedirs(item_path, exist_ok=True)
        unpack_item_definition(definition, item_path)

    if failed:
        logger.warning(
            f"{len(failed)} environment(s) could not be exported: "
            f"{', '.join(failed)}."
        )
    else:
        logger.success(
            f"All environments were exported to {path} successfully."
        )
    return None

export_environment(workspace, environment, path)

Export an environment to path.

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID of the workspace.	required
environment	str	The name or ID of the environment.	required
path	Union[str, Path]	The path to export to.	required

Source code in src/pyfabricops/helpers/environments.py

def export_environment(
    workspace: str,
    environment: str,
    path: str | Path,
) -> None:
    """
    Export an environment to path.

    Args:
        workspace (str): The name or ID of the workspace.
        environment (str): The name or ID of the environment.
        path (Union[str, Path]): The path to export to.
    """
    workspace_id = resolve_workspace(workspace)
    if workspace_id is None:
        return None

    item = get_environment(workspace_id, environment, df=False)
    try:
        folder_path = resolve_folder_from_id_to_path(
            workspace_id, item["folderId"]
        )
    except Exception:
        logger.info(
            f"{item['displayName']}.Environment is not inside a folder."
        )
        folder_path = None

    if folder_path is None:
        item_path = Path(path) / (item["displayName"] + ".Environment")
    else:
        item_path = (
            Path(path) / folder_path / (item["displayName"] + ".Environment")
        )
    os.makedirs(item_path, exist_ok=True)

    definition = get_environment_definition(workspace_id, item["id"])
    if definition is None:
        return None

    unpack_item_definition(definition, item_path)

    logger.success(
        f"`{item['displayName']}.Environment` was exported to {item_path} successfully."
    )
    return None

get_all_environments_config(workspace)

Get environments config from a workspace.

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID from the workspace.	required

Returns:

Type	Description
Union[Dict[str, Any], None]	The dict config of all environments in the workspace

Source code in src/pyfabricops/helpers/environments.py

def get_all_environments_config(
    workspace: str,
) -> dict[str, Any] | None:
    """
    Get environments config from a workspace.

    Args:
        workspace (str): The name or ID from the workspace.

    Returns:
        (Union[Dict[str, Any], None]): The dict config of all environments in the workspace
    """
    items = list_environments(workspace, df=False)

    if items is None:
        return None

    config = {}

    for item in items:
        get_environment(workspace, item["id"], df=False)

        config[item["displayName"]] = {
            "id": item["id"],
            "description": item.get("description", None),
            "folder_id": ""
            if item.get("folderId") is None or pd.isna(item.get("folderId"))
            else item["folderId"],
        }

    return config

get_environment_config(workspace, environment)

Get a specific environment config from a workspace.

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID of the workspace.	required
environment	str	The name or ID of the environment.	required

Returns:

Type	Description
Union[Dict[str, Any], None]	The dict config from the environment

Source code in src/pyfabricops/helpers/environments.py

def get_environment_config(
    workspace: str, environment: str
) -> dict[str, Any] | None:
    """
    Get a specific environment config from a workspace.

    Args:
        workspace (str): The name or ID of the workspace.
        environment (str): The name or ID of the environment.

    Returns:
        (Union[Dict[str, Any], None]): The dict config from the environment
    """
    item = environment
    item_data = get_environment(workspace, item, df=False)

    if item_data is None:
        return None

    else:
        config = {}
        config = config[item_data.get("displayName")] = {}

        config = {
            "id": item_data["id"],
            "description": item_data.get("description", None),
            "folder_id": ""
            if item_data.get("folderId") is None
            or pd.isna(item_data.get("folderId"))
            else item_data["folderId"],
        }

        return config