aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--nb/clean.py11
-rw-r--r--nbs/clean.ipynb24
2 files changed, 29 insertions, 6 deletions
diff --git a/nb/clean.py b/nb/clean.py
index b733591..27a54c1 100644
--- a/nb/clean.py
+++ b/nb/clean.py
@@ -4,16 +4,23 @@
import nbformat
from nbformat import NotebookNode
+from nb.export import read_nb, PathOrFileLike
+
# cell: 4c127179
-def _clean_cell(cell:dict):
+def _clean_cell(cell:NotebookNode):
if 'execution_count' in cell: cell['execution_count'] = None
if cell['source'].strip() == '': cell['source'] = []
return cell
+# cell: 944a371b
+_allowed_nb_metadata_keys = {"kernelspec", "jupytext", "widgets"}
+
# cell: 00c3e419
-def clean_nb(nb:NotebookNode):
+def clean_nb(nb:PathOrFileLike|NotebookNode)->NotebookNode:
"Clean noisy metadata in the notebook."
+ if not isinstance(nb, NotebookNode): nb = read_nb(nb)
for c in nb['cells']: _clean_cell(c)
nb['metadata'] = {k:v for k,v in nb['metadata'].items() if k in _allowed_nb_metadata_keys}
if nb['metadata'].get('kernelspec', {}).get('name'):
nb['metadata']['kernelspec']['display_name'] = nb["metadata"]["kernelspec"]["name"]
+ return nb
diff --git a/nbs/clean.ipynb b/nbs/clean.ipynb
index a93eb83..681a5ce 100644
--- a/nbs/clean.ipynb
+++ b/nbs/clean.ipynb
@@ -3,6 +3,17 @@
{
"cell_type": "code",
"execution_count": null,
+ "id": "eae7a190",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "%load_ext autoreload\n",
+ "%autoreload 2"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
"id": "ce317915",
"metadata": {},
"outputs": [],
@@ -19,7 +30,9 @@
"source": [
"#| export\n",
"import nbformat\n",
- "from nbformat import NotebookNode"
+ "from nbformat import NotebookNode\n",
+ "\n",
+ "from nb.export import read_nb, PathOrFileLike"
]
},
{
@@ -50,7 +63,7 @@
"outputs": [],
"source": [
"#| export\n",
- "def _clean_cell(cell:dict):\n",
+ "def _clean_cell(cell:NotebookNode):\n",
" if 'execution_count' in cell: cell['execution_count'] = None\n",
" if cell['source'].strip() == '': cell['source'] = []\n",
" return cell"
@@ -85,6 +98,7 @@
"metadata": {},
"outputs": [],
"source": [
+ "#| export\n",
"_allowed_nb_metadata_keys = {\"kernelspec\", \"jupytext\", \"widgets\"}"
]
},
@@ -96,12 +110,14 @@
"outputs": [],
"source": [
"#| export\n",
- "def clean_nb(nb:NotebookNode):\n",
+ "def clean_nb(nb:PathOrFileLike|NotebookNode)->NotebookNode:\n",
" \"Clean noisy metadata in the notebook.\"\n",
+ " if not isinstance(nb, NotebookNode): nb = read_nb(nb)\n",
" for c in nb['cells']: _clean_cell(c)\n",
" nb['metadata'] = {k:v for k,v in nb['metadata'].items() if k in _allowed_nb_metadata_keys}\n",
" if nb['metadata'].get('kernelspec', {}).get('name'):\n",
- " nb['metadata']['kernelspec']['display_name'] = nb[\"metadata\"][\"kernelspec\"][\"name\"]"
+ " nb['metadata']['kernelspec']['display_name'] = nb[\"metadata\"][\"kernelspec\"][\"name\"]\n",
+ " return nb"
]
},
{