Revert "Remove widget state"

Author: hamelsmu

TODO.md

@@ -3,5 +3,7 @@
 - `show_doc` changes:
   - support `#default_cls_lvl`
   - pick header level for functions/methods
+- implement stuff from nbdev export2html, e.g.(?):
+  - `remove_widget_state`
 - fastcore conversion scripts + instuctions
 

nbprocess/_modidx.py

@@ -144,7 +144,6 @@
                                       'nbprocess.processors.is_frontmatter': 'https://nbprocess.fast.ai/processors#is_frontmatter',
                                       'nbprocess.processors.lang_identify': 'https://nbprocess.fast.ai/processors#lang_identify',
                                       'nbprocess.processors.nb_fmdict': 'https://nbprocess.fast.ai/processors#nb_fmdict',
-                                      'nbprocess.processors.remove_widget_state': 'https://nbprocess.fast.ai/processors#remove_widget_state',
                                       'nbprocess.processors.rm_export': 'https://nbprocess.fast.ai/processors#rm_export',
                                       'nbprocess.processors.rm_header_dash': 'https://nbprocess.fast.ai/processors#rm_header_dash',
                                       'nbprocess.processors.strip_ansi': 'https://nbprocess.fast.ai/processors#strip_ansi'},

nbprocess/cli.py

@@ -77,7 +77,7 @@ def _nothing(self): return []
     def base_preprocs(self): return [infer_frontmatter, add_show_docs, insert_warning]
     def base_postprocs(self): return []
     def base_procs(self):
-        return [remove_widget_state, strip_ansi, hide_line, filter_stream_, lang_identify, rm_header_dash, 
+        return [strip_ansi, hide_line, filter_stream_, lang_identify, rm_header_dash,
                 clean_show_doc, exec_show_docs, rm_export, clean_magics, hide_, add_links]
 
     def procs(self):

nbprocess/processors.py

@@ -2,8 +2,8 @@
 
 # %% auto 0
 __all__ = ['DEFAULT_FM_KEYS', 'add_links', 'strip_ansi', 'hide_', 'hide_line', 'filter_stream_', 'clean_magics', 'lang_identify',
-           'rm_header_dash', 'rm_export', 'clean_show_doc', 'remove_widget_state', 'exec_show_docs', 'insert_warning',
-           'add_show_docs', 'is_frontmatter', 'nb_fmdict', 'construct_fm', 'insert_frontmatter', 'infer_frontmatter']
+           'rm_header_dash', 'rm_export', 'clean_show_doc', 'exec_show_docs', 'insert_warning', 'add_show_docs',
+           'is_frontmatter', 'nb_fmdict', 'construct_fm', 'insert_frontmatter', 'infer_frontmatter']
 
 # %% ../nbs/09_processors.ipynb 2
 import ast
@@ -104,13 +104,6 @@ def clean_show_doc(cell):
     cell.source = '#| echo: false\n' + cell.source
 
 # %% ../nbs/09_processors.ipynb 30
-def remove_widget_state(cell):
-    "Remove widgets in the output of `cells`"
-    if cell['cell_type'] == 'code' and 'outputs' in cell:
-        cell['outputs'] = [l for l in cell['outputs']
-                           if not ('data' in l and 'application/vnd.jupyter.widget-view+json' in l.data)]
-
-# %% ../nbs/09_processors.ipynb 32
 _imps = {ast.Import, ast.ImportFrom}
 
 def _show_docs(trees):
@@ -123,7 +116,7 @@ def _do_eval(cell):
     if cell.directives_.keys() & _exp_dirs or filter_ex(trees, risinstance(_imps)): return True
     if _show_docs(trees): return True
 
-# %% ../nbs/09_processors.ipynb 33
+# %% ../nbs/09_processors.ipynb 31
 class exec_show_docs:
     "Execute cells needed for `show_docs` output, including exported cells and imports"
     def __init__(self, nb):
@@ -134,13 +127,13 @@ def __call__(self, cell):
         if _do_eval(cell): self.k.cell(cell)
         if self.k.exc: raise self.k.exc[1] from None
 
-# %% ../nbs/09_processors.ipynb 36
+# %% ../nbs/09_processors.ipynb 34
 def insert_warning(nb):
     "Insert Autogenerated Warning Into Notebook after the first cell."
     content = "<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->"
     nb.cells.insert(1, mk_cell(content, False))
 
-# %% ../nbs/09_processors.ipynb 40
+# %% ../nbs/09_processors.ipynb 38
 _def_types = (ast.FunctionDef,ast.AsyncFunctionDef,ast.ClassDef)
 def _def_names(cell, shown):
     return [showdoc_nm(o) for o in concat(cell.parsed_()) if isinstance(o,_def_types) and o.name not in shown and o.name[0]!='_']
@@ -151,7 +144,7 @@ def _get_nm(tree):
     i = tree.value.args[0]
     return f'{i.value.id}.{i.attr}' if isinstance(i, ast.Attribute) else i.id
 
-# %% ../nbs/09_processors.ipynb 41
+# %% ../nbs/09_processors.ipynb 39
 def add_show_docs(nb):
     "Add show_doc cells after exported cells, unless they are already documented"
     exports = L(cell for cell in nb.cells if cell.source and _re_exps(cell.source))
@@ -162,7 +155,7 @@ def add_show_docs(nb):
             code = f'show_doc({nm})'
             nb.cells.insert(cell.idx_+1, mk_cell(code))
 
-# %% ../nbs/09_processors.ipynb 45
+# %% ../nbs/09_processors.ipynb 43
 _re_title = re.compile(r'^#\s+(.*)[\n\r]+(?:^>\s+(.*))?', flags=re.MULTILINE)
 _re_fm = re.compile(r'^---.*\S+.*---', flags=re.DOTALL)
 _re_defaultexp = re.compile(r'^\s*#\|\s*default_exp\s+(\S+)', flags=re.MULTILINE)
@@ -173,14 +166,14 @@ def _istitle(cell):
     txt = cell.get('source', '')
     return bool(_re_title.search(txt)) if txt else False
 
-# %% ../nbs/09_processors.ipynb 46
+# %% ../nbs/09_processors.ipynb 44
 def _default_exp(nb):
     "get the default_exp from a notebook"
     code_src = nb.cells.filter(lambda x: x.cell_type == 'code').attrgot('source')
     default_exp = first(code_src.filter().map(_re_defaultexp.search).filter())
     return default_exp.group(1) if default_exp else None
 
-# %% ../nbs/09_processors.ipynb 48
+# %% ../nbs/09_processors.ipynb 46
 def nb_fmdict(nb, remove=True): 
     "Infer the front matter from a notebook's markdown formatting"
     md_cells = _celltyp(nb, 'markdown').filter(_istitle)
@@ -196,21 +189,21 @@ def nb_fmdict(nb, remove=True):
         return flags
     else: return {}
 
-# %% ../nbs/09_processors.ipynb 51
+# %% ../nbs/09_processors.ipynb 49
 DEFAULT_FM_KEYS = ['title', 'description', 'author', 'image', 'categories', 'output-file', 'aliases']
 
 def construct_fm(fmdict:dict, keys = DEFAULT_FM_KEYS):
     "construct front matter from a dictionary, but only for `keys`"
     if not fmdict: return None
     return '---\n'+'\n'.join([f"{k}: {fmdict[k]}" for k in keys if k in fmdict])+'\n---'
 
-# %% ../nbs/09_processors.ipynb 53
+# %% ../nbs/09_processors.ipynb 51
 def insert_frontmatter(nb, fm_dict:dict, filter_keys:list=DEFAULT_FM_KEYS):
     "Add frontmatter into notebook based on `filter_keys` that exist in `fmdict`."
     fm = construct_fm(fm_dict, keys=filter_keys)
     if fm: nb.cells.insert(0, NbCell(0, dict(cell_type='raw', metadata={}, source=fm)))
 
-# %% ../nbs/09_processors.ipynb 54
+# %% ../nbs/09_processors.ipynb 52
 def infer_frontmatter(nb):
     "Insert front matter if it doesn't exist automatically from nbdev styled markdown."
     if is_frontmatter(nb): return

nbs/09_processors.ipynb

@@ -86,8 +86,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def _run_procs(procs=None, preprocs=None, postprocs=None, file='../tests/docs_test.ipynb'):\n",
-    "    nbp = NBProcessor(file, procs, preprocs=preprocs, postprocs=postprocs)\n",
+    "def _run_procs(procs=None, preprocs=None, postprocs=None):\n",
+    "    nbp = NBProcessor(_test_file, procs, preprocs=preprocs, postprocs=postprocs)\n",
     "    nbp.process()\n",
     "    return '\\n'.join([str(cell) for cell in nbp.nb.cells])"
    ]
@@ -386,33 +386,6 @@
     "    cell.source = '#| echo: false\\n' + cell.source"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "91b4d0fc-3586-4cd3-86f6-da39c5f88ec4",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "#|export\n",
-    "def remove_widget_state(cell):\n",
-    "    \"Remove widgets in the output of `cells`\"\n",
-    "    if cell['cell_type'] == 'code' and 'outputs' in cell:\n",
-    "        cell['outputs'] = [l for l in cell['outputs']\n",
-    "                           if not ('data' in l and 'application/vnd.jupyter.widget-view+json' in l.data)]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d91bba21-1beb-45bf-80ff-da4ab3f7fdb8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "#|hide\n",
-    "res = _run_procs(remove_widget_state, file='../tests/widget.ipynb')\n",
-    "assert 'application/vnd.jupyter.widget-view+json' not in res"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -703,7 +676,19 @@
    "execution_count": null,
    "id": "edf1ca1d-09a5-4adb-bc28-267a8227bd9b",
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "---\n",
+      "title: a title\n",
+      "description: A description\n",
+      "categories:  [c1, c2]\n",
+      "---\n"
+     ]
+    }
+   ],
    "source": [
     "_testdict = nb_fmdict(read_nb('../tests/docs_test.ipynb'))\n",
     "_res = construct_fm(_testdict)\n",

nbs/10_cli.ipynb

@@ -168,7 +168,7 @@
     "    def base_preprocs(self): return [infer_frontmatter, add_show_docs, insert_warning]\n",
     "    def base_postprocs(self): return []\n",
     "    def base_procs(self):\n",
-    "        return [remove_widget_state, strip_ansi, hide_line, filter_stream_, lang_identify, rm_header_dash, \n",
+    "        return [strip_ansi, hide_line, filter_stream_, lang_identify, rm_header_dash,\n",
     "                clean_show_doc, exec_show_docs, rm_export, clean_magics, hide_, add_links]\n",
     "\n",
     "    def procs(self):\n",