nb-cli 0.0.9

A command-line tool for reading, writing, and executing Jupyter notebooks
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

use anyhow::{Context, Result};
use nbformat::v4::Notebook;
use std::fs;
use std::path::Path;

/// Read a Jupyter notebook from a file
pub fn read_notebook(path: impl AsRef<Path>) -> Result<Notebook> {
    let content = fs::read_to_string(&path).context("Failed to read notebook file")?;

    let notebook = nbformat::parse_notebook(&content).context("Failed to parse notebook")?;

    match notebook {
        nbformat::Notebook::V4(nb) => Ok(nb),
        _ => anyhow::bail!("Only nbformat v4 notebooks are supported"),
    }
}

/// Write a Jupyter notebook to a file
pub fn write_notebook(path: impl AsRef<Path>, notebook: &Notebook) -> Result<()> {
    let notebook_enum = nbformat::Notebook::V4(notebook.clone());
    let content = serialize_notebook(&notebook_enum)?;
    fs::write(path, content)?;
    Ok(())
}

/// Write a Jupyter notebook to a file atomically using a temporary file
/// This prevents corruption if the write operation is interrupted
pub fn write_notebook_atomic(path: impl AsRef<Path>, notebook: &Notebook) -> Result<()> {
    let path = path.as_ref();

    // Create a temporary file in the same directory
    let temp_path = path.with_extension("ipynb.tmp");

    // Write to temporary file first
    write_notebook(&temp_path, notebook).context("Failed to write to temporary file")?;

    // Atomically rename temporary file to target file
    fs::rename(&temp_path, path).context("Failed to rename temporary file to target")?;

    Ok(())
}

/// Serialize a notebook to JSON string
fn serialize_notebook(notebook: &nbformat::Notebook) -> Result<String> {
    nbformat::serialize_notebook(notebook).context("Failed to serialize notebook")
}