fix: issue #60, some reformatting

Steve Canny · Steve Canny · commit 6ba94ff602cf · 2014-02-06T02:01:37.000-08:00
diff --git a/docx.py b/docx.py
@@ -1,5 +1,5 @@
-#!/usr/bin/env python2.6
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 """
 Open and modify Microsoft Word 2007 docx files (called 'OpenXML' and
 'Office OpenXML' by Microsoft)
@@ -104,7 +104,7 @@ def makeelement(tagname, tagtext=None, nsprefix='w', attributes=None,
         # FIXME: rest of code below expects a single prefix
         nsprefix = nsprefix[0]
     if nsprefix:
-        namespace = '{'+nsprefixes[nsprefix]+'}'
+        namespace = '{%s}' % nsprefixes[nsprefix]
     else:
         # For when namespace = None
         namespace = ''
@@ -485,12 +485,13 @@ def picture(
     image = Image.open(picpath)
 
     # Extract EXIF data, if available
-    imageExif = {}
     try:
         exif = image._getexif()
+        exif = {} if exif is None else exif
     except:
         exif = {}
 
+    imageExif = {}
     for tag, value in exif.items():
         imageExif[TAGS.get(tag, tag)] = value
 
@@ -1069,12 +1070,14 @@ def savedocx(
     os.chdir(template_dir)
 
     # Serialize our trees into out zip file
-    treesandfiles = {document:     'word/document.xml',
-                     coreprops:    'docProps/core.xml',
-                     appprops:     'docProps/app.xml',
-                     contenttypes: '[Content_Types].xml',
-                     websettings:  'word/webSettings.xml',
-                     wordrelationships: 'word/_rels/document.xml.rels'}
+    treesandfiles = {
+        document:          'word/document.xml',
+        coreprops:         'docProps/core.xml',
+        appprops:          'docProps/app.xml',
+        contenttypes:      '[Content_Types].xml',
+        websettings:       'word/webSettings.xml',
+        wordrelationships: 'word/_rels/document.xml.rels'
+    }
     for tree in treesandfiles:
         log.info('Saving: %s' % treesandfiles[tree])
         treestring = etree.tostring(tree, pretty_print=True)
diff --git a/setup.py b/setup.py
@@ -18,7 +18,7 @@
 
 setup(
     name='docx',
-    version='0.2.3',
+    version='0.2.4',
     install_requires=['lxml', 'Pillow>=2.0'],
     description=DESCRIPTION,
     author='Mike MacCana',
diff --git a/tests/test_docx.py b/tests/test_docx.py
@@ -1,46 +1,69 @@
-#!/usr/bin/env python2.6
-'''
+#!/usr/bin/env python
+
+"""
 Test docx module
-'''
+"""
+
 import os
 import lxml
-from docx import *
+from docx import (
+    appproperties, contenttypes, coreproperties, getdocumenttext, heading,
+    makeelement, newdocument, nsprefixes, opendocx, pagebreak, paragraph,
+    picture, relationshiplist, replace, savedocx, search, table, websettings,
+    wordrelationships
+)
 
 TEST_FILE = 'ShortTest.docx'
 IMAGE1_FILE = 'image1.png'
 
+
 # --- Setup & Support Functions ---
 def setup_module():
-    '''Set up test fixtures'''
+    """Set up test fixtures"""
     import shutil
     if IMAGE1_FILE not in os.listdir('.'):
-        shutil.copyfile(os.path.join(os.path.pardir,IMAGE1_FILE), IMAGE1_FILE)
+        shutil.copyfile(os.path.join(os.path.pardir, IMAGE1_FILE), IMAGE1_FILE)
     testnewdocument()
 
+
 def teardown_module():
-    '''Tear down test fixtures'''
+    """Tear down test fixtures"""
     if TEST_FILE in os.listdir('.'):
         os.remove(TEST_FILE)
 
+
 def simpledoc(noimagecopy=False):
-    '''Make a docx (document, relationships) for use in other docx tests'''
+    """Make a docx (document, relationships) for use in other docx tests"""
     relationships = relationshiplist()
     imagefiledict = {}
     document = newdocument()
     docbody = document.xpath('/w:document/w:body', namespaces=nsprefixes)[0]
-    docbody.append(heading('Heading 1',1)  )   
-    docbody.append(heading('Heading 2',2))
+    docbody.append(heading('Heading 1', 1))
+    docbody.append(heading('Heading 2', 2))
     docbody.append(paragraph('Paragraph 1'))
-    for point in ['List Item 1','List Item 2','List Item 3']:
-        docbody.append(paragraph(point,style='ListNumber'))
+    for point in ['List Item 1', 'List Item 2', 'List Item 3']:
+        docbody.append(paragraph(point, style='ListNumber'))
     docbody.append(pagebreak(type='page'))
-    docbody.append(paragraph('Paragraph 2')) 
-    docbody.append(table([['A1','A2','A3'],['B1','B2','B3'],['C1','C2','C3']]))
+    docbody.append(paragraph('Paragraph 2'))
+    docbody.append(
+        table(
+            [
+                ['A1', 'A2', 'A3'],
+                ['B1', 'B2', 'B3'],
+                ['C1', 'C2', 'C3']
+            ]
+        )
+    )
     docbody.append(pagebreak(type='section', orient='portrait'))
     if noimagecopy:
-        relationships,picpara,imagefiledict = picture(relationships,IMAGE1_FILE,'This is a test description', imagefiledict=imagefiledict)
+        relationships, picpara, imagefiledict = picture(
+            relationships, IMAGE1_FILE, 'This is a test description',
+            imagefiledict=imagefiledict
+        )
     else:
-        relationships,picpara = picture(relationships,IMAGE1_FILE,'This is a test description')
+        relationships, picpara = picture(
+            relationships, IMAGE1_FILE, 'This is a test description'
+        )
     docbody.append(picpara)
     docbody.append(pagebreak(type='section', orient='landscape'))
     docbody.append(paragraph('Paragraph 3'))
@@ -52,72 +75,117 @@ def simpledoc(noimagecopy=False):
 
 # --- Test Functions ---
 def testsearchandreplace():
-    '''Ensure search and replace functions work'''
+    """Ensure search and replace functions work"""
     document, docbody, relationships = simpledoc()
     docbody = document.xpath('/w:document/w:body', namespaces=nsprefixes)[0]
     assert search(docbody, 'ing 1')
     assert search(docbody, 'ing 2')
     assert search(docbody, 'graph 3')
     assert search(docbody, 'ist Item')
     assert search(docbody, 'A1')
-    if search(docbody, 'Paragraph 2'): 
-        docbody = replace(docbody,'Paragraph 2','Whacko 55') 
+    if search(docbody, 'Paragraph 2'):
+        docbody = replace(docbody, 'Paragraph 2', 'Whacko 55')
     assert search(docbody, 'Whacko 55')
 
+
 def testtextextraction():
-    '''Ensure text can be pulled out of a document'''
+    """Ensure text can be pulled out of a document"""
     document = opendocx(TEST_FILE)
     paratextlist = getdocumenttext(document)
     assert len(paratextlist) > 0
 
+
 def testunsupportedpagebreak():
-    '''Ensure unsupported page break types are trapped'''
+    """Ensure unsupported page break types are trapped"""
     document = newdocument()
     docbody = document.xpath('/w:document/w:body', namespaces=nsprefixes)[0]
     try:
         docbody.append(pagebreak(type='unsup'))
     except ValueError:
-        return # passed
-    assert False # failed
+        return  # passed
+    assert False  # failed
+
 
 def testnewdocument():
-    '''Test that a new document can be created'''
+    """Test that a new document can be created"""
     document, docbody, relationships = simpledoc()
-    coreprops = coreproperties('Python docx testnewdocument','A short example of making docx from Python','Alan Brooks',['python','Office Open XML','Word'])
-    savedocx(document, coreprops, appproperties(), contenttypes(), websettings(), wordrelationships(relationships), TEST_FILE)
+    coreprops = coreproperties(
+        'Python docx testnewdocument',
+        'A short example of making docx from Python', 'Alan Brooks',
+        ['python', 'Office Open XML', 'Word']
+    )
+    savedocx(
+        document, coreprops, appproperties(), contenttypes(), websettings(),
+        wordrelationships(relationships), TEST_FILE
+    )
+
 
 def testnewdocument_noimagecopy():
-    '''Test that a new document can be created'''
-    document, docbody, relationships, imagefiledict = simpledoc(noimagecopy=True)
-    coreprops = coreproperties('Python docx testnewdocument','A short example of making docx from Python','Alan Brooks',['python','Office Open XML','Word'])
-    savedocx(document, coreprops, appproperties(), contenttypes(), websettings(), wordrelationships(relationships), TEST_FILE, imagefiledict=imagefiledict)
+    """
+    Test that a new document can be created
+    """
+    document, docbody, relationships, imagefiledict = simpledoc(
+        noimagecopy=True
+    )
+    coreprops = coreproperties(
+        'Python docx testnewdocument',
+        'A short example of making docx from Python', 'Alan Brooks',
+        ['python', 'Office Open XML', 'Word']
+    )
+    savedocx(
+        document, coreprops, appproperties(), contenttypes(), websettings(),
+        wordrelationships(relationships), TEST_FILE,
+        imagefiledict=imagefiledict
+    )
+
 
 def testopendocx():
-    '''Ensure an etree element is returned'''
-    if isinstance(opendocx(TEST_FILE),lxml.etree._Element):
+    """Ensure an etree element is returned"""
+    if isinstance(opendocx(TEST_FILE), lxml.etree._Element):
         pass
     else:
         assert False
 
+
 def testmakeelement():
-    '''Ensure custom elements get created'''
-    testelement = makeelement('testname',attributes={'testattribute':'testvalue'},tagtext='testtagtext')
-    assert testelement.tag == '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}testname'
-    assert testelement.attrib == {'{http://schemas.openxmlformats.org/wordprocessingml/2006/main}testattribute': 'testvalue'}
+    """Ensure custom elements get created"""
+    testelement = makeelement(
+        'testname',
+        attributes={'testattribute': 'testvalue'},
+        tagtext='testtagtext'
+    )
+    assert testelement.tag == (
+        '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}testn'
+        'ame'
+    )
+    assert testelement.attrib == {
+        '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}testa'
+        'ttribute': 'testvalue'
+    }
     assert testelement.text == 'testtagtext'
 
+
 def testparagraph():
-    '''Ensure paragraph creates p elements'''
-    testpara = paragraph('paratext',style='BodyText')
-    assert testpara.tag == '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}p'
+    """Ensure paragraph creates p elements"""
+    testpara = paragraph('paratext', style='BodyText')
+    assert testpara.tag == (
+        '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}p'
+    )
     pass
-    
+
+
 def testtable():
-    '''Ensure tables make sense'''
-    testtable = table([['A1','A2'],['B1','B2'],['C1','C2']])
-    ns = '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}'
-    assert testtable.xpath('/ns0:tbl/ns0:tr[2]/ns0:tc[2]/ns0:p/ns0:r/ns0:t',namespaces={'ns0':'http://schemas.openxmlformats.org/wordprocessingml/2006/main'})[0].text == 'B2'
+    """Ensure tables make sense"""
+    testtable = table([['A1', 'A2'], ['B1', 'B2'], ['C1', 'C2']])
+    assert (
+        testtable.xpath(
+            '/ns0:tbl/ns0:tr[2]/ns0:tc[2]/ns0:p/ns0:r/ns0:t',
+            namespaces={'ns0': ('http://schemas.openxmlformats.org/wordproce'
+                                'ssingml/2006/main')}
+        )[0].text == 'B2'
+    )
+
 
-if __name__=='__main__':
+if __name__ == '__main__':
     import nose
     nose.main()
