xmlpydict 0.0.12__tar.gz → 0.0.13__tar.gz

{xmlpydict-0.0.12/xmlpydict.egg-info → xmlpydict-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xmlpydict
-Version: 0.0.12
+Version: 0.0.13
 Summary: xml to dictionary tool for python
 Author-email: Matthew Taylor <matthew.taylor.andre@gmail.com>
 Project-URL: Homepage, https://github.com/MatthewAndreTaylor/xml-to-pydict

{xmlpydict-0.0.12 → xmlpydict-0.0.13}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xmlpydict"
-version = "0.0.12"
+version = "0.0.13"
 description="xml to dictionary tool for python"
 authors = [
     {name = "Matthew Taylor", email = "matthew.taylor.andre@gmail.com"},

{xmlpydict-0.0.12 → xmlpydict-0.0.13}/tests/test_parse.py

@@ -1,6 +1,6 @@
 import pytest
 import json
-from xmlpydict import parse
+from xmlpydict import parse, parse_file
 
 
 def test_simple():
@@ -350,3 +350,35 @@ def test_document():
             ]
         }
     }
+
+
+def test_parse_file(tmp_path):
+    s = """<?xml version="1.0" encoding="UTF-8"?><repository>
+  <project pypi="xmlpydict">
+    <title>XML document parser</title>
+    <author>Matthew Taylor</author>
+  </project>
+  <project pypi="blank">
+    <title>Test project</title>
+    <author>Matthew Taylor</author>
+  </project>
+</repository>"""
+    with open(tmp_path / "test.xml", "w") as f:
+        f.write(s)
+
+    assert parse_file(tmp_path / "test.xml") == {
+        "repository": {
+            "project": [
+                {
+                    "@pypi": "xmlpydict",
+                    "title": "XML document parser",
+                    "author": "Matthew Taylor",
+                },
+                {
+                    "@pypi": "blank",
+                    "title": "Test project",
+                    "author": "Matthew Taylor",
+                },
+            ]
+        }
+    }

{xmlpydict-0.0.12 → xmlpydict-0.0.13}/xmlpydict/__init__.py

@@ -45,9 +45,9 @@ def parse_file(file_path, attr_prefix: str = "@", cdata_key: str = "#text") -> d
     return handler.item
 
 
-
-def iter_xml_documents(file_path, chunk_size=64 * 1024):
-    start_token = b"<?xml"
+def iter_xml_documents(
+    file_path, chunk_size: int = 64 * 1024, start_token: bytes = b"<?xml"
+):
     buffer = b""
     with open(file_path, "rb") as f:
         while True:
@@ -63,13 +63,27 @@ def iter_xml_documents(file_path, chunk_size=64 * 1024):
                     break
                 yield buffer[:start_index]
                 buffer = buffer[start_index:]
-            
-            
 
-def parse_xml_collections(file_path, attr_prefix: str = "@", cdata_key: str = "#text"):
-    for xml_content in iter_xml_documents(file_path):
+
+def parse_xml_collections(
+    file_path,
+    attr_prefix: str = "@",
+    cdata_key: str = "#text",
+    start_token: bytes = b"<?xml",
+):
+    """
+    Parse collections of xml documents based on a delimeter start_token
+
+    Args:
+        file_path: The path to the XML file to be parsed.
+        attr_prefix: The prefix to use for attributes in the resulting dictionary.
+        cdata_key: The key to use for character data in the resulting dictionary.
+        start_token: The byte sequence that delimits the start of each XML document.
+
+    Returns:
+        A generator yielding dictionaries representing each XML document in the collection.
+    """
+    for xml_content in iter_xml_documents(file_path, start_token=start_token):
         yield parse(
-            xml_content.decode("utf-8"),
-            attr_prefix=attr_prefix,
-            cdata_key=cdata_key
+            xml_content.decode("utf-8"), attr_prefix=attr_prefix, cdata_key=cdata_key
         )

{xmlpydict-0.0.12 → xmlpydict-0.0.13/xmlpydict.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xmlpydict
-Version: 0.0.12
+Version: 0.0.13
 Summary: xml to dictionary tool for python
 Author-email: Matthew Taylor <matthew.taylor.andre@gmail.com>
 Project-URL: Homepage, https://github.com/MatthewAndreTaylor/xml-to-pydict