fixes #790

Author: jph00

fastcore/xtras.py

@@ -596,16 +596,16 @@ def asave_iter(g):
     def _(*args, **kwargs): return _save_iter(g, *args, **kwargs)
     return _
 
-# %% ../nbs/03_xtras.ipynb #20e906c7
-def frontmatter(txt:str)->dict:
-    "Dict contained in frontmatter in `txt`, if present"
+# %% ../nbs/03_xtras.ipynb #d2757e2a
+def frontmatter(txt:str)->tuple:
+    "Tuple of (dict, body) from frontmatter in `txt`; invalid/missing frontmatter returns ({}, txt)"
     import yaml
-    if not txt.startswith('---\n'): return {}
-    fm,part,_ = txt[4:].partition('\n---\n')
-    if not part: return {}
+    if not txt.startswith('---\n'): return {},txt
+    fm,part,body = txt[4:].partition('\n---\n')
+    if not part: return {},txt
     try: res = yaml.safe_load(fm)
-    except yaml.parser.ParserError: return {}
-    return res if isinstance(res,dict) else {}
+    except yaml.parser.ParserError: return {},txt
+    return (res,body) if isinstance(res,dict) else ({},txt)
 
 # %% ../nbs/03_xtras.ipynb #45eb5141
 def clean_cli_output(txt:str, strip:bool=True):

nbs/03_xtras.ipynb

@@ -2345,7 +2345,7 @@
     {
      "data": {
       "text/plain": [
-       "['f', 'h', 'g', 'e', 'd', 'b', 'a', 'c']"
+       "['e', 'h', 'd', 'c', 'a', 'f', 'b', 'g']"
       ]
      },
      "execution_count": null,
@@ -2708,34 +2708,34 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "20e906c7",
+   "id": "d2757e2a",
    "metadata": {},
    "outputs": [],
    "source": [
     "#| export\n",
-    "def frontmatter(txt:str)->dict:\n",
-    "    \"Dict contained in frontmatter in `txt`, if present\"\n",
+    "def frontmatter(txt:str)->tuple:\n",
+    "    \"Tuple of (dict, body) from frontmatter in `txt`; invalid/missing frontmatter returns ({}, txt)\"\n",
     "    import yaml\n",
-    "    if not txt.startswith('---\\n'): return {}\n",
-    "    fm,part,_ = txt[4:].partition('\\n---\\n')\n",
-    "    if not part: return {}\n",
+    "    if not txt.startswith('---\\n'): return {},txt\n",
+    "    fm,part,body = txt[4:].partition('\\n---\\n')\n",
+    "    if not part: return {},txt\n",
     "    try: res = yaml.safe_load(fm)\n",
-    "    except yaml.parser.ParserError: return {}\n",
-    "    return res if isinstance(res,dict) else {}"
+    "    except yaml.parser.ParserError: return {},txt\n",
+    "    return (res,body) if isinstance(res,dict) else ({},txt)"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "b8165cbd",
+   "id": "0648a1fe",
    "metadata": {},
    "outputs": [],
    "source": [
-    "test_eq(frontmatter('---\\ntitle: \"Hi there\"\\ntags: [a,b]\\n---\\nBody'), {'title':'Hi there', 'tags':['a','b']})\n",
-    "test_eq(frontmatter('---\\nbroken: [a,'), {})\n",
-    "test_eq(frontmatter('No frontmatter here'), {})\n",
-    "test_eq(frontmatter('---\\njust text no closing'), {})\n",
-    "test_eq(frontmatter('---\\n---\\nBody'), {})"
+    "test_eq(frontmatter('---\\ntitle: \"Hi there\"\\ntags: [a,b]\\n---\\nBody'), ({'title':'Hi there', 'tags':['a','b']}, 'Body'))\n",
+    "test_eq(frontmatter('---\\nbroken: [a,'), ({}, '---\\nbroken: [a,'))\n",
+    "test_eq(frontmatter('No frontmatter here'), ({}, 'No frontmatter here'))\n",
+    "test_eq(frontmatter('---\\njust text no closing'), ({}, '---\\njust text no closing'))\n",
+    "test_eq(frontmatter('---\\n---\\nBody'), ({}, '---\\n---\\nBody'))"
    ]
   },
   {