Skip to content

load_fabric_config

Public callable

Validate and return a user-supplied framework configuration.

This public wrapper is typically called from 00_env_config notebooks before any read/write helper runs, so path/policy defaults are validated early in the workflow.

Parameters:

Name Type Description Default
config FrameworkConfig | dict

Framework config object or compatible mapping assembled during notebook bootstrap.

required

Returns:

Type Description
FrameworkConfig

Validated framework configuration ready for bootstrap/runtime and IO helper consumption.

Raises:

Type Description
ValueError

Propagated when validation fails for required config sections or path target structure.

Notes

This function validates policy/routing/default configuration only. It does not create Fabric resources, execute data IO, or mutate external state.

Examples:

>>> cfg = load_fabric_config(framework_config)
>>> isinstance(cfg, FrameworkConfig)
True
Source code in src/fabricops_kit/fabric_io.py
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def load_fabric_config(config: FrameworkConfig | dict) -> FrameworkConfig:
    """Validate and return a user-supplied framework configuration.

    This public wrapper is typically called from ``00_env_config`` notebooks
    before any read/write helper runs, so path/policy defaults are validated
    early in the workflow.

    Parameters
    ----------
    config : FrameworkConfig | dict
        Framework config object or compatible mapping assembled during
        notebook bootstrap.

    Returns
    -------
    FrameworkConfig
        Validated framework configuration ready for bootstrap/runtime and IO
        helper consumption.

    Raises
    ------
    ValueError
        Propagated when validation fails for required config sections or path
        target structure.

    Notes
    -----
    This function validates policy/routing/default configuration only. It does
    not create Fabric resources, execute data IO, or mutate external state.

    Examples
    --------
    >>> cfg = load_fabric_config(framework_config)
    >>> isinstance(cfg, FrameworkConfig)
    True
    """
    return load_framework_config(config)