tbl: add _Cell.paragraphs

Steve Canny · Steve Canny · commit ee184a8f63a5 · 2013-12-22T18:03:51.000-08:00
diff --git a/docs/dev/analysis/features/table.rst b/docs/dev/analysis/features/table.rst
@@ -284,6 +284,48 @@ Schema Definitions
     </xsd:choice>
   </xsd:group>
 
+::
+
+    w_CT_Tc =
+      attribute w:id { s_ST_String }?,
+      element tcPr { w_CT_TcPr }?,
+      w_EG_BlockLevelElts+
+
+    w_EG_BlockLevelElts =  # denormalized
+      element customXml { w_CT_CustomXmlBlock }
+      | element p { w_CT_P }
+      | element sdt { w_CT_SdtBlock }
+      | element tbl { w_CT_Tbl }
+      | element altChunk { w_CT_AltChunk }
+
+      | element proofErr { w_CT_ProofErr }
+      | element permStart { w_CT_PermStart }
+      | element permEnd { w_CT_Perm }
+      | element ins { w_CT_RunTrackChange }
+      | element del { w_CT_RunTrackChange }
+      | element moveFrom { w_CT_RunTrackChange }
+      | element moveTo { w_CT_RunTrackChange }
+
+      | element bookmarkStart { w_CT_Bookmark }
+      | element bookmarkEnd { w_CT_MarkupRange }
+      | element moveFromRangeStart { w_CT_MoveBookmark }
+      | element moveFromRangeEnd { w_CT_MarkupRange }
+      | element moveToRangeStart { w_CT_MoveBookmark }
+      | element moveToRangeEnd { w_CT_MarkupRange }
+      | element commentRangeStart { w_CT_MarkupRange }
+      | element commentRangeEnd { w_CT_MarkupRange }
+      | element customXmlInsRangeStart { w_CT_TrackChange }
+      | element customXmlInsRangeEnd { w_CT_Markup }
+      | element customXmlDelRangeStart { w_CT_TrackChange }
+      | element customXmlDelRangeEnd { w_CT_Markup }
+      | element customXmlMoveFromRangeStart { w_CT_TrackChange }
+      | element customXmlMoveFromRangeEnd { w_CT_Markup }
+      | element customXmlMoveToRangeStart { w_CT_TrackChange }
+      | element customXmlMoveToRangeEnd { w_CT_Markup }
+
+      | element oMathPara { m_CT_OMathPara }
+      | element oMath { m_CT_OMath }
+
 
 Resources
 ---------
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -23,9 +23,10 @@ class ValidationError(Exception):
 register_custom_element_class('w:body', CT_Body)
 register_custom_element_class('w:document', CT_Document)
 
-from docx.oxml.table import CT_Row, CT_Tbl, CT_TblGrid
+from docx.oxml.table import CT_Row, CT_Tbl, CT_TblGrid, CT_Tc
 register_custom_element_class('w:tbl', CT_Tbl)
 register_custom_element_class('w:tblGrid', CT_TblGrid)
+register_custom_element_class('w:tc', CT_Tc)
 register_custom_element_class('w:tr', CT_Row)
 
 from docx.oxml.text import CT_P, CT_PPr, CT_R, CT_String, CT_Text
diff --git a/docx/oxml/table.py b/docx/oxml/table.py
@@ -185,3 +185,10 @@ def new(cls):
         p = CT_P.new()
         tc.append(p)
         return tc
+
+    @property
+    def p_lst(self):
+        """
+        List of <w:p> child elements.
+        """
+        return self.findall(qn('w:p'))
diff --git a/docx/table.py b/docx/table.py
@@ -7,6 +7,7 @@
 from __future__ import absolute_import, print_function, unicode_literals
 
 from .shared import lazyproperty
+from .text import Paragraph
 
 
 class Table(object):
@@ -42,6 +43,10 @@ def __init__(self, tc):
         super(_Cell, self).__init__()
         self._tc = tc
 
+    @property
+    def paragraphs(self):
+        return [Paragraph(p) for p in self._tc.p_lst]
+
 
 class _Column(object):
     """
diff --git a/tests/test_table.py b/tests/test_table.py
@@ -12,6 +12,7 @@
     _Cell, _Column, _ColumnCellCollection, _ColumnCollection, _Row,
     _RowCellCollection, _RowCollection, Table
 )
+from docx.text import Paragraph
 
 from .oxml.unitdata.table import a_gridCol, a_tbl, a_tblGrid, a_tc, a_tr
 from .oxml.unitdata.text import a_p
@@ -45,6 +46,29 @@ def table(self):
         return table
 
 
+class Describe_Cell(object):
+
+    def it_provides_access_to_the_paragraphs_it_contains(
+            self, cell_with_paragraphs):
+        cell = cell_with_paragraphs
+        paragraphs = cell.paragraphs
+        assert len(paragraphs) == 2
+        for p in paragraphs:
+            assert isinstance(p, Paragraph)
+
+    # fixtures -------------------------------------------------------
+
+    @pytest.fixture
+    def cell_with_paragraphs(self):
+        tc = (
+            a_tc().with_nsdecls()
+                  .with_child(a_p())
+                  .with_child(a_p())
+                  .element
+        )
+        return _Cell(tc)
+
+
 class Describe_Column(object):
 
     def it_provides_access_to_the_column_cells(self, column):
