fixes #599

Author: jph00

fastcore/_modidx.py

@@ -570,10 +570,13 @@
                               'fastcore.xml.FT.children': ('xml.html#ft.children', 'fastcore/xml.py'),
                               'fastcore.xml.FT.tag': ('xml.html#ft.tag', 'fastcore/xml.py'),
                               'fastcore.xml.Html': ('xml.html#html', 'fastcore/xml.py'),
+                              'fastcore.xml.Safe': ('xml.html#safe', 'fastcore/xml.py'),
+                              'fastcore.xml.Safe.__html__': ('xml.html#safe.__html__', 'fastcore/xml.py'),
                               'fastcore.xml.__getattr__': ('xml.html#__getattr__', 'fastcore/xml.py'),
                               'fastcore.xml._escape': ('xml.html#_escape', 'fastcore/xml.py'),
                               'fastcore.xml._preproc': ('xml.html#_preproc', 'fastcore/xml.py'),
                               'fastcore.xml._to_attr': ('xml.html#_to_attr', 'fastcore/xml.py'),
+                              'fastcore.xml._to_xml': ('xml.html#_to_xml', 'fastcore/xml.py'),
                               'fastcore.xml.attrmap': ('xml.html#attrmap', 'fastcore/xml.py'),
                               'fastcore.xml.ft': ('xml.html#ft', 'fastcore/xml.py'),
                               'fastcore.xml.highlight': ('xml.html#highlight', 'fastcore/xml.py'),

fastcore/xml.py

@@ -1,12 +1,12 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/11_xml.ipynb.
 
 # %% auto 0
-__all__ = ['voids', 'FT', 'attrmap', 'valmap', 'ft', 'Html', 'to_xml', 'highlight', 'showtags', 'Head', 'Title', 'Meta', 'Link',
-           'Style', 'Body', 'Pre', 'Code', 'Div', 'Span', 'P', 'H1', 'H2', 'H3', 'H4', 'H5', 'H6', 'Strong', 'Em', 'B',
-           'I', 'U', 'S', 'Strike', 'Sub', 'Sup', 'Hr', 'Br', 'Img', 'A', 'Nav', 'Ul', 'Ol', 'Li', 'Dl', 'Dt', 'Dd',
-           'Table', 'Thead', 'Tbody', 'Tfoot', 'Tr', 'Th', 'Td', 'Caption', 'Col', 'Colgroup', 'Form', 'Input',
-           'Textarea', 'Button', 'Select', 'Option', 'Label', 'Fieldset', 'Legend', 'Details', 'Summary', 'Main',
-           'Header', 'Footer', 'Section', 'Article', 'Aside', 'Figure', 'Figcaption', 'Mark', 'Small', 'Iframe',
+__all__ = ['voids', 'FT', 'attrmap', 'valmap', 'ft', 'Html', 'Safe', 'to_xml', 'highlight', 'showtags', 'Head', 'Title', 'Meta',
+           'Link', 'Style', 'Body', 'Pre', 'Code', 'Div', 'Span', 'P', 'H1', 'H2', 'H3', 'H4', 'H5', 'H6', 'Strong',
+           'Em', 'B', 'I', 'U', 'S', 'Strike', 'Sub', 'Sup', 'Hr', 'Br', 'Img', 'A', 'Nav', 'Ul', 'Ol', 'Li', 'Dl',
+           'Dt', 'Dd', 'Table', 'Thead', 'Tbody', 'Tfoot', 'Tr', 'Th', 'Td', 'Caption', 'Col', 'Colgroup', 'Form',
+           'Input', 'Textarea', 'Button', 'Select', 'Option', 'Label', 'Fieldset', 'Legend', 'Details', 'Summary',
+           'Main', 'Header', 'Footer', 'Section', 'Article', 'Aside', 'Figure', 'Figcaption', 'Mark', 'Small', 'Iframe',
            'Object', 'Embed', 'Param', 'Video', 'Audio', 'Source', 'Canvas', 'Svg', 'Math', 'Script', 'Noscript',
            'Template', 'Slot']
 
@@ -88,6 +88,10 @@ def Html(*c, doctype=True, **kwargs)->FT:
     if not doctype: return res
     return (ft('!DOCTYPE', html=True, void_=True), res)
 
+# %% ../nbs/11_xml.ipynb
+class Safe(str):
+    def __html__(self): return self
+
 # %% ../nbs/11_xml.ipynb
 def _escape(s): return '' if s is None else s.__html__() if hasattr(s, '__html__') else escape(s) if isinstance(s, str) else s
 
@@ -104,8 +108,7 @@ def _to_attr(k,v):
     return f'{k}={qt}{v}{qt}'
 
 # %% ../nbs/11_xml.ipynb
-def to_xml(elm, lvl=0, indent:bool=True):
-    "Convert `ft` element tree into an XML string"
+def _to_xml(elm, lvl, indent:bool):
     nl = '\n'
     if not indent: lvl,nl = 0,''
     if elm is None: return ''
@@ -128,7 +131,11 @@ def to_xml(elm, lvl=0, indent:bool=True):
     res = f'{sp}<{stag}>{nl}'
     res += ''.join(to_xml(c, lvl=lvl+2, indent=indent) for c in cs)
     if not isvoid: res += f'{sp}{cltag}{nl}'
-    return res
+    return Safe(res)
+
+def to_xml(elm, lvl=0, indent:bool=True):
+    "Convert `ft` element tree into an XML string"
+    return Safe(_to_xml(elm, lvl, indent))
 
 FT.__html__ = to_xml
 

nbs/11_xml.ipynb

@@ -286,6 +286,18 @@
     "elem"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "116c886e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| export\n",
+    "class Safe(str):\n",
+    "    def __html__(self): return self"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -325,8 +337,7 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "def to_xml(elm, lvl=0, indent:bool=True):\n",
-    "    \"Convert `ft` element tree into an XML string\"\n",
+    "def _to_xml(elm, lvl, indent:bool):\n",
     "    nl = '\\n'\n",
     "    if not indent: lvl,nl = 0,''\n",
     "    if elm is None: return ''\n",
@@ -349,7 +360,11 @@
     "    res = f'{sp}<{stag}>{nl}'\n",
     "    res += ''.join(to_xml(c, lvl=lvl+2, indent=indent) for c in cs)\n",
     "    if not isvoid: res += f'{sp}{cltag}{nl}'\n",
-    "    return res\n",
+    "    return Safe(res)\n",
+    "\n",
+    "def to_xml(elm, lvl=0, indent:bool=True):\n",
+    "    \"Convert `ft` element tree into an XML string\"\n",
+    "    return Safe(_to_xml(elm, lvl, indent))\n",
     "\n",
     "FT.__html__ = to_xml"
    ]
@@ -413,7 +428,7 @@
    "id": "4713bd8d",
    "metadata": {},
    "source": [
-    "Interoperability both directions with Django and Jinja using the [__html__() protocol](https://jinja.palletsprojects.com/en/3.1.x/templates/#jinja-filters.escape)."
+    "Interoperability both directions with Django and Jinja using the [__html__() protocol](https://jinja.palletsprojects.com/en/3.1.x/templates/#jinja-filters.escape):"
    ]
   },
   {
@@ -436,14 +451,11 @@
     }
    ],
    "source": [
-    "class _SafeString(str):\n",
-    "    def __html__(self): return self\n",
-    "\n",
-    "def _escape(s): return s.__html__() if hasattr(s, '__html__') else _SafeString(escape(s))\n",
+    "def _esc(s): return s.__html__() if hasattr(s, '__html__') else Safe(escape(s))\n",
     "\n",
-    "r = _SafeString('<b>Hello from Django</b>')\n",
+    "r = Safe('<b>Hello from Django</b>')\n",
     "print(to_xml(Div(r)))\n",
-    "print(_escape(Div(P('Hello from fastcore <3'))))"
+    "print(_esc(Div(P('Hello from fastcore <3'))))"
    ]
   },
   {