From c7be629d44d4e2be6c8116796714e0042a977885 Mon Sep 17 00:00:00 2001
From: David Sommerseth <davids@redhat.com>
Date: Tue, 28 Apr 2009 11:12:58 +0200
Subject: Added generic XML -> Python parser

The xmlpythonizer module will convert any XML data (xmlNode
or xmlDoc) and format it as a Python object.  The formatting is
defined in it's own XML file.

Basic format:
<dmidecode_fieldmap version="1">
    <Mapping name="{name of mapping table}">
	<Map keytype="{key type}" key="{key value}"
	     valuetype="{value type} value="{value}"/>
    </Mapping>
</dmidecode_fieldmap>

The keytype and key attributes defines the key in the Python Dict.  The
root element will always be a Python Dict structure.  The valid key types
are:
  * constant
    Uses the value in {key} as the key value

  * string, integer, float
    Uses a string value from the data XML to be converted to Python.  The
    value set in the key attribute defines an XPath value which points to the
    data to be used as a Python dict key.

    Since Python only supports C strings in the C interface for Python dict
    keys, integer and float will be treated as strings.

The valuetype and value attributes are similar to the keys, but with some more
features.  Valid valuetypes are:

  * constant
    The value given in the value attribute will be used in the value in
    the Python result.

  * string, integer, float
    The value given in the value attribute defines the XPath to the data XML,
    of where to retrieve the value for the given key.

    The valuetype defines if the data should be understood as a string, integer
    or float in the Python result.

  * list:string, list:integer, list:float
    This does the same as the string, integer or float type, with a tweak.  The
    data will be put into a list.  If the XPath given returns multiple nodes,
    all of them will be added to this list.

  * dict
    The dict valuetype is more special.  It should not contain any value
    attribute.  On the other hand, it should contain a sub-level of <Map> tags.
    In this way, you can build up a multi dimensional Python dict.

Example:

  ** pythonmap.xml **
    <?xml version="1.0" encoding="UTF-8"?>
    <dmidecode_fieldmap version="1">
      <Mapping name="example_map">
	<Map keytype="constant" key="DemoCase" valuetype="constant" value="XML Pythonizing"/>
        <Map keytype="constant" key="String1" valuetype="string" value="/example/string1"/>
        <Map keytype="constant" key="AttribString1" valuetype="integer" value="/example/string1/@int_value"/>
	<Map keytype="string" key="/example/keyset/@value" valuetype="dict">
	    <Map keytype="constant" key="Value1" valuetype="string" value="/example/keyset/value1"/>
	    <Map keytype="constant" key="ValueList" valuetype="list:string" value="/example/keyset/valuelist"/>
	</Map>
      </Mapping>
    </dmidecode_fieldmap>

  ** exampledata.xml **
    <?xml version="1.0" encoding="UTF-8"?>
    <example>
	<string1 int_value="1234">String value #1</string1>
	<keyset value="TestData">
	   <value1>More test data</value1>
	   <valuelist>Value1 in list</valuelist>
	   <valuelist>Value2 in list</valuelist>
	   <valuelist>Value3 in list</valuelist>
	</keyset>
    </example>

  ** C code snippet **

  void xmlpythonizer() {
      xmlDoc *xmlmap = NULL;
      xmlDoc *xmldata = NULL;
      ptzMAP *mapping = NULL;
      PyObject *pythondata = NULL;

      // Read XML files
      xmlmap = xmlReadFile("pythonmap.xml", NULL, 0);
      xmldata = xmlReadFile("exampledata.xml", NULL, 0);

      // Parse the mapping XML
      mapping = dmiMAP_ParseMappingXML(xmlmap, "example_map");

      // Parse the xmldata into a Python object
      pythondata = pythonizeXMLdoc(mapping, xmldata);

      // ..... the program continues to do something useful
   }

   The result stored inside the pythondata object should now be
   something similar to:

   {'DemoCase': 'XML Pythonizing',
    'String1': 'String value #1',
    'AttribString1: 1234,
    'TestData': {'Value1': 'More test data',
		 'ValueList': ['Value1 in list','Value2 in list','Value3 in list']}
   }
---
 src/setup.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'src/setup.py')

diff --git a/src/setup.py b/src/setup.py
index 6272e85..ec66c3f 100644
--- a/src/setup.py
+++ b/src/setup.py
@@ -16,7 +16,8 @@ setup(
         "src/util.c",
         "src/dmioem.c",
         "src/dmidecode.c",
-        "src/dmixml.c"
+        "src/dmixml.c",
+        "src/xmlpythonizer.c"
       ],
       include_dirs = [ "/usr/include/libxml2" ],
       library_dirs = [ "/home/nima/dev-room/projects/dmidecode" ],
-- 
cgit