nbdev 2.3.25__py3-none-any.whl → 2.4.8__py3-none-any.whl

nbdev/export.py

@@ -1,9 +1,11 @@
+"""Exporting a notebook to a library"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/04_export.ipynb.
 
 # %% auto 0
 __all__ = ['ExportModuleProc', 'black_format', 'scrub_magics', 'optional_procs', 'nb_export']
 
-# %% ../nbs/api/04_export.ipynb 2
+# %% ../nbs/api/04_export.ipynb
 from .config import *
 from .maker import *
 from .imports import *
@@ -12,10 +14,11 @@ from .process import *
 from fastcore.script import *
 from fastcore.basics import *
 from fastcore.imports import *
+from fastcore.meta import *
 
 from collections import defaultdict
 
-# %% ../nbs/api/04_export.ipynb 4
+# %% ../nbs/api/04_export.ipynb
 class ExportModuleProc:
     "A processor which exports code to a module"
     def begin(self): self.modules,self.in_all = defaultdict(L),defaultdict(L)
@@ -24,9 +27,13 @@ class ExportModuleProc:
     def _export_(self, cell, exp_to=None):
         self._exporti_(cell, exp_to)
         self.in_all[ifnone(exp_to, '#')].append(cell)
+    def __call__(self, cell):
+        src = cell.source
+        if not src: return
+        if cell.cell_type=='markdown' and src.startswith('# '): self.modules['#'].append(cell)
     _exports_=_export_
 
-# %% ../nbs/api/04_export.ipynb 8
+# %% ../nbs/api/04_export.ipynb
 def black_format(cell, # Cell to format
                  force=False): # Turn black formatting on regardless of settings.ini
     "Processor to format code with `black`"
@@ -40,7 +47,7 @@ def black_format(cell, # Cell to format
         try: cell.source = _format_str(cell.source).strip()
         except: pass
 
-# %% ../nbs/api/04_export.ipynb 10
+# %% ../nbs/api/04_export.ipynb
 # includes the newline, because calling .strip() would affect all cells.
 _magics_pattern = re.compile(r'^\s*(%%|%).*\n?', re.MULTILINE)
 
@@ -52,27 +59,35 @@ def scrub_magics(cell): # Cell to format
     try: cell.source = _magics_pattern.sub('', cell.source)
     except: pass
 
-# %% ../nbs/api/04_export.ipynb 13
+# %% ../nbs/api/04_export.ipynb
 import nbdev.export
 def optional_procs():
     "An explicit list of processors that could be used by `nb_export`"
     return L([p for p in nbdev.export.__all__
-              if p not in ["nb_export", "ExportModuleProc", "optional_procs"]])
+              if p not in ["nb_export", "nb_export_cli", "ExportModuleProc", "optional_procs"]])
 
-# %% ../nbs/api/04_export.ipynb 16
-def nb_export(nbname, lib_path=None, procs=None, debug=False, mod_maker=ModuleMaker, name=None):
+# %% ../nbs/api/04_export.ipynb
+def nb_export(nbname:str,        # Filename of notebook 
+              lib_path:str=None, # Path to destination library.  If not in a nbdev project, defaults to current directory.
+              procs=None,        # Processors to use
+              name:str=None,     # Name of python script {name}.py to create.
+              mod_maker=ModuleMaker,
+              debug:bool=False,  # Debug mode
+              solo_nb:bool=False # Export single notebook outside of an nbdev project.
+             ):
     "Create module(s) from notebook"
-    if lib_path is None: lib_path = get_config().lib_path
+    if lib_path is None: lib_path = get_config().lib_path if is_nbdev() else '.'
     exp = ExportModuleProc()
     nb = NBProcessor(nbname, [exp]+L(procs), debug=debug)
     nb.process()
     for mod,cells in exp.modules.items():
-        all_cells = exp.in_all[mod]
-        nm = ifnone(name, getattr(exp, 'default_exp', None) if mod=='#' else mod)
-        if not nm:
-            warn(f"Notebook '{nbname}' uses `#|export` without `#|default_exp` cell.\n"
-                 "Note nbdev2 no longer supports nbdev1 syntax. Run `nbdev_migrate` to upgrade.\n"
-                 "See https://nbdev.fast.ai/getting_started.html for more information.")
-            return
-        mm = mod_maker(dest=lib_path, name=nm, nb_path=nbname, is_new=bool(name) or mod=='#')
-        mm.make(cells, all_cells, lib_path=lib_path)
+        if first(1 for o in cells if o.cell_type=='code'):
+            all_cells = exp.in_all[mod]
+            nm = ifnone(name, getattr(exp, 'default_exp', None) if mod=='#' else mod)
+            if not nm:
+                warn(f"Notebook '{nbname}' uses `#| export` without `#| default_exp` cell.\n"
+                     "Note nbdev2 no longer supports nbdev1 syntax. Run `nbdev_migrate` to upgrade.\n"
+                     "See https://nbdev.fast.ai/getting_started.html for more information.")
+                return
+            mm = mod_maker(dest=lib_path, name=nm, nb_path=nbname, is_new=bool(name) or mod=='#', solo_nb=solo_nb)
+            mm.make(cells, all_cells, lib_path=lib_path)

nbdev/frontmatter.py

@@ -1,9 +1,11 @@
+"""A YAML and formatted-markdown frontmatter processor"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/09_frontmatter.ipynb.
 
 # %% auto 0
 __all__ = ['FrontmatterProc']
 
-# %% ../nbs/api/09_frontmatter.ipynb 2
+# %% ../nbs/api/09_frontmatter.ipynb
 from .imports import *
 from .process import *
 from .doclinks import _nbpath2html
@@ -12,7 +14,7 @@ from execnb.nbio import *
 from fastcore.imports import *
 import yaml
 
-# %% ../nbs/api/09_frontmatter.ipynb 5
+# %% ../nbs/api/09_frontmatter.ipynb
 _RE_FM_BASE=r'''^---\s*
 (.*?\S+.*?)
 ---\s*'''
@@ -40,7 +42,7 @@ def _md2dict(s:str):
         except Exception as e: warn(f'Failed to create YAML dict for:\n{r}\n\n{e}\n')
     return res
 
-# %% ../nbs/api/09_frontmatter.ipynb 6
+# %% ../nbs/api/09_frontmatter.ipynb
 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/maker.py

@@ -1,3 +1,5 @@
+"""Create one or more modules from selected notebook cells"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/02_maker.ipynb.
 
 # %% ../nbs/api/02_maker.ipynb 1
@@ -6,7 +8,7 @@ from __future__ import annotations
 # %% auto 0
 __all__ = ['find_var', 'read_var', 'update_var', 'ModuleMaker', 'decor_id', 'make_code_cells', 'relative_import', 'update_import']
 
-# %% ../nbs/api/02_maker.ipynb 3
+# %% ../nbs/api/02_maker.ipynb
 from .config import *
 from .imports import *
 
@@ -21,7 +23,7 @@ from collections import defaultdict
 from pprint import pformat
 from textwrap import TextWrapper
 
-# %% ../nbs/api/02_maker.ipynb 8
+# %% ../nbs/api/02_maker.ipynb
 def find_var(lines, varname):
     "Find the line numbers where `varname` is defined in `lines`"
     start = first(i for i,o in enumerate(lines) if o.startswith(varname))
@@ -31,7 +33,7 @@ def find_var(lines, varname):
     end = first(i for i,o in enumerate(lines[start+1:]) if o[:1] not in empty)
     return start,len(lines) if end is None else (end+start+1)
 
-# %% ../nbs/api/02_maker.ipynb 10
+# %% ../nbs/api/02_maker.ipynb
 def read_var(code, varname):
     "Eval and return the value of `varname` defined in `code`"
     lines = code.splitlines()
@@ -42,7 +44,7 @@ def read_var(code, varname):
     try: return eval('\n'.join(res))
     except SyntaxError: raise Exception('\n'.join(res)) from None
 
-# %% ../nbs/api/02_maker.ipynb 12
+# %% ../nbs/api/02_maker.ipynb
 def update_var(varname, func, fn=None, code=None):
     "Update the definition of `varname` in file `fn`, by calling `func` with the current definition"
     if fn:
@@ -58,10 +60,10 @@ def update_var(varname, func, fn=None, code=None):
     if fn: fn.write_text(code)
     else: return code
 
-# %% ../nbs/api/02_maker.ipynb 15
+# %% ../nbs/api/02_maker.ipynb
 class ModuleMaker:
     "Helper class to create exported library from notebook source cells"
-    def __init__(self, dest, name, nb_path, is_new=True, parse=True):
+    def __init__(self, dest, name, nb_path, is_new=True, parse=True, solo_nb=False):
         dest,nb_path = Path(dest),Path(nb_path)
         store_attr()
         self.fname = dest/(name.replace('.','/') + ".py")
@@ -70,12 +72,12 @@ class ModuleMaker:
         self.dest2nb = nb_path.relpath(self.fname.parent).as_posix()
         self.hdr = f"# %% {self.dest2nb}"
 
-# %% ../nbs/api/02_maker.ipynb 18
+# %% ../nbs/api/02_maker.ipynb
 def decor_id(d):
     "`id` attr of decorator, regardless of whether called as function or bare"
     return d.id if hasattr(d, 'id') else nested_attr(d, 'func.id', '')
 
-# %% ../nbs/api/02_maker.ipynb 19
+# %% ../nbs/api/02_maker.ipynb
 _def_types = ast.FunctionDef,ast.AsyncFunctionDef,ast.ClassDef
 _assign_types = ast.AnnAssign, ast.Assign, ast.AugAssign
 
@@ -86,7 +88,7 @@ def _all_targets(a): return L(getattr(a,'elts',a))
 def _filt_dec(x): return decor_id(x).startswith('patch')
 def _wants(o): return isinstance(o,_def_types) and not any(L(o.decorator_list).filter(_filt_dec))
 
-# %% ../nbs/api/02_maker.ipynb 20
+# %% ../nbs/api/02_maker.ipynb
 def _targets(o): return [o.target] if isinstance(o, (ast.AugAssign,ast.AnnAssign)) else o.targets
 
 @patch
@@ -105,10 +107,10 @@ def make_all(self:ModuleMaker, cells):
     exports = (assign_targs.attrgot('id')+syms).filter(lambda o: o and o[0]!='_')
     return (exports+all_vals).unique()
 
-# %% ../nbs/api/02_maker.ipynb 21
+# %% ../nbs/api/02_maker.ipynb
 def make_code_cells(*ss): return dict2nb({'cells':L(ss).map(mk_cell)}).cells
 
-# %% ../nbs/api/02_maker.ipynb 24
+# %% ../nbs/api/02_maker.ipynb
 def relative_import(name, fname, level=0):
     "Convert a module `name` to a name relative to `fname`"
     assert not level
@@ -120,7 +122,7 @@ def relative_import(name, fname, level=0):
     if not all(o=='.' for o in res): res='.'+res
     return res.replace(os.path.sep, ".")
 
-# %% ../nbs/api/02_maker.ipynb 26
+# %% ../nbs/api/02_maker.ipynb
 # Based on https://github.com/thonny/thonny/blob/master/thonny/ast_utils.py
 def _mark_text_ranges(
     source: str|bytes, # Source code to add ranges to
@@ -138,7 +140,7 @@ def _mark_text_ranges(
             child.end_lineno, child.end_col_offset = child.lineno, child.col_offset+2
     return root.body
 
-# %% ../nbs/api/02_maker.ipynb 27
+# %% ../nbs/api/02_maker.ipynb
 def update_import(source, tree, libname, f=relative_import):
     if not tree: return
     if sys.version_info < (3,8): tree = _mark_text_ranges(source)
@@ -158,7 +160,7 @@ def import2relative(cell:NbCell, libname):
     src = update_import(cell.source, cell.parsed_(), libname)
     if src: cell.set_source(src)
 
-# %% ../nbs/api/02_maker.ipynb 29
+# %% ../nbs/api/02_maker.ipynb
 @patch
 def _last_future(self:ModuleMaker, cells):
     "Returns the location of a `__future__` in `cells`"
@@ -167,23 +169,23 @@ def _last_future(self:ModuleMaker, cells):
          isinstance(t,ast.ImportFrom) and t.module=='__future__' for t in tree))+1
     except ValueError: return 0
 
-# %% ../nbs/api/02_maker.ipynb 30
-def _import2relative(cells, lib_name=None):
-    "Converts `cells` to use `import2relative` based on `lib_name`"
-    if lib_name is None: lib_name = get_config().lib_name
-    for cell in cells: cell.import2relative(lib_name)
+# %% ../nbs/api/02_maker.ipynb
+def _import2relative(cells, lib_path=None):
+    "Converts `cells` to use `import2relative` based on `lib_path`"
+    if lib_path is None: lib_path = get_config().lib_path
+    for cell in cells: cell.import2relative(lib_path)
 
-# %% ../nbs/api/02_maker.ipynb 31
+# %% ../nbs/api/02_maker.ipynb
 def _retr_mdoc(cells):
-    "Search for `_doc_` variable, used to create module docstring"
-    trees = L(cells).map(NbCell.parsed_).concat()
-    for o in trees:
-        if isinstance(o, _assign_types) and getattr(_targets(o)[0],'id',None)=='_doc_':
-            v = try_attrs(o.value, 'value', 's') # py37 uses `ast.Str.s`
-            return f'"""{v}"""\n\n' 
-    return ""
-
-# %% ../nbs/api/02_maker.ipynb 33
+    "Search for md meta quote line, used to create module docstring"
+    md1 = first(o for o in cells if o.cell_type=='markdown' and o.source.startswith('# '))
+    if not md1: return ''
+    summ = first(o for o in md1.source.splitlines() if o.startswith('> '))
+    if not summ: return ''
+    summ = summ.lstrip('> ').strip()
+    return f'"""{summ}"""\n\n' if summ else ''
+
+# %% ../nbs/api/02_maker.ipynb
 @patch
 def make(self:ModuleMaker, cells, all_cells=None, lib_path=None):
     "Write module containing `cells` with `__all__` generated from `all_cells`"
@@ -206,11 +208,11 @@ def make(self:ModuleMaker, cells, all_cells=None, lib_path=None):
         f.write(_retr_mdoc(cells))
         f.write(f"# AUTOGENERATED! DO NOT EDIT! File to edit: {self.dest2nb}.")
         if last_future > 0: write_cells(cells[:last_future], self.hdr, f)
-        if self.parse: f.write(f"\n\n# %% auto 0\n__all__ = {all_str}")
-        write_cells(cells[last_future:], self.hdr, f)
+        if self.parse and not self.solo_nb: f.write(f"\n\n# %% auto 0\n__all__ = {all_str}")
+        write_cells(cells[last_future:], self.hdr, f, cell_number=get_config().cell_number, solo_nb=self.solo_nb)
         f.write('\n')
 
-# %% ../nbs/api/02_maker.ipynb 38
+# %% ../nbs/api/02_maker.ipynb
 @patch
 def _update_all(self:ModuleMaker, all_cells, alls):
     return pformat(alls + self.make_all(all_cells), width=160)
@@ -222,7 +224,7 @@ def _make_exists(self:ModuleMaker, cells, all_cells=None):
         update_var('__all__', partial(self._update_all, all_cells), fn=self.fname)
     with self.fname.open('a', encoding="utf-8") as f: write_cells(cells, self.hdr, f)
 
-# %% ../nbs/api/02_maker.ipynb 44
+# %% ../nbs/api/02_maker.ipynb
 def _basic_export_nb2(fname, name, dest=None):
     "A basic exporter to bootstrap nbdev using `ModuleMaker`"
     if dest is None: dest = get_config().lib_path

nbdev/merge.py

@@ -1,9 +1,11 @@
+"""Fix merge conflicts in jupyter notebooks"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/07_merge.ipynb.
 
 # %% auto 0
 __all__ = ['conf_re', 'unpatch', 'nbdev_fix', 'nbdev_merge']
 
-# %% ../nbs/api/07_merge.ipynb 2
+# %% ../nbs/api/07_merge.ipynb
 from .imports import *
 from .config import *
 from .export import *
@@ -16,7 +18,7 @@ from fastcore import shutil
 import subprocess
 from difflib import SequenceMatcher
 
-# %% ../nbs/api/07_merge.ipynb 16
+# %% ../nbs/api/07_merge.ipynb
 _BEG,_MID,_END = '<'*7,'='*7,'>'*7
 conf_re = re.compile(rf'^{_BEG}\s+(\S+)\n(.*?)^{_MID}\n(.*?)^{_END}\s+([\S ]+)\n', re.MULTILINE|re.DOTALL)
 
@@ -26,7 +28,7 @@ def _unpatch_f(before, cb1, cb2, c, r):
     r.append(c)
     return cb2
 
-# %% ../nbs/api/07_merge.ipynb 17
+# %% ../nbs/api/07_merge.ipynb
 def unpatch(s:str):
     "Takes a string with conflict markers and returns the two original files, and their branch names"
     *main,last = conf_re.split(s)
@@ -36,7 +38,7 @@ def unpatch(s:str):
         c2b = _unpatch_f(before, c2b, c2_branch, c2, r2)
     return ''.join(r1+[last]), ''.join(r2+[last]), c1b, c2b
 
-# %% ../nbs/api/07_merge.ipynb 22
+# %% ../nbs/api/07_merge.ipynb
 def _make_md(code): return [dict(source=f'`{code}`', cell_type="markdown", metadata={})]
 def _make_conflict(a,b, branch1, branch2):
     return _make_md(f'{_BEG} {branch1}') + a+_make_md(_MID)+b + _make_md(f'{_END} {branch2}')
@@ -53,7 +55,7 @@ def _merge_cells(a, b, brancha, branchb, theirs):
         prev_sa,prev_sb = sa+sz,sb+sz
     return res,conflict
 
-# %% ../nbs/api/07_merge.ipynb 23
+# %% ../nbs/api/07_merge.ipynb
 @call_parse
 def nbdev_fix(nbname:str, # Notebook filename to fix
                outname:str=None, # Filename of output notebook (defaults to `nbname`)
@@ -75,12 +77,12 @@ def nbdev_fix(nbname:str, # Notebook filename to fix
         else: print("Successfully merged conflicts!")
     return conflict
 
-# %% ../nbs/api/07_merge.ipynb 27
+# %% ../nbs/api/07_merge.ipynb
 def _git_branch_merge():
     try: return only(v for k,v in os.environ.items() if k.startswith('GITHEAD'))
     except ValueError: return
 
-# %% ../nbs/api/07_merge.ipynb 28
+# %% ../nbs/api/07_merge.ipynb
 def _git_rebase_head():
     for d in ('apply','merge'):
         d = Path(f'.git/rebase-{d}')
@@ -89,14 +91,14 @@ def _git_rebase_head():
             msg = run(f'git show-branch --no-name {cmt}')
             return f'{cmt[:7]} ({msg})'
 
-# %% ../nbs/api/07_merge.ipynb 29
+# %% ../nbs/api/07_merge.ipynb
 def _git_merge_file(base, ours, theirs):
     "`git merge-file` with expected labels depending on if a `merge` or `rebase` is in-progress"
     l_theirs = _git_rebase_head() or _git_branch_merge() or 'THEIRS'
     cmd = f"git merge-file -L HEAD -L BASE -L '{l_theirs}' {ours} {base} {theirs}"
     return subprocess.run(cmd, shell=True, capture_output=True, text=True)
 
-# %% ../nbs/api/07_merge.ipynb 30
+# %% ../nbs/api/07_merge.ipynb
 @call_parse
 def nbdev_merge(base:str, ours:str, theirs:str, path:str):
     "Git merge driver for notebooks"

nbdev/migrate.py

@@ -1,9 +1,11 @@
+"""Utilities for migrating to nbdev"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/16_migrate.ipynb.
 
 # %% auto 0
 __all__ = ['MigrateProc', 'fp_md_fm', 'migrate_nb', 'migrate_md', 'nbdev_migrate']
 
-# %% ../nbs/api/16_migrate.ipynb 2
+# %% ../nbs/api/16_migrate.ipynb
 from .process import *
 from .frontmatter import *
 from .frontmatter import _fm2dict, _re_fm_md, _dict2fm, _insertfm
@@ -14,20 +16,20 @@ from .showdoc import show_doc
 from fastcore.all import *
 import shutil
 
-# %% ../nbs/api/16_migrate.ipynb 5
+# %% ../nbs/api/16_migrate.ipynb
 def _cat_slug(fmdict):
     "Get the partial slug from the category front matter."
     slug = '/'.join(fmdict.get('categories', ''))
     return '/' + slug if slug else '' 
 
-# %% ../nbs/api/16_migrate.ipynb 7
+# %% ../nbs/api/16_migrate.ipynb
 def _file_slug(fname): 
     "Get the partial slug from the filename."
     p = Path(fname)
     dt = '/'+p.name[:10].replace('-', '/')+'/'
     return dt + p.stem[11:]    
 
-# %% ../nbs/api/16_migrate.ipynb 9
+# %% ../nbs/api/16_migrate.ipynb
 def _replace_fm(d:dict, # dictionary you wish to conditionally change
                 k:str,  # key to check 
                 val:str,# value to check if d[k] == v
@@ -45,14 +47,14 @@ def _fp_fm(d):
     d = _replace_fm(d, 'hide', 'true', {'draft': 'true'})
     return d
 
-# %% ../nbs/api/16_migrate.ipynb 10
+# %% ../nbs/api/16_migrate.ipynb
 def _fp_image(d):
     "Correct path of fastpages images to reference the local directory."
     prefix = 'images/copied_from_nb/'
     if d.get('image', '').startswith(prefix): d['image'] = d['image'].replace(prefix, '')
     return d
 
-# %% ../nbs/api/16_migrate.ipynb 11
+# %% ../nbs/api/16_migrate.ipynb
 def _rm_quote(s): 
     title = re.search('''"(.*?)"''', s)
     return title.group(1) if title else s
@@ -79,7 +81,7 @@ def _fp_convert(fm:dict, path:Path):
     if fm.get('comments'): fm.pop('comments') #true by itself is not a valid value for comments https://quarto.org/docs/output-formats/html-basics.html#commenting, and the default is true
     return fm
 
-# %% ../nbs/api/16_migrate.ipynb 14
+# %% ../nbs/api/16_migrate.ipynb
 class MigrateProc(Processor):
     "Migrate fastpages front matter in notebooks to a raw cell."
     def begin(self): 
@@ -87,7 +89,7 @@ class MigrateProc(Processor):
         if getattr(first(self.nb.cells), 'cell_type', None) == 'raw': del self.nb.cells[0]
         _insertfm(self.nb, self.nb.frontmatter_)
 
-# %% ../nbs/api/16_migrate.ipynb 21
+# %% ../nbs/api/16_migrate.ipynb
 def fp_md_fm(path):
     "Make fastpages front matter in markdown files quarto compliant."
     p = Path(path)
@@ -98,25 +100,25 @@ def fp_md_fm(path):
         return _re_fm_md.sub(_dict2fm(fm), md)
     else: return md 
 
-# %% ../nbs/api/16_migrate.ipynb 30
+# %% ../nbs/api/16_migrate.ipynb
 _alias = merge({k:'code-fold: true' for k in ['collapse', 'collapse_input', 'collapse_hide']}, 
                {'collapse_show':'code-fold: show', 'hide_input': 'echo: false', 'hide': 'include: false', 'hide_output': 'output: false'})
 def _subv1(s): return _alias.get(s, s)
 
-# %% ../nbs/api/16_migrate.ipynb 31
+# %% ../nbs/api/16_migrate.ipynb
 def _re_v1():
     d = ['default_exp', 'export', 'exports', 'exporti', 'hide', 'hide_input', 'collapse_show', 'collapse',
          'collapse_hide', 'collapse_input', 'hide_output',  'default_cls_lvl']
     d += L(get_config().tst_flags).filter()
     d += [s.replace('_', '-') for s in d] # allow for hyphenated version of old directives
     _tmp = '|'.join(list(set(d)))
-    return re.compile(f"^[ \f\v\t]*?(#)\s*({_tmp})(?!\S)", re.MULTILINE)
+    return re.compile(fr"^[ \f\v\t]*?(#)\s*({_tmp})(?!\S)", re.MULTILINE)
 
 def _repl_directives(code_str): 
     def _fmt(x): return f"#| {_subv1(x[2].replace('-', '_').strip())}"
     return _re_v1().sub(_fmt, code_str)
 
-# %% ../nbs/api/16_migrate.ipynb 33
+# %% ../nbs/api/16_migrate.ipynb
 def _repl_v1dir(cell):
     "Replace nbdev v1 with v2 directives."
     if cell.get('source') and cell.get('cell_type') == 'code':
@@ -126,21 +128,21 @@ def _repl_v1dir(cell):
         if not ss: pass
         else: cell['source'] = '\n'.join([_repl_directives(c) for c in ss[:first_code]] + ss[first_code:])
 
-# %% ../nbs/api/16_migrate.ipynb 38
+# %% ../nbs/api/16_migrate.ipynb
 _re_callout = re.compile(r'^>\s(Warning|Note|Important|Tip):(.*)', flags=re.MULTILINE)
 def _co(x): return ":::{.callout-"+x[1].lower()+"}\n\n" + f"{x[2].strip()}\n\n" + ":::"
 def _convert_callout(s): 
     "Convert nbdev v1 to v2 callouts."
     return _re_callout.sub(_co, s)
 
-# %% ../nbs/api/16_migrate.ipynb 45
+# %% ../nbs/api/16_migrate.ipynb
 _re_video = re.compile(r'^>\syoutube:(.*)', flags=re.MULTILINE)
 def _v(x): return "{{< " + f"video {x[1].strip()}" + " >}}"
 def _convert_video(s):
     "Replace nbdev v1 with v2 video embeds."
     return _re_video.sub(_v, s)
 
-# %% ../nbs/api/16_migrate.ipynb 49
+# %% ../nbs/api/16_migrate.ipynb
 _shortcuts = compose(_convert_video, _convert_callout)
 
 def _repl_v1shortcuts(cell):
@@ -148,7 +150,7 @@ def _repl_v1shortcuts(cell):
     if cell.get('source') and cell.get('cell_type') == 'markdown':
         cell['source'] = _shortcuts(cell['source'])
 
-# %% ../nbs/api/16_migrate.ipynb 50
+# %% ../nbs/api/16_migrate.ipynb
 def migrate_nb(path, overwrite=True):
     "Migrate Notebooks from nbdev v1 and fastpages."
     nbp = NBProcessor(path, procs=[FrontmatterProc, MigrateProc, _repl_v1shortcuts, _repl_v1dir], rm_directives=False)
@@ -156,14 +158,14 @@ def migrate_nb(path, overwrite=True):
     if overwrite: write_nb(nbp.nb, path)
     return nbp.nb
 
-# %% ../nbs/api/16_migrate.ipynb 51
+# %% ../nbs/api/16_migrate.ipynb
 def migrate_md(path, overwrite=True):
     "Migrate Markdown Files from fastpages."
     txt = fp_md_fm(path)
     if overwrite: path.write_text(txt)
     return txt
 
-# %% ../nbs/api/16_migrate.ipynb 52
+# %% ../nbs/api/16_migrate.ipynb
 @call_parse
 def nbdev_migrate(
     path:str=None, # A path or glob containing notebooks and markdown files to migrate

nbdev/process.py

@@ -1,9 +1,11 @@
+"""A notebook processor"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/03_process.ipynb.
 
 # %% auto 0
 __all__ = ['langs', 'nb_lang', 'first_code_ln', 'extract_directives', 'opt_set', 'instantiate', 'NBProcessor', 'Processor']
 
-# %% ../nbs/api/03_process.ipynb 2
+# %% ../nbs/api/03_process.ipynb
 from .config import *
 from .maker import *
 from .imports import *
@@ -14,7 +16,7 @@ from fastcore.imports import *
 
 from collections import defaultdict
 
-# %% ../nbs/api/03_process.ipynb 6
+# %% ../nbs/api/03_process.ipynb
 # from https://github.com/quarto-dev/quarto-cli/blob/main/src/resources/jupyter/notebook.py
 langs = defaultdict(
     lambda: '#',  r = "#", python = "#", julia = "#", scala = "//", matlab = "%", csharp = "//", fsharp = "//",
@@ -23,30 +25,30 @@ langs = defaultdict(
     java = "//", groovy = "//", sed = "#", perl = "#", ruby = "#", tikz = "%", javascript = "//", js = "//", d3 = "//", node = "//",
     sass = "//", coffee = "#", go = "//", asy = "//", haskell = "--", dot = "//", apl = "⍝")
 
-# %% ../nbs/api/03_process.ipynb 7
+# %% ../nbs/api/03_process.ipynb
 def nb_lang(nb): return nested_attr(nb, 'metadata.kernelspec.language', 'python')
 
-# %% ../nbs/api/03_process.ipynb 9
+# %% ../nbs/api/03_process.ipynb
 def _dir_pre(lang=None): return fr"\s*{langs[lang]}\s*\|"
 def _quarto_re(lang=None): return re.compile(_dir_pre(lang) + r'\s*[\w|-]+\s*:')
 
-# %% ../nbs/api/03_process.ipynb 11
+# %% ../nbs/api/03_process.ipynb
 def _directive(s, lang='python'):
     s = re.sub('^'+_dir_pre(lang), f"{langs[lang]}|", s)
-    if s.strip().endswith(':'): s = s.replace(':', '') # You can append colon at the end to be Quarto compliant.  Ex: #|hide:
+    if s.strip().endswith(':'): s = s.replace(':', '') # You can append colon at the end to be Quarto compliant.  Ex: #| hide:
     if ':' in s: s = s.replace(':', ': ')
     s = (s.strip()[2:]).strip().split()
     if not s: return None
     direc,*args = s
     return direc,args
 
-# %% ../nbs/api/03_process.ipynb 12
+# %% ../nbs/api/03_process.ipynb
 def _norm_quarto(s, lang='python'):
     "normalize quarto directives so they have a space after the colon"
     m = _quarto_re(lang).match(s)
     return m.group(0) + ' ' + _quarto_re(lang).sub('', s).lstrip() if m else s
 
-# %% ../nbs/api/03_process.ipynb 14
+# %% ../nbs/api/03_process.ipynb
 _cell_mgc = re.compile(r"^\s*%%\w+")
 
 def first_code_ln(code_list, re_pattern=None, lang='python'):
@@ -54,14 +56,14 @@ def first_code_ln(code_list, re_pattern=None, lang='python'):
     if re_pattern is None: re_pattern = _dir_pre(lang)
     return first(i for i,o in enumerate(code_list) if o.strip() != '' and not re.match(re_pattern, o) and not _cell_mgc.match(o))
 
-# %% ../nbs/api/03_process.ipynb 17
+# %% ../nbs/api/03_process.ipynb
 def _partition_cell(cell, lang):
     if not cell.source: return [],[]
     lines = cell.source.splitlines(True)
     first_code = first_code_ln(lines, lang=lang)
     return lines[:first_code],lines[first_code:]
 
-# %% ../nbs/api/03_process.ipynb 18
+# %% ../nbs/api/03_process.ipynb
 def extract_directives(cell, remove=True, lang='python'):
     "Take leading comment directives from lines of code in `ss`, remove `#|`, and split"
     dirs,code = _partition_cell(cell, lang)
@@ -71,22 +73,22 @@ def extract_directives(cell, remove=True, lang='python'):
         cell['source'] = ''.join([_norm_quarto(o, lang) for o in dirs if _quarto_re(lang).match(o) or _cell_mgc.match(o)] + code)
     return dict(L(_directive(s, lang) for s in dirs).filter())
 
-# %% ../nbs/api/03_process.ipynb 21
+# %% ../nbs/api/03_process.ipynb
 def opt_set(var, newval):
     "newval if newval else var"
     return newval if newval else var
 
-# %% ../nbs/api/03_process.ipynb 22
+# %% ../nbs/api/03_process.ipynb
 def instantiate(x, **kwargs):
     "Instantiate `x` if it's a type"
     return x(**kwargs) if isinstance(x,type) else x
 
 def _mk_procs(procs, nb): return L(procs).map(instantiate, nb=nb)
 
-# %% ../nbs/api/03_process.ipynb 23
+# %% ../nbs/api/03_process.ipynb
 def _is_direc(f): return getattr(f, '__name__', '-')[-1]=='_'
 
-# %% ../nbs/api/03_process.ipynb 24
+# %% ../nbs/api/03_process.ipynb
 class NBProcessor:
     "Process cells and nbdev comments in a notebook"
     def __init__(self, path=None, procs=None, nb=None, debug=False, rm_directives=True, process=False):
@@ -126,7 +128,7 @@ class NBProcessor:
         "Process all cells with all processors"
         for proc in self.procs: self._proc(proc)
 
-# %% ../nbs/api/03_process.ipynb 34
+# %% ../nbs/api/03_process.ipynb
 class Processor:
     "Base class for processors"
     def __init__(self, nb): self.nb = nb