Merge pull request #21 from julienr/attachments

Add a new attachment property for cells.
jupyter · Mar 8, 2016 · 7ab61f3 · 7ab61f3
2 parents 2b99adc + da965ca
commit 7ab61f3
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 1 deletion.
diff --git a/docs/format_description.rst b/docs/format_description.rst
@@ -155,6 +155,7 @@ stream output
     The ``stream`` key was changed to ``name`` to match
     the stream message.
 
+.. _display-data:
 
 display_data
 ************
@@ -291,6 +292,35 @@ regardless of format.
       "source" : "[some nbformat output text]"
     }
 
+
+Cell attachments
+----------------
+.. versionadded:: 4.1
+
+Markdown and raw cells can have a number of attachments, typically inline
+images that can be referenced in the markdown content of a cell. The ``attachments``
+dictionary of a cell contains a set of mime-bundles (see :ref:`display_data`)
+keyed by filename that represents the files attached to the cell.
+
+.. note::
+
+  The ``attachments`` dictionary is an optional field and can be undefined or empty if the cell does not have any attachments.
+
+
+.. sourcecode:: python
+
+    {
+      "cell_type" : "markdown",
+      "metadata" : {},
+      "source" : ["Here is an *inline* image ![inline image](attachment:test.png)"],
+      "attachments" : {
+        "test.png": {
+            "image/png" : ["base64-encoded-png-data"],
+        },
+      },
+    }
+
+
 Backward-compatible changes
 ===========================
 

diff --git a/nbformat/v4/nbbase.py b/nbformat/v4/nbbase.py
@@ -13,7 +13,7 @@
 
 # Change this when incrementing the nbformat version
 nbformat = 4
-nbformat_minor = 0
+nbformat_minor = 1
 nbformat_schema = 'nbformat.v4.schema.json'
 
 

diff --git a/nbformat/v4/nbformat.v4.schema.json b/nbformat/v4/nbformat.v4.schema.json
@@ -113,6 +113,7 @@
                         "tags": {"$ref": "#/definitions/misc/metadata_tags"}
                     }
                 },
+                "attachments": {"$ref": "#/definitions/misc/attachments"},
                 "source": {"$ref": "#/definitions/misc/source"}
             }
         },
@@ -136,6 +137,7 @@
                     },
                     "additionalProperties": true
                 },
+                "attachments": {"$ref": "#/definitions/misc/attachments"},
                 "source": {"$ref": "#/definitions/misc/source"}
             }
         },
@@ -327,6 +329,16 @@
                     "pattern": "^[^,]+$"
                 }
             },
+            "attachments": {
+                "description": "Media attachments (e.g. inline images), stored as mimebundle keyed by filename.",
+                "type": "object",
+                "patternProperties": {
+                    ".*": {
+                        "description": "The attachment's data stored as a mimebundle.",
+                        "$ref": "#/definitions/misc/mimebundle"
+                    }
+                }
+            },
             "source": {
                 "description": "Contents of the cell, represented as an array of lines.",
                 "$ref": "#/definitions/misc/multiline_string"