Skip to content

create_notebook_runtime_config

Public callable

Create notebook naming-policy configuration for runtime guards.

This is typically configured during 00_env_config so notebook validation helpers can enforce a consistent execution contract.

Parameters:

Name Type Description Default
allowed_notebook_prefixes list[str] | tuple[str, ...]

Prefixes accepted by notebook-name validation helpers.

required

Returns:

Type Description
NotebookRuntimeConfig

Immutable runtime policy containing normalized prefixes.

Raises:

Type Description
ValueError

Raised when no non-empty prefix remains after normalization.

Source code in src/fabricops_kit/config.py
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
def create_notebook_runtime_config(allowed_notebook_prefixes: list[str] | tuple[str, ...]) -> NotebookRuntimeConfig:
    """Create notebook naming-policy configuration for runtime guards.

    This is typically configured during ``00_env_config`` so notebook
    validation helpers can enforce a consistent execution contract.

    Parameters
    ----------
    allowed_notebook_prefixes : list[str] | tuple[str, ...]
        Prefixes accepted by notebook-name validation helpers.

    Returns
    -------
    NotebookRuntimeConfig
        Immutable runtime policy containing normalized prefixes.

    Raises
    ------
    ValueError
        Raised when no non-empty prefix remains after normalization.
    """
    prefixes = tuple(prefix.strip() for prefix in allowed_notebook_prefixes if str(prefix).strip())
    if not prefixes:
        raise ValueError("allowed_notebook_prefixes must contain at least one non-empty prefix.")
    return NotebookRuntimeConfig(allowed_notebook_prefixes=prefixes)