fixes #25

Author: jph00

execnb/_modidx.py

@@ -48,6 +48,7 @@
                              'execnb.nbio.NbCell.parsed_': 'https://fastai.github.io/execnb/nbio.html#nbcell.parsed_',
                              'execnb.nbio.NbCell.set_source': 'https://fastai.github.io/execnb/nbio.html#nbcell.set_source',
                              'execnb.nbio.dict2nb': 'https://fastai.github.io/execnb/nbio.html#dict2nb',
+                             'execnb.nbio.mk_cell': 'https://fastai.github.io/execnb/nbio.html#mk_cell',
                              'execnb.nbio.nb2dict': 'https://fastai.github.io/execnb/nbio.html#nb2dict',
                              'execnb.nbio.nb2str': 'https://fastai.github.io/execnb/nbio.html#nb2str',
                              'execnb.nbio.new_nb': 'https://fastai.github.io/execnb/nbio.html#new_nb',

execnb/nbio.py

@@ -1,7 +1,7 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/01_nbio.ipynb.
 
 # %% auto 0
-__all__ = ['NbCell', 'dict2nb', 'read_nb', 'nb2dict', 'nb2str', 'write_nb', 'new_nb']
+__all__ = ['NbCell', 'dict2nb', 'read_nb', 'new_nb', 'mk_cell', 'nb2dict', 'nb2str', 'write_nb']
 
 # %% ../nbs/01_nbio.ipynb 2
 from fastcore.imports import *
@@ -34,9 +34,9 @@ def __hash__(self): return hash(self.source) + hash(self.cell_type)
     def __eq__(self,o): return self.source==o.source and self.cell_type==o.cell_type
 
 # %% ../nbs/01_nbio.ipynb 14
-def dict2nb(js):
+def dict2nb(js=None, **kwargs):
     "Convert dict `js` to an `AttrDict`, "
-    nb = dict2obj(js)
+    nb = dict2obj(js or kwargs)
     nb.cells = nb.cells.enumerate().starmap(NbCell)
     return nb
 
@@ -48,25 +48,34 @@ def read_nb(path):
     return res
 
 # %% ../nbs/01_nbio.ipynb 25
+def new_nb(cells=None, meta=None, nbformat=4, nbformat_minor=5):
+    "Returns an empty new notebook"
+    return dict2nb(cells=cells or [],metadata=meta or {},nbformat=nbformat,nbformat_minor=nbformat_minor)
+
+# %% ../nbs/01_nbio.ipynb 27
+def mk_cell(text,  # `source` attr in cell
+            cell_type='code',  # `cell_type` attr in cell
+            **kwargs):  # any other attrs to add to cell
+    "Create an `NbCell` containing `text`"
+    assert cell_type in {'code', 'markdown', 'raw'}
+    if 'metadata' not in kwargs: kwargs['metadata']={}
+    return NbCell(0, dict(cell_type=cell_type, source=text, directives_={}, **kwargs))
+
+# %% ../nbs/01_nbio.ipynb 30
 def nb2dict(d, k=None):
     "Convert parsed notebook to `dict`"
-    if k in ('source',): return d.splitlines(keepends=True)
+    if k=='source': return d.splitlines(keepends=True)
     if isinstance(d, (L,list)): return list(L(d).map(nb2dict))
     if not isinstance(d, dict): return d
     return dict(**{k:nb2dict(v,k) for k,v in d.items() if k[-1] != '_'})
 
-# %% ../nbs/01_nbio.ipynb 28
+# %% ../nbs/01_nbio.ipynb 33
 def nb2str(nb):
     "Convert `nb` to a `str`"
     if isinstance(nb, (AttrDict,L)): nb = nb2dict(nb)
     return dumps(nb, sort_keys=True, indent=1, ensure_ascii=False) + "\n"
 
-# %% ../nbs/01_nbio.ipynb 31
+# %% ../nbs/01_nbio.ipynb 36
 def write_nb(nb, path):
     "Write `nb` to `path`"
     with maybe_open(path, 'w', encoding='utf-8') as f: f.write(nb2str(nb))
-
-# %% ../nbs/01_nbio.ipynb 35
-def new_nb():
-    "Returns an empty new notebook"
-    return dict2nb({'cells':[],'metadata':{},'nbformat':4,'nbformat_minor':5})

nbs/01_nbio.ipynb

@@ -184,9 +184,9 @@
    "outputs": [],
    "source": [
     "#|export\n",
-    "def dict2nb(js):\n",
+    "def dict2nb(js=None, **kwargs):\n",
     "    \"Convert dict `js` to an `AttrDict`, \"\n",
-    "    nb = dict2obj(js)\n",
+    "    nb = dict2obj(js or kwargs)\n",
     "    nb.cells = nb.cells.enumerate().starmap(NbCell)\n",
     "    return nb"
    ]
@@ -250,7 +250,7 @@
     {
      "data": {
       "text/plain": [
-       "([<ast.Expr at 0x107d476a0>], <ast.Add at 0x105235ee0>)"
+       "([<ast.Expr at 0x1067c36a0>], <ast.Add at 0x1039bb2e0>)"
       ]
      },
      "execution_count": null,
@@ -331,6 +331,83 @@
     "minimal.path_"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Creating a notebook"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#|export\n",
+    "def new_nb(cells=None, meta=None, nbformat=4, nbformat_minor=5):\n",
+    "    \"Returns an empty new notebook\"\n",
+    "    return dict2nb(cells=cells or [],metadata=meta or {},nbformat=nbformat,nbformat_minor=nbformat_minor)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Use this function when creating a new notebook. Useful for when you don't want to create a notebook on disk first and then read it."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| export\n",
+    "def mk_cell(text,  # `source` attr in cell\n",
+    "            cell_type='code',  # `cell_type` attr in cell\n",
+    "            **kwargs):  # any other attrs to add to cell\n",
+    "    \"Create an `NbCell` containing `text`\"\n",
+    "    assert cell_type in {'code', 'markdown', 'raw'}\n",
+    "    if 'metadata' not in kwargs: kwargs['metadata']={}\n",
+    "    return NbCell(0, dict(cell_type=cell_type, source=text, directives_={}, **kwargs))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/markdown": [
+       "```json\n",
+       "{ 'cell_type': 'code',\n",
+       "  'directives_': {},\n",
+       "  'execution_count': 0,\n",
+       "  'idx_': 0,\n",
+       "  'metadata': {},\n",
+       "  'source': 'print(1)'}\n",
+       "```"
+      ],
+      "text/plain": [
+       "{'cell_type': 'code',\n",
+       " 'source': 'print(1)',\n",
+       " 'directives_': {},\n",
+       " 'execution_count': 0,\n",
+       " 'metadata': {},\n",
+       " 'idx_': 0}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "mk_cell('print(1)', execution_count=0)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -347,7 +424,7 @@
     "#|export\n",
     "def nb2dict(d, k=None):\n",
     "    \"Convert parsed notebook to `dict`\"\n",
-    "    if k in ('source',): return d.splitlines(keepends=True)\n",
+    "    if k=='source': return d.splitlines(keepends=True)\n",
     "    if isinstance(d, (L,list)): return list(L(d).map(nb2dict))\n",
     "    if not isinstance(d, dict): return d\n",
     "    return dict(**{k:nb2dict(v,k) for k,v in d.items() if k[-1] != '_'})"
@@ -450,26 +527,29 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Creating a notebook"
+    "Here's how to put all the pieces of `execnb.nbio` together:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
-   "source": [
-    "#|export\n",
-    "def new_nb():\n",
-    "    \"Returns an empty new notebook\"\n",
-    "    return dict2nb({'cells':[],'metadata':{},'nbformat':4,'nbformat_minor':5})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "[{'cell_type': 'code', 'metadata': {}, 'source': 'print(1)', 'idx_': 0}]\n"
+     ]
+    }
+   ],
    "source": [
-    "Use this function when creating a new notebook. Useful for when you don't want to create a notebook on disk first and then read it."
+    "nb = new_nb([mk_cell('print(1)')])\n",
+    "path = Path('test.ipynb')\n",
+    "write_nb(nb, path)\n",
+    "nb2 = read_nb(path)\n",
+    "print(nb2.cells)\n",
+    "path.unlink()"
    ]
   },
   {
@@ -486,8 +566,7 @@
    "outputs": [],
    "source": [
     "#|hide\n",
-    "#|eval: false\n",
-    "from nbdev.doclinks import nbdev_export\n",
+    "from nbdev import nbdev_export\n",
     "nbdev_export()"
    ]
   },