shp: add InlineShapes.__len__()

Steve Canny · Steve Canny · commit c376fb9fc0c3 · 2013-12-24T22:27:48.000-08:00
Along the way:

* transplant NamespacePrefixedTag from python-pptx into temporary
location
* rewrite OxmlElement to only provide namespaces required for that
element
diff --git a/docx/oxml/shared.py b/docx/oxml/shared.py
@@ -8,7 +8,9 @@
 
 
 nsmap = {
-    'w': 'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
+    'w':  ('http://schemas.openxmlformats.org/wordprocessingml/2006/main'),
+    'wp': ('http://schemas.openxmlformats.org/drawingml/2006/wordprocessingD'
+           'rawing'),
 }
 
 # configure XML parser
@@ -25,12 +27,74 @@
 #     return oxml_parser.makeelement(qn(tag), nsmap=nsmap)
 
 
+class NamespacePrefixedTag(str):
+    """
+    Value object that knows the semantics of an XML tag having a namespace
+    prefix.
+    """
+    def __new__(cls, nstag, *args):
+        return super(NamespacePrefixedTag, cls).__new__(cls, nstag)
+
+    def __init__(self, nstag):
+        self._pfx, self._local_part = nstag.split(':')
+        self._ns_uri = nsmap[self._pfx]
+
+    @property
+    def clark_name(self):
+        return '{%s}%s' % (self._ns_uri, self._local_part)
+
+    @property
+    def local_part(self):
+        """
+        Return the local part of the tag as a string. E.g. 'foobar' is
+        returned for tag 'f:foobar'.
+        """
+        return self._local_part
+
+    @property
+    def nsmap(self):
+        """
+        Return a dict having a single member, mapping the namespace prefix of
+        this tag to it's namespace name (e.g. {'f': 'http://foo/bar'}). This
+        is handy for passing to xpath calls and other uses.
+        """
+        return {self._pfx: self._ns_uri}
+
+    @property
+    def nspfx(self):
+        """
+        Return the string namespace prefix for the tag, e.g. 'f' is returned
+        for tag 'f:foobar'.
+        """
+        return self._pfx
+
+    @property
+    def nsuri(self):
+        """
+        Return the namespace URI for the tag, e.g. 'http://foo/bar' would be
+        returned for tag 'f:foobar' if the 'f' prefix maps to
+        'http://foo/bar' in nsmap.
+        """
+        return self._ns_uri
+
+
 def nsdecls(*prefixes):
     return ' '.join(['xmlns:%s="%s"' % (pfx, nsmap[pfx]) for pfx in prefixes])
 
 
-def OxmlElement(tag, attrs=None):
-    return oxml_parser.makeelement(qn(tag), attrib=attrs, nsmap=nsmap)
+def OxmlElement(nsptag_str, attrs=None, nsmap=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.
+    """
+    nsptag = NamespacePrefixedTag(nsptag_str)
+    nsmap = nsmap if nsmap is not None else nsptag.nsmap
+    return oxml_parser.makeelement(
+        nsptag.clark_name, attrib=attrs, nsmap=nsmap
+    )
 
 
 def oxml_fromstring(text):
diff --git a/docx/parts.py b/docx/parts.py
@@ -6,7 +6,7 @@
 
 from docx.opc.oxml import serialize_part_xml
 from docx.opc.package import Part
-from docx.oxml.shared import oxml_fromstring
+from docx.oxml.shared import nsmap, oxml_fromstring
 from docx.shared import lazyproperty
 from docx.table import Table
 from docx.text import Paragraph
@@ -114,3 +114,9 @@ class InlineShapes(object):
     def __init__(self, body_elm):
         super(InlineShapes, self).__init__()
         self._body = body_elm
+
+    def __len__(self):
+        body = self._body
+        xpath = './w:p/w:r/w:drawing/wp:inline'
+        inline_elms = body.xpath(xpath, namespaces=nsmap)
+        return len(inline_elms)
diff --git a/features/shp-inline-shape-access.feature b/features/shp-inline-shape-access.feature
@@ -3,7 +3,6 @@ Feature: Access inline shapes in document
   As an python-docx developer
   I need the ability to access the inline shapes in a document
 
-  @wip
   Scenario: Access inline shapes collection of document
      Given a document containing two inline shapes
       Then I can access the inline shape collection of the document
diff --git a/tests/oxml/unitdata/dml.py b/tests/oxml/unitdata/dml.py
@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+"""
+Test data builders for text XML elements
+"""
+
+from ...unitdata import BaseBuilder
+
+
+class CT_DrawingBuilder(BaseBuilder):
+    __tag__ = 'w:drawing'
+    __nspfxs__ = ('w',)
+    __attrs__ = ()
+
+
+def a_drawing():
+    return CT_DrawingBuilder()
+
+
+class CT_InlineBuilder(BaseBuilder):
+    __tag__ = 'wp:inline'
+    __nspfxs__ = ('wp',)
+    __attrs__ = ('distT', 'distB', 'distL', 'distR')
+
+
+def an_inline():
+    return CT_InlineBuilder()
diff --git a/tests/test_parts.py b/tests/test_parts.py
@@ -11,15 +11,16 @@
 from mock import Mock
 
 from docx.oxml.parts import CT_Document
-from docx.parts import _Body, _Document
+from docx.parts import _Body, _Document, InlineShapes
 from docx.table import Table
 from docx.text import Paragraph
 
+from .oxml.unitdata.dml import a_drawing, an_inline
 from .oxml.unitdata.parts import a_body, a_document
 from .oxml.unitdata.table import (
     a_gridCol, a_tbl, a_tblGrid, a_tblPr, a_tc, a_tr
 )
-from .oxml.unitdata.text import a_p, a_sectPr
+from .oxml.unitdata.text import a_p, a_sectPr, an_r
 from .unitutil import (
     function_mock, class_mock, initializer_mock, instance_mock
 )
@@ -253,3 +254,33 @@ def _tr_bldr(self, cols):
             tc_bldr = self._tc_bldr()
             tr_bldr.with_child(tc_bldr)
         return tr_bldr
+
+
+class DescribeInlineShapes(object):
+
+    def it_knows_how_many_inline_shapes_it_contains(
+            self, inline_shapes_fixture):
+        inline_shapes, inline_shape_count = inline_shapes_fixture
+        print(inline_shapes._body.xml)
+        assert len(inline_shapes) == inline_shape_count
+
+    # fixtures -------------------------------------------------------
+
+    @pytest.fixture
+    def inline_shapes_fixture(self):
+        inline_shape_count = 2
+        body = (
+            a_body().with_nsdecls('w', 'wp').with_child(
+                a_p().with_child(
+                    an_r().with_child(
+                        a_drawing().with_child(
+                            an_inline()))).with_child(
+                    an_r().with_child(
+                        a_drawing().with_child(
+                            an_inline())
+                    )
+                )
+            )
+        ).element
+        inline_shapes = InlineShapes(body)
+        return inline_shapes, inline_shape_count
