fixes #1578

Author: jph00

nbdev/_modidx.py

@@ -113,7 +113,8 @@
                                    'nbdev.frontmatter._dict2fm': ('api/frontmatter.html#_dict2fm', 'nbdev/frontmatter.py'),
                                    'nbdev.frontmatter._fm2dict': ('api/frontmatter.html#_fm2dict', 'nbdev/frontmatter.py'),
                                    'nbdev.frontmatter._insertfm': ('api/frontmatter.html#_insertfm', 'nbdev/frontmatter.py'),
-                                   'nbdev.frontmatter._md2dict': ('api/frontmatter.html#_md2dict', 'nbdev/frontmatter.py')},
+                                   'nbdev.frontmatter._md2dict': ('api/frontmatter.html#_md2dict', 'nbdev/frontmatter.py'),
+                                   'nbdev.frontmatter.nb_frontmatter': ('api/frontmatter.html#nb_frontmatter', 'nbdev/frontmatter.py')},
             'nbdev.imports': {},
             'nbdev.maker': { 'nbdev.maker.ModuleMaker': ('api/maker.html#modulemaker', 'nbdev/maker.py'),
                              'nbdev.maker.ModuleMaker.__init__': ('api/maker.html#modulemaker.__init__', 'nbdev/maker.py'),

nbdev/frontmatter.py

@@ -3,7 +3,7 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/09_frontmatter.ipynb.
 
 # %% auto #0
-__all__ = ['FrontmatterProc']
+__all__ = ['nb_frontmatter', 'FrontmatterProc']
 
 # %% ../nbs/api/09_frontmatter.ipynb #2398f5ef-06d3-4890-8a54-7cf4f81f3894
 from .imports import *
@@ -42,6 +42,13 @@ def _md2dict(s:str):
         except Exception as e: warn(f'Failed to create YAML dict for:\n{r}\n\n{e}\n')
     return res
 
+def nb_frontmatter(nb):
+    "Get frontmatter dict from `nb` without modifying cells"
+    for c in nb.cells:
+        if c.cell_type=='raw': return _fm2dict(c.source)
+        if c.cell_type=='markdown': return _md2dict(c.source)
+    return {}
+
 # %% ../nbs/api/09_frontmatter.ipynb #1b5d9d32
 def _dict2fm(d): return f'---\n{yaml.dump(d)}\n---\n\n'
 def _insertfm(nb, fm): nb.cells.insert(0, mk_cell(_dict2fm(fm), 'raw'))

nbdev/test.py

@@ -17,7 +17,7 @@
 from .config import *
 from .doclinks import *
 from .process import NBProcessor, nb_lang
-from .frontmatter import FrontmatterProc
+from .frontmatter import nb_frontmatter
 
 from execnb.nbio import *
 from execnb.shell import *
@@ -29,13 +29,14 @@ def test_nb(fn,  # file name of notebook to test
             do_print=False,  # print completion?
             showerr=True,  # print errors to stderr?
             basepath=None,  # path to add to sys.path
-            verbose=False):  # stream stdout/stderr from cells to console?
+            verbose=False,  # stream stdout/stderr from cells to console?
+            save=False):  # write outputs back to notebook on success?
     "Execute tests in notebook in `fn` except those with `skip_flags`"
     if basepath: sys.path.insert(0, str(basepath))
     if not IN_NOTEBOOK: os.environ["IN_TEST"] = '1'
     flags=set(L(skip_flags)) - set(L(force_flags))
-    nb = NBProcessor(fn, procs=FrontmatterProc, process=True).nb
-    fm = getattr(nb, 'frontmatter_', {})
+    nb = NBProcessor(fn, rm_directives=False, process=True).nb
+    fm = nb_frontmatter(nb)
     if str2bool(fm.get('skip_exec', False)) or nb_lang(nb) != 'python': return True, 0
 
     def _no_eval(cell):
@@ -51,6 +52,7 @@ def _no_eval(cell):
     try:
         with working_directory(fn.parent):
             k.run_all(nb, exc_stop=True, preproc=_no_eval, verbose=verbose)
+            if save: write_nb(nb, fn)
             res = True
     except: 
         if showerr: sys.stderr.write(k.prettytb(fname=fn)+'\n')
@@ -78,6 +80,7 @@ def nbdev_test(
     pause:float=0.01,  # Pause time (in seconds) between notebooks to avoid race conditions
     ignore_fname:str='.notest', # Filename that will result in siblings being ignored
     verbose:bool=False, # Print stdout/stderr from notebook cells?
+    save:bool=False, # Write outputs back to notebooks on success?
     **kwargs):
     "Test in parallel notebooks matching `path`, passing along `flags`"
     skip_flags = get_config().tst_flags
@@ -92,7 +95,7 @@ def nbdev_test(
     wd_pth = get_config().nbs_path
     with working_directory(wd_pth if (wd_pth and wd_pth.exists()) else os.getcwd()):
         results = parallel(test_nb, files, skip_flags=skip_flags, force_flags=force_flags, n_workers=n_workers,
-                           basepath=get_config().config_path, pause=pause, do_print=do_print, verbose=verbose, **kw)
+                           basepath=get_config().config_path, pause=pause, do_print=do_print, verbose=verbose, save=save, **kw)
     passed,times = zip(*results)
     if all(passed): print("Success.")
     else: 

nbs/api/09_frontmatter.ipynb

@@ -93,7 +93,14 @@
     "    if r:\n",
     "        try: res.update(yaml.safe_load('\\n'.join(r)))\n",
     "        except Exception as e: warn(f'Failed to create YAML dict for:\\n{r}\\n\\n{e}\\n')\n",
-    "    return res"
+    "    return res\n",
+    "\n",
+    "def nb_frontmatter(nb):\n",
+    "    \"Get frontmatter dict from `nb` without modifying cells\"\n",
+    "    for c in nb.cells:\n",
+    "        if c.cell_type=='raw': return _fm2dict(c.source)\n",
+    "        if c.cell_type=='markdown': return _md2dict(c.source)\n",
+    "    return {}"
    ]
   },
   {
@@ -278,13 +285,7 @@
    "source": []
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "python3",
-   "language": "python",
-   "name": "python3"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
 }

nbs/api/12_test.ipynb

@@ -39,7 +39,7 @@
     "from nbdev.config import *\n",
     "from nbdev.doclinks import *\n",
     "from nbdev.process import NBProcessor, nb_lang\n",
-    "from nbdev.frontmatter import FrontmatterProc\n",
+    "from nbdev.frontmatter import nb_frontmatter\n",
     "\n",
     "from execnb.nbio import *\n",
     "from execnb.shell import *"
@@ -59,13 +59,14 @@
     "            do_print=False,  # print completion?\n",
     "            showerr=True,  # print errors to stderr?\n",
     "            basepath=None,  # path to add to sys.path\n",
-    "            verbose=False):  # stream stdout/stderr from cells to console?\n",
+    "            verbose=False,  # stream stdout/stderr from cells to console?\n",
+    "            save=False):  # write outputs back to notebook on success?\n",
     "    \"Execute tests in notebook in `fn` except those with `skip_flags`\"\n",
     "    if basepath: sys.path.insert(0, str(basepath))\n",
     "    if not IN_NOTEBOOK: os.environ[\"IN_TEST\"] = '1'\n",
     "    flags=set(L(skip_flags)) - set(L(force_flags))\n",
-    "    nb = NBProcessor(fn, procs=FrontmatterProc, process=True).nb\n",
-    "    fm = getattr(nb, 'frontmatter_', {})\n",
+    "    nb = NBProcessor(fn, rm_directives=False, process=True).nb\n",
+    "    fm = nb_frontmatter(nb)\n",
     "    if str2bool(fm.get('skip_exec', False)) or nb_lang(nb) != 'python': return True, 0\n",
     "\n",
     "    def _no_eval(cell):\n",
@@ -81,6 +82,7 @@
     "    try:\n",
     "        with working_directory(fn.parent):\n",
     "            k.run_all(nb, exc_stop=True, preproc=_no_eval, verbose=verbose)\n",
+    "            if save: write_nb(nb, fn)\n",
     "            res = True\n",
     "    except: \n",
     "        if showerr: sys.stderr.write(k.prettytb(fname=fn)+'\\n')\n",
@@ -172,6 +174,7 @@
     "    pause:float=0.01,  # Pause time (in seconds) between notebooks to avoid race conditions\n",
     "    ignore_fname:str='.notest', # Filename that will result in siblings being ignored\n",
     "    verbose:bool=False, # Print stdout/stderr from notebook cells?\n",
+    "    save:bool=False, # Write outputs back to notebooks on success?\n",
     "    **kwargs):\n",
     "    \"Test in parallel notebooks matching `path`, passing along `flags`\"\n",
     "    skip_flags = get_config().tst_flags\n",
@@ -186,7 +189,7 @@
     "    wd_pth = get_config().nbs_path\n",
     "    with working_directory(wd_pth if (wd_pth and wd_pth.exists()) else os.getcwd()):\n",
     "        results = parallel(test_nb, files, skip_flags=skip_flags, force_flags=force_flags, n_workers=n_workers,\n",
-    "                           basepath=get_config().config_path, pause=pause, do_print=do_print, verbose=verbose, **kw)\n",
+    "                           basepath=get_config().config_path, pause=pause, do_print=do_print, verbose=verbose, save=save, **kw)\n",
     "    passed,times = zip(*results)\n",
     "    if all(passed): print(\"Success.\")\n",
     "    else: \n",
@@ -253,14 +256,6 @@
     "#| hide\n",
     "import nbdev; nbdev.nbdev_export()"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "86f62c6e",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {},