don't write or read transient values to disk

- orig_nbformat
- orig_nbformat_minor
- cell.metadata.trusted

IPython/nbformat/v3/nbjson.py

@@ -1,34 +1,19 b''
-"""Read and write notebooks in JSON format.
+"""Read and write notebooks in JSON format."""
 
-Authors:
-
-* Brian Granger
-"""
-
-#-----------------------------------------------------------------------------
-#  Copyright (C) 2008-2011  The IPython Development Team
-#
-#  Distributed under the terms of the BSD License.  The full license is in
-#  the file COPYING, distributed as part of this software.
-#-----------------------------------------------------------------------------
-
-#-----------------------------------------------------------------------------
-# Imports
-#-----------------------------------------------------------------------------
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
 
 import copy
 import json
 
 from .nbbase import from_dict
 from .rwbase import (
-    NotebookReader, NotebookWriter, restore_bytes, rejoin_lines, split_lines
+    NotebookReader, NotebookWriter, restore_bytes, rejoin_lines, split_lines,
+    strip_transient,
 )
 
 from IPython.utils import py3compat
 
-#-----------------------------------------------------------------------------
-# Code
-#-----------------------------------------------------------------------------
 
 class BytesEncoder(json.JSONEncoder):
     """A JSON encoder that accepts b64 (and other *ascii*) bytestrings."""
@@ -43,6 +28,7 b' class JSONReader(NotebookReader):'
     def reads(self, s, **kwargs):
         nb = json.loads(s, **kwargs)
         nb = self.to_notebook(nb, **kwargs)
+        nb = strip_transient(nb)
         return nb
 
     def to_notebook(self, d, **kwargs):
@@ -56,8 +42,10 b' class JSONWriter(NotebookWriter):'
         kwargs['indent'] = 1
         kwargs['sort_keys'] = True
         kwargs['separators'] = (',',': ')
+        nb = copy.deepcopy(nb)
+        nb = strip_transient(nb)
         if kwargs.pop('split_lines', True):
-            nb = split_lines(copy.deepcopy(nb))
+            nb = split_lines(nb)
         return py3compat.str_to_unicode(json.dumps(nb, **kwargs), 'utf-8')
     
 

IPython/nbformat/v3/rwbase.py

@@ -1,30 +1,13 b''
-"""Base classes and utilities for readers and writers.
+"""Base classes and utilities for readers and writers."""
 
-Authors:
-
-* Brian Granger
-"""
-
-#-----------------------------------------------------------------------------
-#  Copyright (C) 2008-2011  The IPython Development Team
-#
-#  Distributed under the terms of the BSD License.  The full license is in
-#  the file COPYING, distributed as part of this software.
-#-----------------------------------------------------------------------------
-
-#-----------------------------------------------------------------------------
-# Imports
-#-----------------------------------------------------------------------------
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
 
 from base64 import encodestring, decodestring
-import pprint
 
 from IPython.utils import py3compat
 from IPython.utils.py3compat import str_to_bytes, unicode_type, string_types
 
-#-----------------------------------------------------------------------------
-# Code
-#-----------------------------------------------------------------------------
 
 def restore_bytes(nb):
     """Restore bytes of image data from unicode-only formats.
@@ -157,6 +140,19 b' def base64_encode(nb):'
     return nb
 
 
+def strip_transient(nb):
+    """Strip transient values that shouldn't be stored in files.
+
+    This should be called in *both* read and write.
+    """
+    nb.pop('orig_nbformat', None)
+    nb.pop('orig_nbformat_minor', None)
+    for ws in nb['worksheets']:
+        for cell in ws['cells']:
+            cell.get('metadata', {}).pop('trusted', None)
+    return nb
+
+
 class NotebookReader(object):
     """A class for reading notebooks."""
 

IPython/nbformat/v3/tests/test_json.py

@@ -1,9 +1,11 b''
-import pprint
+import copy
+import json
 from base64 import decodestring
 from unittest import TestCase
 
 from IPython.utils.py3compat import unicode_type
 from ..nbjson import reads, writes
+from ..nbbase import from_dict
 from .. import nbjson
 from .nbexamples import nb0
 
@@ -31,6 +33,35 b' class TestJSON(formattest.NBFormatTest, TestCase):'
         s = writes(nb0, split_lines=True)
         self.assertEqual(nbjson.reads(s),nb0)
 
+    def test_strip_transient(self):
+        """transient values aren't written to files"""
+        nb = copy.deepcopy(nb0)
+        nb.orig_nbformat = 2
+        nb.orig_nbformat_minor = 3
+        nb.worksheets[0].cells[0].metadata.trusted = False
+        nbs = nbjson.writes(nb)
+
+        nb2 = from_dict(json.loads(nbs))
+        self.assertNotIn('orig_nbformat', nb2)
+        self.assertNotIn('orig_nbformat_minor', nb2)
+        for cell in nb2.worksheets[0].cells:
+            self.assertNotIn('trusted', cell.metadata)
+
+    def test_to_json(self):
+        """to_notebook_json doesn't strip transient"""
+        nb = copy.deepcopy(nb0)
+        nb.orig_nbformat = 2
+        nb.orig_nbformat_minor = 3
+        nb.worksheets[0].cells[0].metadata.trusted = False
+        nbs = json.dumps(nb)
+        nb2 = nbjson.to_notebook(json.loads(nbs))
+
+        nb2 = from_dict(json.loads(nbs))
+        self.assertIn('orig_nbformat', nb2)
+        self.assertIn('orig_nbformat_minor', nb2)
+        cell = nb2.worksheets[0].cells[0]
+        self.assertIn('trusted', cell.metadata)
+
     def test_read_png(self):
         """PNG output data is b64 unicode"""
         s = writes(nb0)