oxml: add unit tests for OxmlElement

Steve Canny · Steve Canny · commit df464f4e8f01 · 2014-06-15T14:59:00.000-07:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -40,18 +40,23 @@ def register_element_cls(tag, cls):
     namespace[tagroot] = cls
 
 
-def OxmlElement(nsptag_str, attrs=None, nsmap=None):
+def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
     """
     Return a 'loose' lxml element having the tag specified by *nsptag_str*.
     *nsptag_str* must contain the standard namespace prefix, e.g. 'a:tbl'.
     The resulting element is an instance of the custom element class for this
     tag name if one is defined. A dictionary of attribute values may be
-    provided as *attrs*; they are set if present.
+    provided as *attrs*; they are set if present. All namespaces defined in
+    the dict *nsdecls* are declared in the element using the key as the
+    prefix and the value as the namespace name. If *nsdecls* is not provided,
+    a single namespace declaration is added based on the prefix on
+    *nsptag_str*.
     """
     nsptag = NamespacePrefixedTag(nsptag_str)
-    _nsmap = nsptag.nsmap if nsmap is None else nsmap
+    if nsdecls is None:
+        nsdecls = nsptag.nsmap
     return oxml_parser.makeelement(
-        nsptag.clark_name, attrib=attrs, nsmap=_nsmap
+        nsptag.clark_name, attrib=attrs, nsmap=nsdecls
     )
 
 
diff --git a/docx/oxml/shape.py b/docx/oxml/shape.py
@@ -102,7 +102,7 @@ def new(cls, cx, cy, shape_id, pic):
         name = 'Picture %d' % shape_id
         uri = nsmap['pic']
 
-        inline = OxmlElement('wp:inline', nsmap=nspfxmap('wp', 'r'))
+        inline = OxmlElement('wp:inline', nsdecls=nspfxmap('wp', 'r'))
         inline.append(CT_PositiveSize2D.new('wp:extent', cx, cy))
         inline.append(CT_NonVisualDrawingProps.new(
             'wp:docPr', shape_id, name
@@ -149,7 +149,7 @@ def new(cls, pic_id, filename, rId, cx, cy):
         contents required to define a viable picture element, based on the
         values passed as parameters.
         """
-        pic = OxmlElement('pic:pic', nsmap=nspfxmap('pic', 'r'))
+        pic = OxmlElement('pic:pic', nsdecls=nspfxmap('pic', 'r'))
         pic.append(CT_PictureNonVisual.new(pic_id, filename))
         pic.append(CT_BlipFillProperties.new(rId))
         pic.append(CT_ShapeProperties.new(cx, cy))
diff --git a/tests/oxml/test__init__.py b/tests/oxml/test__init__.py
@@ -10,11 +10,42 @@
 
 from lxml import etree
 
-from docx.oxml import oxml_parser, parse_xml, register_element_cls
+from docx.oxml import (
+    OxmlElement, oxml_parser, parse_xml, register_element_cls
+)
 from docx.oxml.ns import qn
 from docx.oxml.shared import OxmlBaseElement
 
 
+class DescribeOxmlElement(object):
+
+    def it_returns_an_lxml_element_with_matching_tag_name(self):
+        element = OxmlElement('a:foo')
+        assert isinstance(element, etree._Element)
+        assert element.tag == (
+            '{http://schemas.openxmlformats.org/drawingml/2006/main}foo'
+        )
+
+    def it_adds_supplied_attributes(self):
+        element = OxmlElement('a:foo', {'a': 'b', 'c': 'd'})
+        assert etree.tostring(element) == (
+            '<a:foo xmlns:a="http://schemas.openxmlformats.org/drawingml/200'
+            '6/main" a="b" c="d"/>'
+        )
+
+    def it_adds_additional_namespace_declarations_when_supplied(self):
+        element = OxmlElement(
+            'a:foo', nsdecls={
+                'a': 'http://schemas.openxmlformats.org/drawingml/2006/main',
+                'x': 'other'
+            }
+        )
+        assert etree.tostring(element) == (
+            '<a:foo xmlns:a="http://schemas.openxmlformats.org/drawingml/200'
+            '6/main" xmlns:x="other"/>'
+        )
+
+
 class DescribeOxmlParser(object):
 
     def it_strips_whitespace_between_elements(self, whitespace_fixture):
