Changed convert.upgrade to upgrade minor 4.x versions to 4.5

Author: MSeal

docs/changelog.rst

@@ -7,6 +7,11 @@ Changes in nbformat
 In Development
 ==============
 
+5.1.1
+=====
+
+- Changes convert.upgrade to upgrade minor 4.x versions to 4.5
+
 5.1.0
 =====
 

nbformat/v4/convert.py

@@ -23,8 +23,8 @@ def _warn_if_invalid(nb, version):
     except ValidationError as e:
         get_logger().error("Notebook JSON is not valid v%i: %s", version, e)
 
-def upgrade(nb, from_version=3, from_minor=0):
-    """Convert a notebook to v4.
+def upgrade(nb, from_version=None, from_minor=None):
+    """Convert a notebook to latest v4.
 
     Parameters
     ----------
@@ -35,6 +35,11 @@ def upgrade(nb, from_version=3, from_minor=0):
     from_minor : int
         The original minor version of the notebook to convert (only relevant for v >= 3).
     """
+    if not from_version:
+        from_version = nb['nbformat']
+    if not from_minor:
+        from_minor = nb['nbformat_minor']
+
     if from_version == 3:
         # Validate the notebook before conversion
         _warn_if_invalid(nb, from_version)
@@ -64,9 +69,18 @@ def upgrade(nb, from_version=3, from_minor=0):
         _warn_if_invalid(nb, nbformat)
         return nb
     elif from_version == 4:
-        # nothing to do
-        if from_minor != nbformat_minor:
-            nb.metadata.orig_nbformat_minor = from_minor
+        if from_minor == nbformat_minor:
+            return
+
+        # other versions migration code e.g.
+        # if from_minor < 3:
+        # if from_minor < 4:
+
+        if from_minor < 5:
+            for cell in nb.cells:
+                cell.id = random_cell_id()
+
+        nb.metadata.orig_nbformat_minor = from_minor
         nb.nbformat_minor = nbformat_minor
 
         return nb

nbformat/v4/tests/test_convert.py

@@ -1,9 +1,12 @@
 # -*- coding: utf-8 -*-
+import os
+import io
 import copy
 
 from unittest import mock
 from nbformat import validate
 from .. import convert
+from ..nbjson import reads
 
 from . import nbexamples
 from nbformat.v3.tests import nbexamples as v3examples
@@ -73,3 +76,16 @@ def test_downgrade_heading():
     ]:
         downgraded = convert.downgrade_cell(v4cell)
         assert downgraded == expected
+
+def test_upgrade_v4_to_4_dot_5():
+    here = os.path.dirname(__file__)
+    with io.open(os.path.join(here, os.pardir, os.pardir, 'tests', "test4.ipynb"), encoding='utf-8') as f:
+        nb = reads(f.read())
+    assert nb['nbformat_minor'] == 0
+    validate(nb)
+    assert nb.cells[0].get('id') is None
+
+    nb_up = convert.upgrade(nb)
+    assert nb_up['nbformat_minor'] == 5
+    validate(nb_up)
+    assert nb_up.cells[0]['id'] is not None