ipynb 0.0.1

Attempt at providing canonical structs to read/write Jupyter `.ipynb` (notebooks) files
Documentation 
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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
104
105
106
107
108
109
110
111
112
113

use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashMap;

#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Notebook {
    pub cells: Vec<Cell>,
    pub metadata: HashMap<String, Value>,
    pub nbformat: usize,
    pub nbformat_minor: usize,
}

#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
#[serde(tag = "cell_type")]
pub enum Cell {
    #[serde(rename = "markdown")]
    Markdown(MarkdownCell),
    #[serde(rename = "code")]
    Code(CodeCell),
    #[serde(rename = "raw")]
    Raw(RawCell),
}

#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
#[serde(tag = "output_type")]
#[serde(rename_all = "snake_case")]
pub enum Output {
    ExecuteResult(ExecuteResultOutput),
    Stream(StreamOutput),
    DisplayData(DisplayDataOutput),
    Error(ErrorOutput),
}

#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RawCell {
    pub metadata: HashMap<String, Value>,
    pub source: Vec<String>,
    pub id: Option<String>,
}

#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct CodeCell {
    pub metadata: HashMap<String, Value>,
    pub source: Vec<String>,
    pub id: Option<String>,
    // cell can be not executed, and it will then be null.
    pub execution_count: Option<usize>,
    pub outputs: Vec<Output>,
}

#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct StreamOutput {
    pub data: Option<HashMap<String, Value>>,
    pub metadata: Option<HashMap<String, Value>>,
    pub name: Option<String>,
    pub text: Option<Vec<String>>,
}

#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ExecuteResultOutput {
    pub data: Option<HashMap<String, Value>>,
    pub metadata: Option<HashMap<String, Value>>,
    pub name: Option<String>,
    pub execution_count: usize,
}

#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ErrorOutput {
    pub ename: String, //pub data: Option<HashMap<String, Value>>,
    pub evalue: String,
    pub traceback: Vec<String>,
    //pub metadata: Option<HashMap<String, Value>>,
    //pub name: Option<String>,
    //pub execution_count: usize
}

#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct DisplayDataOutput {
    pub data: Option<HashMap<String, Value>>,
    pub metadata: Option<HashMap<String, Value>>,
    pub name: Option<String>,
}

#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct MarkdownCell {
    pub metadata: HashMap<String, Value>,
    pub id: Option<String>,
    pub attachments: Option<HashMap<String, Value>>,
    pub source: Vec<String>,
}

#[cfg(test)]
mod tests {

    use super::Notebook;

    #[test]
    fn it_works() {
        let data = include_str!("test4.ipynb");
        let notebook: Notebook = serde_json::from_str(data).unwrap();
        assert_eq!(notebook.nbformat, 4);
    }
}