Notebooks

deploy_all_notebooks(workspace, path, start_path=None)

Deploy all notebooks to workspace.

Parameters:

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

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

def deploy_all_notebooks(
    workspace: str,
    path: str,
    start_path: Optional[str] = None,
) -> None:
    """
    Deploy all notebooks to workspace.

    Args:
        workspace (str): The name or ID of the workspace.
        path (str): The path to the notebooks.
        start_path (Optional[str]): The starting path for folder creation.
    """
    workspace_id = resolve_workspace(workspace)
    if workspace_id is None:
        return None

    notebooks_paths = list_paths_of_type(path, 'Notebook')

    for path_ in notebooks_paths:

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

        item_id = resolve_notebook(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 item_id is None:
            create_notebook(
                workspace_id,
                display_name=display_name,
                item_definition=item_definition,
                folder=folder_id,
                df=False,
            )

        else:
            update_notebook_definition(
                workspace_id,
                item_id,
                item_definition=item_definition,
                df=False,
            )

    logger.success(
        f'All notebooks were deployed to workspace "{workspace}" successfully.'
    )
    return None

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

Deploy a notebook to workspace.

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID of the workspace.	required
path	str	The path to the notebook.	required
start_path	Optional[str]	The starting path for folder creation.	None
description	Optional[str]	Description for the notebook.	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 notebook or None if deployment fails.

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

@df
def deploy_notebook(
    workspace: str,
    path: str,
    start_path: Optional[str] = None,
    description: Optional[str] = None,
    df: Optional[bool] = True,
) -> Union[DataFrame, Dict[str, Any], None]:
    """
    Deploy a notebook to workspace.

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

    Returns:
        (Union[DataFrame, Dict[str, Any], None]): The deployed notebook 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

    item_id = resolve_notebook(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 item_id is None:
        return create_notebook(
            workspace_id,
            display_name=display_name,
            item_definition=item_definition,
            description=description,
            folder=folder_id,
            df=False,
        )

    else:
        return update_notebook_definition(
            workspace_id,
            item_id,
            item_definition=item_definition,
            df=False,
        )

export_all_notebooks(workspace, path)

Export a notebook 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/notebooks.py

def export_all_notebooks(
    workspace: str,
    path: Union[str, Path],
) -> None:
    """
    Export a notebook 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_notebooks(workspace_id, df=False)
    if items is None:
        return None

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

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

        definition = get_notebook_definition(workspace_id, item['id'])
        if definition is None:
            return None

        unpack_item_definition(definition, item_path)

    logger.success(f'All notebooks were exported to {path} successfully.')
    return None

export_notebook(workspace, notebook, path)

Export a notebook to path.

Parameters:

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

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

def export_notebook(
    workspace: str,
    notebook: str,
    path: Union[str, Path],
) -> None:
    """
    Export a notebook to path.

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

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

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

    definition = get_notebook_definition(workspace_id, item['id'])
    if definition is None:
        return None

    unpack_item_definition(definition, item_path)

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

extract_notebook_parameters(path)

Extract parameters from a Fabric notebook-content.py file.

Parameters:

Name	Type	Description	Default
path	str	Path to the Notebook	required

Returns:

Type	Description
List[Dict[str, Any]]	List of dictionaries containing the extracted parameters

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

def extract_notebook_parameters(path: str) -> List[Dict[str, Any]]:
    """
    Extract parameters from a Fabric notebook-content.py file.

    Args:
        path (str): Path to the Notebook

    Returns:
        (List[Dict[str, Any]]): List of dictionaries containing the extracted parameters
    """
    path = Path(path) / 'notebook-content.py'

    with open(path, 'r', encoding='utf-8') as f:
        content = f.read()

    parameters = []

    # Find the PARAMETERS CELL section
    # Look for "# PARAMETERS CELL ********************" followed by the parameters
    parameters_pattern = (
        r'# PARAMETERS CELL \*+\s*\n(.*?)(?=# METADATA|# CELL|# MARKDOWN|$)'
    )
    parameters_match = re.search(parameters_pattern, content, re.DOTALL)

    if parameters_match:
        parameters_content = parameters_match.group(1).strip()

        # Extract variable assignments
        # Pattern to find variable = "value" or variable = f"value"
        variable_patterns = [
            r'(\w+)\s*=\s*"([^"]*)"',  # variable = "value"
            r'(\w+)\s*=\s*f"([^"]*)"',  # variable = f"value"
            r'(\w+)\s*=\s*\'([^\']*)\'',  # variable = 'value'
            r'(\w+)\s*=\s*f\'([^\']*)\'',  # variable = f'value'
        ]

        for pattern in variable_patterns:
            matches = re.findall(pattern, parameters_content)
            for var_name, var_value in matches:
                # Skip variables that are derived from other variables (contain f-string references)
                if not re.search(r'\{[^}]+\}', var_value):
                    parameters.append(
                        {
                            'variable_name': var_name,
                            'variable_value': var_value,
                            'parameter_type': 'string',
                        }
                    )

        # Also look for numeric and boolean assignments
        numeric_pattern = r'(\w+)\s*=\s*(\d+(?:\.\d+)?)'
        numeric_matches = re.findall(numeric_pattern, parameters_content)
        for var_name, var_value in numeric_matches:
            parameters.append(
                {
                    'variable_name': var_name,
                    'variable_value': var_value,
                    'parameter_type': 'numeric',
                }
            )

        boolean_pattern = r'(\w+)\s*=\s*(True|False)'
        boolean_matches = re.findall(boolean_pattern, parameters_content)
        for var_name, var_value in boolean_matches:
            parameters.append(
                {
                    'variable_name': var_name,
                    'variable_value': var_value,
                    'parameter_type': 'boolean',
                }
            )

    return parameters

get_all_notebooks_config(workspace)

Get notebooks 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 notebooks in the workspace

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

def get_all_notebooks_config(
    workspace: str,
) -> Union[Dict[str, Any], None]:
    """
    Get notebooks 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 notebooks in the workspace
    """
    items = list_notebooks(workspace, df=False)

    if items is None:
        return None

    config = {}

    for item in items:

        item_data = get_notebook(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_notebook_config(workspace, notebook)

Get a specific notebook config from a workspace.

Parameters:

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

Returns:

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

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

def get_notebook_config(
    workspace: str, notebook: str
) -> Union[Dict[str, Any], None]:
    """
    Get a specific notebook config from a workspace.

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

    Returns:
        (Union[Dict[str, Any], None]): The dict config from the notebook.
    """
    item = notebook
    item_data = get_notebook(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

replace_notebook_parameters_with_placeholders(path, parameters)

Replace parameters with placeholders in a Fabric notebook-content.py file.

Parameters:

Name	Type	Description	Default
path	str	Path to the Notebook	required
parameters	list	List of parameter dictionaries to replace	required

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

def replace_notebook_parameters_with_placeholders(
    path: str, parameters: List[Dict[str, Any]]
) -> None:
    """
    Replace parameters with placeholders in a Fabric notebook-content.py file.

    Args:
        path (str): Path to the Notebook
        parameters (list): List of parameter dictionaries to replace
    """
    notebook_name = path.split('/')[-1].split('.Notebook')[0]

    path = Path(path) / 'notebook-content.py'

    with open(path, 'r', encoding='utf-8') as f:
        content = f.read()

    # Replace each parameter with a placeholder
    for param_dict in parameters:
        var_name = param_dict['variable_name']
        var_value = param_dict['variable_value']
        param_type = param_dict['parameter_type']

        placeholder = f'#{{{notebook_name}_{var_name}}}#'

        # Create different replacement patterns based on parameter type
        if param_type == 'string':
            # Handle both regular strings and f-strings
            old_patterns = [
                f'{var_name} = "{var_value}"',
                f'{var_name} = f"{var_value}"',
                f"{var_name} = '{var_value}'",
                f"{var_name} = f'{var_value}'",
            ]
            new_value = f'{var_name} = "{placeholder}"'
        elif param_type in ['numeric', 'boolean']:
            old_patterns = [f'{var_name} = {var_value}']
            new_value = f'{var_name} = "{placeholder}"'

        # Replace all matching patterns
        for old_pattern in old_patterns:
            if old_pattern in content:
                content = content.replace(old_pattern, new_value)
                break

    with open(path, 'w', encoding='utf-8') as f:
        f.write(content)

replace_notebook_placeholders_with_parameters(path, parameters)

Replace placeholders with actual parameters in a Fabric notebook-content.py file.

Parameters:

Name	Type	Description	Default
path	str	Path to the Notebook	required
parameters	list	List of parameter dictionaries with actual values	required

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

def replace_notebook_placeholders_with_parameters(
    path: str, parameters: List[Dict[str, Any]]
) -> None:
    """
    Replace placeholders with actual parameters in a Fabric notebook-content.py file.

    Args:
        path (str): Path to the Notebook
        parameters (list): List of parameter dictionaries with actual values
    """
    notebook_name = path.split('/')[-1].split('.Notebook')[0]

    path = Path(path) / 'notebook-content.py'

    with open(path, 'r', encoding='utf-8') as f:
        content = f.read()

    # Replace placeholders with actual values
    for param_dict in parameters:
        var_name = param_dict['variable_name']
        var_value = param_dict['variable_value']
        param_type = param_dict['parameter_type']

        placeholder = f'#{{{notebook_name}_{var_name}}}#'

        # Restore original format based on parameter type
        if param_type == 'string':
            new_value = f'{var_name} = "{var_value}"'
        elif param_type in ['numeric', 'boolean']:
            new_value = f'{var_name} = {var_value}'

        # Replace placeholder with original value
        old_pattern = f'{var_name} = "{placeholder}"'
        if old_pattern in content:
            content = content.replace(old_pattern, new_value)

    with open(path, 'w', encoding='utf-8') as f:
        f.write(content)