xmlpydict 0.0.10__cp310-cp310-manylinux_2_24_x86_64.manylinux_2_34_x86_64.whl

xmlpydict/__init__.py

@@ -0,0 +1,23 @@
+from pyxmlhandler import _PyDictHandler
+from xml.parsers import expat
+
+
+def parse(xml_content, **kwargs) -> dict:
+    handler = _PyDictHandler(**kwargs)
+    parser = expat.ParserCreate()
+    parser.CharacterDataHandler = handler.characters
+    parser.StartElementHandler = handler.startElement
+    parser.EndElementHandler = handler.endElement
+    parser.Parse(xml_content, True)
+    return handler.item
+
+
+def parse_file(file_path, **kwargs) -> dict:
+    handler = _PyDictHandler(**kwargs)
+    parser = expat.ParserCreate()
+    parser.CharacterDataHandler = handler.characters
+    parser.StartElementHandler = handler.startElement
+    parser.EndElementHandler = handler.endElement
+    with open(file_path, "r", encoding="utf-8") as f:
+        parser.ParseFile(f)
+    return handler.item

xmlpydict-0.0.10.dist-info/METADATA

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: xmlpydict
+Version: 0.0.10
+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
+Keywords: xml,dictionary
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup :: XML
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: requests; extra == "tests"
+Dynamic: license-file
+
+# xmlpydict 📑
+
+[![XML Tests](https://github.com/MatthewAndreTaylor/xml-to-pydict/actions/workflows/tests.yml/badge.svg)](https://github.com/MatthewAndreTaylor/xml-to-pydict/actions/workflows/tests.yml)
+[![PyPI versions](https://img.shields.io/badge/python-3.8%2B-blue)](https://github.com/MatthewAndreTaylor/xml-to-pydict)
+[![PyPI](https://img.shields.io/pypi/v/xmlpydict.svg)](https://pypi.org/project/xmlpydict/)
+
+## Requirements
+
+- `python 3.8+`
+
+## Installation
+
+To install xmlpydict, using pip:
+
+```bash
+pip install xmlpydict
+```
+
+## Quickstart
+
+```py
+>>> from xmlpydict import parse
+>>> parse("<package><xmlpydict language='python'/></package>")
+{'package': {'xmlpydict': {'@language': 'python'}}}
+>>> parse("<person name='Matthew'>Hello!</person>")
+{'person': {'@name': 'Matthew', '#text': 'Hello!'}}
+```
+
+## Goals
+
+Create a consistent parsing strategy between XML and Python dictionaries using the specification found [here](https://www.xml.com/pub/a/2006/05/31/converting-between-xml-and-json.html). `xmlpydict` focuses on speed; see the benchmarks below.
+
+<img width="256" alt="small_xml_document" src="https://github.com/user-attachments/assets/0248a408-6bb6-4790-bd0f-f90537e2f21a" />
+<img width="256" alt="large_xml_document" src="https://github.com/user-attachments/assets/539a2a69-f475-46a5-bffc-1e8805a5a5e7" />
+
+
+### xmlpydict supports the following 
+
+[CDataSection](https://www.w3.org/TR/xml/#sec-cdata-sect):  CDATA Sections are stored as {'#text': CData}.
+
+[Comments](https://www.w3.org/TR/xml/#sec-comments):  Comments are tokenized for corectness, but have no effect in what is returned.
+
+[Element Tags](https://www.w3.org/TR/xml/#sec-starttags):  Allows for duplicate attributes, however only the latest defined will be taken. 
+
+[Characters](https://www.w3.org/TR/xml/#charsets):  Similar to CDATA text is stored as {'#text': Char} , however this text is stripped.
+
+```py
+# Empty tags are containers
+>>> from xmlpydict import parse
+>>> parse("<a></a>")
+{'a': None}
+>>> parse("<a/>")
+{'a': None}
+>>> parse("<a/>").get('href')
+None
+```
+
+### Attribute prefixing
+
+```py
+# Change prefix from default "@" with keyword argument attr_prefix
+>>> from xmlpydict import parse
+>>> parse('<p width="10" height="5"></p>', attr_prefix="$")
+{"p": {"$width": "10", "$height": "5"}}
+```
+
+
+### Exceptions
+
+```py
+# Grammar and structure of the xml_content is checked while parsing
+>>> from xmlpydict import parse
+>>> parse("<a></ a>")
+xml.parsers.expat.ExpatError: not well-formed (invalid token): line 1, column 5
+```
+
+
+### Unsupported
+
+Prolog / Enforcing Document Type Definition and Element Type Declarations
+
+Entity Referencing
+
+Namespaces

xmlpydict-0.0.10.dist-info/RECORD

@@ -0,0 +1,7 @@
+pyxmlhandler.cpython-310-x86_64-linux-gnu.so,sha256=JuhYybTuMYp9WDK4l2NGJF_LAwXkWWSf3bPM8EkkKLw,84336
+xmlpydict/__init__.py,sha256=imQYx-ABH-sMyQ9aTj5kIy9Ue-3DwX2H4a7BZ90uZic,787
+xmlpydict-0.0.10.dist-info/METADATA,sha256=tfd9JN29qZi7whvb-roeJOzqzX4G5H2T_ASVvrQdouI,3815
+xmlpydict-0.0.10.dist-info/WHEEL,sha256=uuWJa98bPU_AXb4UVlgAI4CIVTk5kJLmtKpdE0CpVLg,152
+xmlpydict-0.0.10.dist-info/top_level.txt,sha256=YEIhCVuLdrZ3UaJku2ROkLGCjBw4g4oMXWgDnMtbw5o,23
+xmlpydict-0.0.10.dist-info/RECORD,,
+xmlpydict-0.0.10.dist-info/licenses/LICENSE,sha256=x08oLniev4jR-mE0Qcw9TWflIKdMnam8nmF15BUoM-4,1076

xmlpydict-0.0.10.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp310-cp310-manylinux_2_24_x86_64
+Tag: cp310-cp310-manylinux_2_34_x86_64
+

xmlpydict-0.0.10.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Matthew Andre Taylor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

xmlpydict-0.0.10.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+pyxmlhandler
+xmlpydict