OpenOffice.org ODF, Python and XML
My desktop distribution (SUSE 9.3) includes the packages python-doc-2.4-14 and python-doc-pdf-2.4-14. You also can get documentation from www.python.org. In either case, we want the Library Reference, which contains information on the Python XML libraries; they are described in the chapter on “Structured Markup Processing Tools” (currently Chapter 13).
Several modules are listed, and I noticed one labeled lightweight: xml.dom.minidom—Lightweight Document Object Model (DOM) implementation.
Lightweight sounded good to me. The library reference gives these examples:
from xml.dom.minidom import parse, parseString dom1 = parse('c:\\temp\\mydata.xml') # parse an XML file by name datasource = open('c:\\temp\\mydata.xml') dom2 = parse(datasource) # parse an open file
So, it looks like parse can take a filename or a file object.
Once we create a dom object, what can we do with it? One nice thing about Python is the interactive shell, which lets you try things out one at a time. Let's unpack the first example and look inside:
% mkdir TMP % unzip -q -d TMP ex1.odt % python Python 2.4 (#1, Mar 22 2005, 21:42:42) [GCC 3.3.5 20050117 (prerelease) (SUSE Linux)] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> import xml.dom.minidom >>> dom=xml.dom.minidom.parse("TMP/content.xml") >>> dir(dom) [ --- a VERY long list, including --- 'childNodes', 'firstChild', 'nodeName', 'nodeValue', ... ] >>> len(dom.childNodes) 1 >>> c1=dom.firstChild >>> len(c1.childNodes) 4 >>> for c2 in c1.childNodes: print c2.nodeName ... office:scripts office:font-face-decls office:automatic-styles office:body >>>
Notice how Python's dir function tells what fields (including methods) are in the object. The childNodes field looks interesting, and indeed, it appears that the document has a tree structure. After a little more manual exploration, I discovered that text is contained in the data field of certain nodes. So, I coded up a naive script, fix1-NAIVE.py:
#!/usr/bin/python -tt import xml.dom.minidom import sys DEBUG = 1 def dprint(what): if DEBUG == 0: return sys.stderr.write(what + '\n') def handle_xml_tree(aNode, depth): if aNode.hasChildNodes(): for kid in aNode.childNodes: handle_xml_tree(kid, depth+1) else: if 'data' in dir(aNode): dprint(("depth=%d: " + aNode.data) % depth) def doit(argv): doc = xml.dom.minidom.parse(argv) handle_xml_tree(doc, 0) # sys.stdout.write(doc.toxml('utf-8')) if __name__ == "__main__": doit(sys.argv)
The dprint routine prints debugging information on stderr; later we'll set DEBUG=0, and it'll be silent. Okay, let's try that on the content.xml above:
% ./fix1-NAIVE.py TMP/content.xml depth=5: Turn all these depth=6: "straight" Traceback (most recent call last): File "./fix1-NAIVE.py", line 24, in ? doit(sys.argv) File "./fix1-NAIVE.py", line 20, in doit handle_xml_tree(doc, 0) File "./fix1-NAIVE.py", line 13, in handle_xml_tree handle_xml_tree(kid, depth+1) File "./fix1-NAIVE.py", line 13, in handle_xml_tree handle_xml_tree(kid, depth+1) File "./fix1-NAIVE.py", line 13, in handle_xml_tree handle_xml_tree(kid, depth+1) File "./fix1-NAIVE.py", line 13, in handle_xml_tree handle_xml_tree(kid, depth+1) File "./fix1-NAIVE.py", line 13, in handle_xml_tree handle_xml_tree(kid, depth+1) File "./fix1-NAIVE.py", line 16, in handle_xml_tree dprint(("depth=%d: " + aNode.data) % depth) File "./fix1-NAIVE.py", line 8, in dprint sys.stderr.write(what + '\n') UnicodeEncodeError: 'ascii' codec can't encode character u'\u201c' in position 22: ordinal not in range(128) %
What's that error about? When trying to print that string on stderr, we hit a non-ASCII character—probably one of those curly quotes. A quick Web search gave this possible solution:
sys.stderr.write(what.encode('ascii', 'replace') + '\n')
It says that if a non-ASCII Unicode character appears, replace it with something in ASCII—an equivalent, or at least something printable.
Replacing line 8 with that yields this output:
% ./fix1.py TMP/content.xml depth=5: Turn all these depth=6: "straight" depth=5: quotes into ?nice? quotes %
So the curly quotes were replaced with ? characters, which is fine for our debugging output. Note that the text doesn't necessarily all come at the same depth in the tree.
The document's structure also can be seen by typing the full filename of the content.xml file into a Firefox window (Figure 7). That's good for displaying the data; the point, however, is to change it!
Free DevOps eBooks, Videos, and more!
Regardless of where you are in your DevOps process, Linux Journal can help!
We offer here the DEFINITIVE DevOps for Dummies, a mobile Application Development Primer, and advice & help from the expert sources like:
- Linux Journal
- Be a Mechanic...with Android and Linux!
- New Products
- Users, Permissions and Multitenant Sites
- Flexible Access Control with Squid Proxy
- Security in Three Ds: Detect, Decide and Deny
- High-Availability Storage with HA-LVM
- Tighten Up SSH
- DevOps: Everything You Need to Know
- Solving ODEs on Linux
- Non-Linux FOSS: MenuMeters