add flag for preserving magics

fastai · Sep 12, 2024 · b725c01 · b725c01
1 parent 44c9a7f
commit b725c01
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 12 deletions.
diff --git a/nbdev/config.py b/nbdev/config.py
@@ -63,6 +63,7 @@ def _apply_defaults(
     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
+    keep_magics:bool = False, # Keep magic commands in rendered documentation (useful for AImagic notebooks)
 ):
     "Apply default settings where missing in `cfg`."
     if getattr(cfg,'repo',None) is None:

diff --git a/nbdev/processors.py b/nbdev/processors.py
@@ -183,7 +183,8 @@ def ai_magics(cell):
 
 def clean_magics(cell):
     "A preprocessor to remove cell magic commands"
-    if cell.cell_type == 'code': cell.source = _magics_pattern.sub('', cell.source).strip()
+    if cell.cell_type == 'code' and not get_config().get('keep_magics', False):
+        cell.source = _magics_pattern.sub('', cell.source).strip()
 
 # %% ../nbs/api/10_processors.ipynb
 _re_hdr_dash = re.compile(r'^#+\s+.*\s+-\s*$', re.MULTILINE)

diff --git a/nbs/api/01_config.ipynb b/nbs/api/01_config.ipynb
@@ -153,6 +153,7 @@
     "    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",
+    "    keep_magics:bool = False, # Keep magic commands in rendered documentation (useful for AImagic notebooks)\n",
     "):\n",
     "    \"Apply default settings where missing in `cfg`.\"\n",
     "    if getattr(cfg,'repo',None) is None:\n",
@@ -195,16 +196,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "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"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "#|hide\n",
     "if os.getenv('GITHUB_ACTIONS') != 'true': # GITHUB_TOKEN in actions has limited scope.\n",

diff --git a/nbs/api/10_processors.ipynb b/nbs/api/10_processors.ipynb
@@ -578,7 +578,8 @@
     "\n",
     "def clean_magics(cell):\n",
     "    \"A preprocessor to remove cell magic commands\"\n",
-    "    if cell.cell_type == 'code': cell.source = _magics_pattern.sub('', cell.source).strip()"
+    "    if cell.cell_type == 'code' and not get_config().get('keep_magics', False):\n",
+    "        cell.source = _magics_pattern.sub('', cell.source).strip()"
    ]
   },
   {