✨ Allow xml conversion only (#431)

* Added vscode config folder to .gitignore

* Added py.typed to allow use of package types (PEP 561)

* Split out generation of Element from conversion to string

* Added a test for convert_to_element

* Added space after standard library import

* Reformat

---------

Co-authored-by: Rob Blackbourn <rob.blackbourn@gmail.com>
Co-authored-by: Ronie Martinez <ronmarti18@gmail.com>

.gitignore

@@ -137,3 +137,6 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
+
+# vscode config
+.vscode/

latex2mathml/converter.py

@@ -62,11 +62,28 @@ class Mode(enum.Enum):
     MATH = enum.auto()
 
 
-def convert(latex: str, xmlns: str = "http://www.w3.org/1998/Math/MathML", display: str = "inline") -> str:
-    math = Element("math", xmlns=xmlns, display=display)
+def convert(
+    latex: str,
+    xmlns: str = "http://www.w3.org/1998/Math/MathML",
+    display: str = "inline",
+    parent: Optional[Element] = None,
+) -> str:
+    math = convert_to_element(latex, xmlns, display, parent)
+    return _convert(math)
+
+
+def convert_to_element(
+    latex: str,
+    xmlns: str = "http://www.w3.org/1998/Math/MathML",
+    display: str = "inline",
+    parent: Optional[Element] = None,
+) -> Element:
+    tag = "math"
+    attrib = {"xmlns": xmlns, "display": display}
+    math = Element(tag, attrib) if parent is None else SubElement(parent, tag, attrib)
     row = SubElement(math, "mrow")
     _convert_group(iter(walk(latex)), row)
-    return _convert(math)
+    return math
 
 
 def _convert(tree: Element) -> str:

latex2mathml/py.typed

@@ -0,0 +1 @@
+# PEP 581

tests/test_converter.py

@@ -1,9 +1,11 @@
+from xml.etree.cElementTree import Element
+
 import pytest
 from multidict import MultiDict
 from xmljson import BadgerFish
 
 # noinspection PyProtectedMember
-from latex2mathml.converter import _convert, convert
+from latex2mathml.converter import _convert, convert, convert_to_element
 
 
 @pytest.mark.parametrize(
@@ -4213,3 +4215,28 @@ def test_attributes() -> None:
         convert("1", display="block")
         == '<math xmlns="http://www.w3.org/1998/Math/MathML" display="block"><mrow><mn>1</mn></mrow></math>'
     )
+
+
+def test_convert_to_element() -> None:
+    bf = BadgerFish()
+
+    element = convert_to_element("1")
+    assert bf.data(element) == {
+        "math": {
+            "@display": "inline",
+            "@xmlns": "http://www.w3.org/1998/Math/MathML",
+            "mrow": {"mn": {"$": 1}},
+        },
+    }, "should convert to element"
+
+    parent = Element("div")
+    convert_to_element("1", parent=parent)
+    assert bf.data(parent) == {
+        "div": {
+            "math": {
+                "@display": "inline",
+                "@xmlns": "http://www.w3.org/1998/Math/MathML",
+                "mrow": {"mn": {"$": 1}},
+            },
+        }
+    }, "should convert to element as child of parent"