oxml: add CT_P.new()

Steve Canny · Steve Canny · commit c924d2a3e045 · 2013-12-20T20:10:44.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -11,3 +11,13 @@
 Initializes oxml sub-package, including registering custom element classes
 corresponding to Open XML elements.
 """
+
+from docx.oxml.base import register_custom_element_class
+from docx.oxml.text import CT_P
+
+
+# ===========================================================================
+# custom element class mappings
+# ===========================================================================
+
+register_custom_element_class('w:p',        CT_P)
diff --git a/docx/oxml/text.py b/docx/oxml/text.py
@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+#
+# oxml/text.py
+#
+# Copyright (C) 2013 Steve Canny scanny@cisco.com
+#
+# This module is part of python-docx and is released under the MIT License:
+# http://www.opensource.org/licenses/mit-license.php
+
+"""
+Custom element classes related to text, such as paragraph (CT_P) and runs
+(CT_R).
+"""
+
+from docx.oxml.base import nsdecls, OxmlBaseElement, oxml_fromstring
+
+
+class CT_P(OxmlBaseElement):
+    """
+    ``<w:p>`` element, containing the properties and text for a paragraph.
+    """
+    @staticmethod
+    def new():
+        """
+        Return a new ``<w:p>`` element.
+        """
+        xml = '<w:p %s/>' % nsdecls('w')
+        p = oxml_fromstring(xml)
+        return p
diff --git a/tests/oxml/__init__.py b/tests/oxml/__init__.py
diff --git a/tests/oxml/test_text.py b/tests/oxml/test_text.py
@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+#
+# test_text.py
+#
+# Copyright (C) 2013 Steve Canny scanny@cisco.com
+#
+# This module is part of python-docx and is released under the MIT License:
+# http://www.opensource.org/licenses/mit-license.php
+
+"""Test suite for the docx.oxml.text module."""
+
+from docx.oxml.text import CT_P
+
+from ..unitdata import a_p
+
+
+class DescribeCT_P(object):
+
+    def it_can_construct_a_new_p_element(self):
+        p = CT_P.new()
+        expected_xml = a_p().with_nsdecls().xml
+        assert p.xml == expected_xml
diff --git a/tests/unitdata.py b/tests/unitdata.py
@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+#
+# unitdata.py
+#
+# Copyright (C) 2013 Steve Canny scanny@cisco.com
+#
+# This module is part of python-opc and is released under the MIT License:
+# http://www.opensource.org/licenses/mit-license.php
+
+"""Test data builders for unit tests"""
+
+from docx.oxml.base import nsdecls, oxml_fromstring
+
+
+class BaseBuilder(object):
+    """
+    Provides common behavior for all data builders.
+    """
+    nsdecls = ' %s' % nsdecls('w')
+
+    def __init__(self):
+        """Establish instance variables with default values"""
+        self._empty = False
+        self._indent = 0
+        self._nsdecls = ''
+
+    @property
+    def element(self):
+        """Return element based on XML generated by builder"""
+        return oxml_fromstring(self.xml)
+
+    @property
+    def is_empty(self):
+        return True
+
+    def with_indent(self, indent):
+        """Add integer *indent* spaces at beginning of element XML"""
+        self._indent = indent
+        return self
+
+    def with_nsdecls(self):
+        self._nsdecls = self.nsdecls
+        return self
+
+
+class CT_PBuilder(BaseBuilder):
+    """
+    Test data builder for a CT_P (<w:p>) XML element that appears within the
+    body element of a document.xml file.
+    """
+    def __init__(self):
+        """Establish instance variables with default values"""
+        super(CT_PBuilder, self).__init__()
+
+    @property
+    def xml(self):
+        """Return element XML based on attribute settings"""
+        indent = ' ' * self._indent
+        xml = '%s<w:p%s/>\n' % (indent, self._nsdecls)
+        return xml
+
+
+def a_p():
+    """Return a CT_PBuilder instance"""
+    return CT_PBuilder()
