Skip to content

assert_notebook_name_valid

Public callable

Raise :class:NotebookNamingError when a notebook name is invalid.

Parameters:

Name Type Description Default
name str | None

Notebook name. When omitted, inferred from Fabric runtime context.

None
allowed_prefixes list[str] | None

Optional legacy prefix list. When omitted, the finalized notebook model is enforced.

None

Raises:

Type Description
NotebookNamingError

If name fails :func:validate_notebook_name checks.

Examples:

>>> assert_notebook_name_valid("02_ex_email_metadata_event_logic")
>>> assert_notebook_name_valid("03_pc_email_metadata_source_to_unified")
Source code in src/fabricops_kit/runtime.py
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 assert_notebook_name_valid(name: str | None = None, allowed_prefixes: list[str] | None = None, config: object | None = None, local_fallback_name: str | None = None) -> None:
    """Raise :class:`NotebookNamingError` when a notebook name is invalid.

    Parameters
    ----------
    name : str | None, optional
        Notebook name. When omitted, inferred from Fabric runtime context.
    allowed_prefixes : list[str] | None, optional
        Optional legacy prefix list. When omitted, the finalized notebook model
        is enforced.

    Raises
    ------
    NotebookNamingError
        If ``name`` fails :func:`validate_notebook_name` checks.

    Examples
    --------
    >>> assert_notebook_name_valid("02_ex_email_metadata_event_logic")
    >>> assert_notebook_name_valid("03_pc_email_metadata_source_to_unified")
    """
    errors = validate_notebook_name(name=name, allowed_prefixes=allowed_prefixes, config=config, local_fallback_name=local_fallback_name)
    if errors:
        raise NotebookNamingError(" ".join(errors))