fixes #1588

Author: jph00

nbdev/clean.py

@@ -58,7 +58,7 @@ def _clean_cell_output_id(lines):
     return _skip_or_sub(lines) if isinstance(lines,str) else [_skip_or_sub(o) for o in lines]
 
 # %% ../nbs/api/11_clean.ipynb #b4cde615
-def _clean_cell_output(cell, clean_ids):
+def _clean_cell_output(cell, clean_ids, allowed_out_meta_keys):
     "Remove `cell` output execution count and optionally ids from text reprs"
     outputs = cell.get('outputs', [])
     for o in outputs:
@@ -69,15 +69,15 @@ def _clean_cell_output(cell, clean_ids):
             if k.startswith('text') and clean_ids: data[k] = _clean_cell_output_id(data[k])
             if k.startswith('image') and "svg" not in k: data[k] = data[k].rstrip()
         if 'text' in o and clean_ids: o['text'] = _clean_cell_output_id(o['text'])
-#         o.get('metadata', {}).pop('tags', None)
+        if 'metadata' in o: o['metadata'] = {k:v for k,v in o['metadata'].items() if k in allowed_out_meta_keys}
 
 # %% ../nbs/api/11_clean.ipynb #2ba79c93
-def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids):
+def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids, allowed_out_meta_keys):
     "Clean `cell` by removing superfluous metadata or everything except the input if `clear_all`"
     if 'execution_count' in cell: cell['execution_count'] = None
     if 'outputs' in cell:
         if clear_all: cell['outputs'] = []
-        else:         _clean_cell_output(cell, clean_ids)
+        else:         _clean_cell_output(cell, clean_ids, allowed_out_meta_keys)
     if cell['source'] == ['']: cell['source'] = []
     cell['metadata'] = {} if clear_all else {
         k:v for k,v in cell['metadata'].items() if k in allowed_metadata_keys}
@@ -90,13 +90,16 @@ def clean_nb(
     allowed_metadata_keys:list=None, # Preserve the list of keys in the main notebook metadata
     allowed_cell_metadata_keys:list=None, # Preserve the list of keys in cell level metadata
     clean_ids=True, # Remove ids from plaintext reprs?
+    allowed_out_metadata_keys:list=None, # Preserve the list of keys in output metadata
 ):
     "Clean `nb` from superfluous metadata"
     metadata_keys = {"kernelspec", "jekyll", "jupytext", "doc", "widgets"}
     if allowed_metadata_keys: metadata_keys.update(allowed_metadata_keys)
     cell_metadata_keys = {"hide_input"}
     if allowed_cell_metadata_keys: cell_metadata_keys.update(allowed_cell_metadata_keys)
-    for c in nb['cells']: _clean_cell(c, clear_all, cell_metadata_keys, clean_ids)
+    out_meta_keys = set()
+    if allowed_out_metadata_keys: out_meta_keys.update(allowed_out_metadata_keys)
+    for c in nb['cells']: _clean_cell(c, clear_all, cell_metadata_keys, clean_ids, out_meta_keys)
     if nb.get('metadata', {}).get('kernelspec', {}).get('name', None):
         nb['metadata']['kernelspec']['display_name'] = nb["metadata"]["kernelspec"]["name"]
     nb['metadata'] = {k:v for k,v in nb['metadata'].items() if k in metadata_keys}
@@ -127,7 +130,8 @@ def _nbdev_clean(nb, path=None, clear_all=None):
     clear_all = clear_all or cfg.clear_all
     allowed_metadata_keys = cfg.get("allowed_metadata_keys") or []
     allowed_cell_metadata_keys = cfg.get("allowed_cell_metadata_keys") or []
-    clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids)
+    allowed_out_metadata_keys = cfg.get("allowed_out_metadata_keys") or []
+    clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids, allowed_out_metadata_keys)
     if path: nbdev_trust.__wrapped__(path)
 
 # %% ../nbs/api/11_clean.ipynb #6af3b9d4
@@ -209,7 +213,7 @@ def nbdev_install_hooks():
     os.chmod(fn, os.stat(fn).st_mode | stat.S_IEXEC)
 
     cmd = 'git config --local include.path ../.gitconfig'
-    (repo_path/'.gitconfig').write_text(f'''# Generated by nbdev_install_hooks
+    (repo_path/'.gitconfig').write_text(f'''# Generated by nbdev-install-hooks
 #
 # If you need to disable this instrumentation do:
 #   git config --local --unset include.path

nbs/api/02_maker.ipynb

@@ -240,9 +240,7 @@
       ]
      },
      "execution_count": null,
-     "metadata": {
-      "__type": "PosixPath"
-     },
+     "metadata": {},
      "output_type": "execute_result"
     }
    ],

nbs/api/11_clean.ipynb

@@ -164,7 +164,7 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "def _clean_cell_output(cell, clean_ids):\n",
+    "def _clean_cell_output(cell, clean_ids, allowed_out_meta_keys):\n",
     "    \"Remove `cell` output execution count and optionally ids from text reprs\"\n",
     "    outputs = cell.get('outputs', [])\n",
     "    for o in outputs:\n",
@@ -175,7 +175,7 @@
     "            if k.startswith('text') and clean_ids: data[k] = _clean_cell_output_id(data[k])\n",
     "            if k.startswith('image') and \"svg\" not in k: data[k] = data[k].rstrip()\n",
     "        if 'text' in o and clean_ids: o['text'] = _clean_cell_output_id(o['text'])\n",
-    "#         o.get('metadata', {}).pop('tags', None)"
+    "        if 'metadata' in o: o['metadata'] = {k:v for k,v in o['metadata'].items() if k in allowed_out_meta_keys}"
    ]
   },
   {
@@ -186,12 +186,12 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids):\n",
+    "def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids, allowed_out_meta_keys):\n",
     "    \"Clean `cell` by removing superfluous metadata or everything except the input if `clear_all`\"\n",
     "    if 'execution_count' in cell: cell['execution_count'] = None\n",
     "    if 'outputs' in cell:\n",
     "        if clear_all: cell['outputs'] = []\n",
-    "        else:         _clean_cell_output(cell, clean_ids)\n",
+    "        else:         _clean_cell_output(cell, clean_ids, allowed_out_meta_keys)\n",
     "    if cell['source'] == ['']: cell['source'] = []\n",
     "    cell['metadata'] = {} if clear_all else {\n",
     "        k:v for k,v in cell['metadata'].items() if k in allowed_metadata_keys}\n",
@@ -212,13 +212,16 @@
     "    allowed_metadata_keys:list=None, # Preserve the list of keys in the main notebook metadata\n",
     "    allowed_cell_metadata_keys:list=None, # Preserve the list of keys in cell level metadata\n",
     "    clean_ids=True, # Remove ids from plaintext reprs?\n",
+    "    allowed_out_metadata_keys:list=None, # Preserve the list of keys in output metadata\n",
     "):\n",
     "    \"Clean `nb` from superfluous metadata\"\n",
     "    metadata_keys = {\"kernelspec\", \"jekyll\", \"jupytext\", \"doc\", \"widgets\"}\n",
     "    if allowed_metadata_keys: metadata_keys.update(allowed_metadata_keys)\n",
     "    cell_metadata_keys = {\"hide_input\"}\n",
     "    if allowed_cell_metadata_keys: cell_metadata_keys.update(allowed_cell_metadata_keys)\n",
-    "    for c in nb['cells']: _clean_cell(c, clear_all, cell_metadata_keys, clean_ids)\n",
+    "    out_meta_keys = set()\n",
+    "    if allowed_out_metadata_keys: out_meta_keys.update(allowed_out_metadata_keys)\n",
+    "    for c in nb['cells']: _clean_cell(c, clear_all, cell_metadata_keys, clean_ids, out_meta_keys)\n",
     "    if nb.get('metadata', {}).get('kernelspec', {}).get('name', None):\n",
     "        nb['metadata']['kernelspec']['display_name'] = nb[\"metadata\"][\"kernelspec\"][\"name\"]\n",
     "    nb['metadata'] = {k:v for k,v in nb['metadata'].items() if k in metadata_keys}\n",
@@ -369,17 +372,17 @@
     {
      "data": {
       "text/plain": [
-       "'b3c0571e'"
+       "'88ba1c41'"
       ]
      },
-     "execution_count": null,
+     "execution_count": 77,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
     "test_cell = {'source': 'x=1', 'cell_type': 'code', 'metadata': {}}\n",
-    "_clean_cell(test_cell, False, set(), True)\n",
+    "_clean_cell(test_cell, False, set(), True, set())\n",
     "test_cell['id']"
    ]
   },
@@ -438,7 +441,8 @@
     "    clear_all = clear_all or cfg.clear_all\n",
     "    allowed_metadata_keys = cfg.get(\"allowed_metadata_keys\") or []\n",
     "    allowed_cell_metadata_keys = cfg.get(\"allowed_cell_metadata_keys\") or []\n",
-    "    clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids)\n",
+    "    allowed_out_metadata_keys = cfg.get(\"allowed_out_metadata_keys\") or []\n",
+    "    clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids, allowed_out_metadata_keys)\n",
     "    if path: nbdev_trust.__wrapped__(path)"
    ]
   },
@@ -474,11 +478,12 @@
     "By default (`fname` left to `None`), all the notebooks in `config.nbs_path` are cleaned. You can opt in to fully clean the notebook by removing every bit of metadata and the cell outputs by passing `clear_all=True`.\n",
     "\n",
     "If you want to keep some keys in the main notebook metadata you can set `allowed_metadata_keys` in `[tool.nbdev]` in `pyproject.toml`.\n",
-    "Similarly for cell level metadata use: `allowed_cell_metadata_keys`. For example, to preserve both `k1` and `k2` at both the notebook and cell level add the following to `pyproject.toml`:\n",
+    "Similarly for cell level metadata use `allowed_cell_metadata_keys`, and for output metadata use `allowed_out_metadata_keys`. For example, to preserve both `k1` and `k2` at both the notebook and cell level add the following to `pyproject.toml`:\n",
     "```toml\n",
     "[tool.nbdev]\n",
     "allowed_metadata_keys = [\"k1\", \"k2\"]\n",
     "allowed_cell_metadata_keys = [\"k1\", \"k2\"]\n",
+    "allowed_out_metadata_keys = [\"k1\", \"k2\"]\n",
     "```"
    ]
   },
@@ -620,6 +625,8 @@
     {
      "data": {
       "text/markdown": [
+       "<div class=\"prose\">\n",
+       "\n",
        "```python\n",
        "an_existing_line = True\n",
        "\n",
@@ -629,13 +636,24 @@
        "    clean_jupyter(**kwargs)\n",
        "\n",
        "c.ContentsManager.pre_save_hook = nbdev_clean_jupyter\n",
-       "```"
+       "```\n",
+       "\n",
+       "</div>"
       ],
       "text/plain": [
-       "<IPython.core.display.Markdown object>"
+       "Markdown(```python\n",
+       "an_existing_line = True\n",
+       "\n",
+       "def nbdev_clean_jupyter(**kwargs):\n",
+       "    try: from nbdev.clean import clean_jupyter\n",
+       "    except ModuleNotFoundError: return\n",
+       "    clean_jupyter(**kwargs)\n",
+       "\n",
+       "c.ContentsManager.pre_save_hook = nbdev_clean_jupyter\n",
+       "```)"
       ]
      },
-     "execution_count": null,
+     "execution_count": 89,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -711,7 +729,7 @@
     "    os.chmod(fn, os.stat(fn).st_mode | stat.S_IEXEC)\n",
     "\n",
     "    cmd = 'git config --local include.path ../.gitconfig'\n",
-    "    (repo_path/'.gitconfig').write_text(f'''# Generated by nbdev_install_hooks\n",
+    "    (repo_path/'.gitconfig').write_text(f'''# Generated by nbdev-install-hooks\n",
     "#\n",
     "# If you need to disable this instrumentation do:\n",
     "#   git config --local --unset include.path\n",
@@ -863,7 +881,7 @@
     "    nbs_path = Path('nbs')\n",
     "    nbs_path.mkdir()\n",
     "    Path('pyproject.toml').write_text('[tool.nbdev]\\\\nnbs_path = \"nbs\"')\n",
-    "    _run('nbdev_install_hooks')\n",
+    "    _run('nbdev-install-hooks')\n",
     "    \n",
     "    fn = 'random.ipynb'\n",
     "    p = nbs_path/fn\n",
@@ -917,7 +935,10 @@
    ]
   }
  ],
- "metadata": {},
+ "metadata": {
+  "solveit_dialog_mode": "concise",
+  "solveit_ver": 2
+ },
  "nbformat": 4,
  "nbformat_minor": 5
 }