Merge pull request #1428 from dienhoa/cell_number

add enable/disable cell number in .py files

Author: jph00

nbdev/config.py

@@ -66,6 +66,7 @@ def _apply_defaults(
     jupyter_hooks:bool_arg=False, # Run Jupyter hooks?
     clean_ids:bool_arg=True, # Remove ids from plaintext reprs?
     clear_all:bool_arg=False, # Remove all cell metadata and cell outputs?
+    cell_number:bool_arg=True, # Add cell number to the exported file
     put_version_in_init:bool_arg=True, # Add the version to the main __init__.py in nbdev_export
 ):
     "Apply default settings where missing in `cfg`."
@@ -251,10 +252,10 @@ def add_init(path=None):
     if get_config().get('put_version_in_init', True): update_version(path)
 
 # %% ../nbs/api/01_config.ipynb 51
-def write_cells(cells, hdr, file, offset=0):
+def write_cells(cells, hdr, file, offset=0, cell_number=True):
     "Write `cells` to `file` along with header `hdr` starting at index `offset` (mainly for nbdev internal use)."
     for cell in cells:
-        if cell.source.strip(): file.write(f'\n\n{hdr} {cell.idx_+offset}\n{cell.source}')
+        if cell.source.strip(): file.write(f'\n\n{hdr} {cell.idx_+offset if cell_number else ""}\n{cell.source}')
 
 # %% ../nbs/api/01_config.ipynb 52
 def _basic_export_nb(fname, name, dest=None):

nbdev/doclinks.py

@@ -47,16 +47,22 @@ def _iter_py_cells(p):
     "Yield cells from an exported Python file."
     p = Path(p)
     cells = p.read_text(encoding='utf-8').split("\n# %% ")
+    has_cell_number = get_config().cell_number
     for cell in cells[1:]:
         top,code = cell.split('\n', 1)
         try:
-          *nb,idx = top.split()
-          nb = ' '.join(nb)
+            if has_cell_number:
+                *nb,idx = top.split()
+                nb = ' '.join(nb)
+                idx = int(idx)
+            else:
+                nb = top
+                idx = None
         except ValueError: raise ValueError(f"Unexpected format in '{p}' at cell:\n```\n# %% {cell.strip()}.\n```\n"
                                             "The expected format is: '# %% {nb_path} {cell_idx}'.")
         nb_path = None if nb=='auto' else (p.parent/nb).resolve()  # NB paths are stored relative to .py file
         if code.endswith('\n'): code=code[:-1]
-        yield AttrDict(nb=nb, idx=int(idx), code=code, nb_path=nb_path, py_path=p.resolve())
+        yield AttrDict(nb=nb, idx=idx, code=code, nb_path=nb_path, py_path=p.resolve())
 
 # %% ../nbs/api/05_doclinks.ipynb 11
 def _nbpath2html(p): return p.with_name(re.sub(r'^\d+[a-zA-Z0-9]*_', '', p.name.lower())).with_suffix('.html')
@@ -71,7 +77,7 @@ def _get_modidx(py_path, code_root, nbs_path):
     _def_types = ast.FunctionDef,ast.AsyncFunctionDef,ast.ClassDef
     d = {}
     for cell in _iter_py_cells(py_path):
-        if cell.nb == 'auto': continue
+        if 'auto' in cell.nb: continue
         loc = _nbpath2html(cell.nb_path.relative_to(nbs_path))
 
         def _stor(nm):

nbdev/maker.py

@@ -207,7 +207,7 @@ def make(self:ModuleMaker, cells, all_cells=None, lib_path=None):
         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)
+        write_cells(cells[last_future:], self.hdr, f, cell_number=get_config().cell_number)
         f.write('\n')
 
 # %% ../nbs/api/02_maker.ipynb 38

nbdev/sync.py

@@ -67,6 +67,7 @@ def nbdev_update(fname:str=None): # A Python file name to update
     if fname and fname.endswith('.ipynb'): raise ValueError("`nbdev_update` operates on .py files.  If you wish to convert notebooks instead, see `nbdev_export`.")
     if os.environ.get('IN_TEST',0): return
     cfg = get_config()
+    if not cfg.cell_number: raise ValueError("`nbdev_update` does not support without cell_number in .py files. Please check your settings.ini")
     fname = Path(fname or cfg.lib_path)
     lib_dir = cfg.lib_path.parent
     files = globtastic(fname, file_glob='*.py', skip_folder_re='^[_.]').filter(lambda x: str(Path(x).absolute().relative_to(lib_dir) in _mod_files()))

nbs/api/01_config.ipynb

@@ -166,6 +166,7 @@
     "    jupyter_hooks:bool_arg=False, # Run Jupyter hooks?\n",
     "    clean_ids:bool_arg=True, # Remove ids from plaintext reprs?\n",
     "    clear_all:bool_arg=False, # Remove all cell metadata and cell outputs?\n",
+    "    cell_number:bool_arg=True, # Add cell number to the exported file\n",
     "    put_version_in_init:bool_arg=True, # Add the version to the main __init__.py in nbdev_export\n",
     "):\n",
     "    \"Apply default settings where missing in `cfg`.\"\n",
@@ -209,7 +210,16 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "/home/dienhoa/miniconda3/envs/se/lib/python3.9/site-packages/ghapi/core.py:102: UserWarning: Neither GITHUB_TOKEN nor GITHUB_JWT_TOKEN found: running as unauthenticated\n",
+      "  else: warn('Neither GITHUB_TOKEN nor GITHUB_JWT_TOKEN found: running as unauthenticated')\n"
+     ]
+    }
+   ],
    "source": [
     "#|hide\n",
     "if os.getenv('GITHUB_ACTIONS') != 'true': # GITHUB_TOKEN in actions has limited scope.\n",
@@ -742,10 +752,10 @@
    "outputs": [],
    "source": [
     "#|export\n",
-    "def write_cells(cells, hdr, file, offset=0):\n",
+    "def write_cells(cells, hdr, file, offset=0, cell_number=True):\n",
     "    \"Write `cells` to `file` along with header `hdr` starting at index `offset` (mainly for nbdev internal use).\"\n",
     "    for cell in cells:\n",
-    "        if cell.source.strip(): file.write(f'\\n\\n{hdr} {cell.idx_+offset}\\n{cell.source}')"
+    "        if cell.source.strip(): file.write(f'\\n\\n{hdr} {cell.idx_+offset if cell_number else \"\"}\\n{cell.source}')"
    ]
   },
   {

nbs/api/02_maker.ipynb

@@ -519,7 +519,7 @@
     "        f.write(f\"# AUTOGENERATED! DO NOT EDIT! File to edit: {self.dest2nb}.\")\n",
     "        if last_future > 0: write_cells(cells[:last_future], self.hdr, f)\n",
     "        if self.parse: f.write(f\"\\n\\n# %% auto 0\\n__all__ = {all_str}\")\n",
-    "        write_cells(cells[last_future:], self.hdr, f)\n",
+    "        write_cells(cells[last_future:], self.hdr, f, cell_number=get_config().cell_number)\n",
     "        f.write('\\n')"
    ]
   },

nbs/api/05_doclinks.ipynb

@@ -135,16 +135,22 @@
     "    \"Yield cells from an exported Python file.\"\n",
     "    p = Path(p)\n",
     "    cells = p.read_text(encoding='utf-8').split(\"\\n# %% \")\n",
+    "    has_cell_number = get_config().cell_number\n",
     "    for cell in cells[1:]:\n",
     "        top,code = cell.split('\\n', 1)\n",
     "        try:\n",
-    "          *nb,idx = top.split()\n",
-    "          nb = ' '.join(nb)\n",
+    "            if has_cell_number:\n",
+    "                *nb,idx = top.split()\n",
+    "                nb = ' '.join(nb)\n",
+    "                idx = int(idx)\n",
+    "            else:\n",
+    "                nb = top\n",
+    "                idx = None\n",
     "        except ValueError: raise ValueError(f\"Unexpected format in '{p}' at cell:\\n```\\n# %% {cell.strip()}.\\n```\\n\"\n",
     "                                            \"The expected format is: '# %% {nb_path} {cell_idx}'.\")\n",
     "        nb_path = None if nb=='auto' else (p.parent/nb).resolve()  # NB paths are stored relative to .py file\n",
     "        if code.endswith('\\n'): code=code[:-1]\n",
-    "        yield AttrDict(nb=nb, idx=int(idx), code=code, nb_path=nb_path, py_path=p.resolve())"
+    "        yield AttrDict(nb=nb, idx=idx, code=code, nb_path=nb_path, py_path=p.resolve())"
    ]
   },
   {
@@ -195,7 +201,7 @@
     "    _def_types = ast.FunctionDef,ast.AsyncFunctionDef,ast.ClassDef\n",
     "    d = {}\n",
     "    for cell in _iter_py_cells(py_path):\n",
-    "        if cell.nb == 'auto': continue\n",
+    "        if 'auto' in cell.nb: continue\n",
     "        loc = _nbpath2html(cell.nb_path.relative_to(nbs_path))\n",
     "\n",
     "        def _stor(nm):\n",

nbs/api/06_sync.ipynb

@@ -191,6 +191,7 @@
     "    if fname and fname.endswith('.ipynb'): raise ValueError(\"`nbdev_update` operates on .py files.  If you wish to convert notebooks instead, see `nbdev_export`.\")\n",
     "    if os.environ.get('IN_TEST',0): return\n",
     "    cfg = get_config()\n",
+    "    if not cfg.cell_number: raise ValueError(\"`nbdev_update` does not support without cell_number in .py files. Please check your settings.ini\")\n",
     "    fname = Path(fname or cfg.lib_path)\n",
     "    lib_dir = cfg.lib_path.parent\n",
     "    files = globtastic(fname, file_glob='*.py', skip_folder_re='^[_.]').filter(lambda x: str(Path(x).absolute().relative_to(lib_dir) in _mod_files()))\n",

settings.ini

@@ -66,5 +66,6 @@ allowed_cell_metadata_keys =
 jupyter_hooks = True
 clean_ids = False
 clear_all = False
+cell_number = True
 put_version_in_init = True