Comprehensive XML generator for Python
Project description
XML Generator
Comprehensive XML generator for Python
Table of Contents
Installation
pip install xml-generator-seobaeksol
Usage
Import
from xml_generator.types import XmlNode
Comprehensive parsing
Parse Comprehensive format into an XmlNode object.
node = XmlNode.parse(
{
"name": "node",
"attributes": {"attr1": "value1", "attr2": "value2"},
"body": [
{"name": "child1", "attributes": {"attr1": "value1"}},
{"name": "child2", "attributes": {"attr2": "value2"}},
],
}
)
Create a XmlNode with a query
node = XmlNode.from_query('node@attr1="value1"@attr2="value2"')
Create a XmlNode with a extended query
extend_query = {
"root": [
"NoValueNode",
{
"SHORT-NAME": "node",
},
{
"ELEMENTS@type=string": [
"element@hint=id",
"element@unit=m",
{"element@unit=m@min=0@max=100@init=50": "100"},
],
},
]
}
Searching a specific node
Return the first XmlNode with the given query. Query can be a name with attributes.
parent = node.find("node")
child1 = node.find("child1@attr1")
child2 = node.find("child2")
Serialization
Using the to_xml()
function that return the XmlNode as an XML string.
with open('sample.xml', 'w', encoding='utf-8') as f:
f.write(node.to_xml())
Using the to_extend_query()
function that return the extended query object as an XML string.
extended_query_obj = root.to_extended_query()
Deserialization
Use XmlParser
class for reading a xml file that return XmlNode
by close()
method.
It is sub-class of xml.etree.ElementTree.XMLParser
built-in python class.
from xml_generator.types import XmlParser
parser = XmlParser()
with open(
file="xml_generator/tests/samples/complex.xml", mode="r", encoding="utf-8"
) as f:
original_xml = f.read()
parser.feed(original_xml)
root = parser.close()
xml_string = root.to_xml(
declaration=True, declaration_tag='<?xml version="1.0" encoding="UTF-8"?>\n'
)
Contributing
Coming soon.
Testing
python -m unittest discover -s xml_generator/tests -p "test*.py"
Building
python .\setup.py sdist bdist_wheel
Deployment
twine upload dist/*
License
License :: OSI Approved :: MIT License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for xml-generator-seobaeksol-0.4.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a091cd62762c5f873d8089a6c19d0faf6ac86fab9513d95f5673f25e0419b31 |
|
MD5 | 7cc9845b63cb24df9ee75f477b0a85db |
|
BLAKE2b-256 | f5094bec6d05ce8d56c4ff298302a2cc8284c08fb75570654d29512b1ecfb53c |
Hashes for xml_generator_seobaeksol-0.4.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83fc23a6941d081b40e694fe1c4da1b94e1604363ae3c7f7b99cc2dfbf675cba |
|
MD5 | 6e60f2e0bb35636a28c65df2ba69c5fc |
|
BLAKE2b-256 | bccf8c8707c7774f9b5393aca0b194c9d2420405cb8bb1e7654a76f0b71c5081 |