Initial work on Headers (python-openxml#104)

brianjinwright · brianjinwright · commit a9176b3f5adc · 2015-08-21T12:21:25.000-04:00
diff --git a/docx/__init__.py b/docx/__init__.py
@@ -15,7 +15,7 @@
 from docx.parts.image import ImagePart
 from docx.parts.numbering import NumberingPart
 from docx.parts.styles import StylesPart
-
+from docx.parts.section import HeaderPart,FooterPart
 
 def part_class_selector(content_type, reltype):
     if reltype == RT.IMAGE:
@@ -28,7 +28,8 @@ def part_class_selector(content_type, reltype):
 PartFactory.part_type_for[CT.WML_DOCUMENT_MAIN] = DocumentPart
 PartFactory.part_type_for[CT.WML_NUMBERING] = NumberingPart
 PartFactory.part_type_for[CT.WML_STYLES] = StylesPart
-
+PartFactory.part_type_for[CT.WML_HEADER] = HeaderPart
+PartFactory.part_type_for[CT.WML_FOOTER] = FooterPart
 del (
     CT, CorePropertiesPart, DocumentPart, NumberingPart, PartFactory,
     StylesPart, part_class_selector
diff --git a/docx/document.py b/docx/document.py
@@ -28,6 +28,9 @@ def __init__(self, element, part):
         self._part = part
         self.__body = None
 
+    def add_header(self,text='',header_type='first'):
+        return
+
     def add_heading(self, text='', level=1):
         """
         Return a heading paragraph newly added to the end of the document,
diff --git a/docx/parts/header.py b/docx/parts/header.py
@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+"""
+Provides HeaderPart and related objects
+"""
+
+from __future__ import (
+    absolute_import, division, print_function, unicode_literals
+)
+
+from ..opc.part import XmlPart
+from ..oxml.shared import oxml_fromstring
+from ..shared import lazyproperty
+
+
+class HeaderPart(XmlPart):
+    """
+    Proxy for the styles.xml part containing style definitions for a document
+    or glossary.
+    """
+    def __init__(self, partname, content_type, element, package):
+        super(HeaderPart, self).__init__(
+            partname, content_type, element=element, package=package
+        )
+
+    @classmethod
+    def load(cls, partname, content_type, blob, package):
+        """
+        Provides PartFactory interface for loading a styles part from a WML
+        package.
+        """
+        styles_elm = oxml_fromstring(blob)
+        return cls(partname, content_type, styles_elm, package)
+
+
+    @classmethod
+    def new(cls):
+        """
+        Return newly created empty header part, containing only the root
+        ``<w:???>`` element.
+        """
+        raise NotImplementedError
+
+    @lazyproperty
+    def header(self):
+        """
+        The |_Header| instance containing the header (<w:???> element
+        proxies) for this header part.
+        """
+        return _Header(self._element)
+
+
+class _Header(object):
+    """
+    FIX THIS >>> Collection of |_Header| instances corresponding to the ``<w:???>``
+    elements in a header part.
+    """
+    def __init__(self, header_elm):
+        super(_Header, self).__init__()
+        self._header_elm = header_elm
+
+    def __len__(self):
+        return len(self._styles_elm.header_lst)
diff --git a/docx/parts/section.py b/docx/parts/section.py
@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+"""
+Provides HeaderPart and related objects
+"""
+
+from __future__ import (
+    absolute_import, division, print_function, unicode_literals
+)
+
+from ..opc.part import XmlPart
+from ..shared import lazyproperty
+from docx.blkcntnr import BlockItemContainer
+
+
+class HeaderPart(XmlPart):
+    """
+    Proxy for the styles.xml part containing style definitions for a document
+    or glossary.
+    """
+
+    @lazyproperty
+    def header(self):
+        """
+        The |_Header| instance containing the header (<w:???> element
+        proxies) for this header part.
+        """
+        return _Header(self._element, self)
+
+
+class FooterPart(XmlPart):
+    """"""
+
+    @lazyproperty
+    def footer(self):
+        """"""
+        return _Footer(self._element, self)
+
+
+class _Header(BlockItemContainer):
+    def __init__(self, header_elm, parent):
+        super(_Header, self).__init__(header_elm, parent)
+        self._header_elm = header_elm
+
+
+class _Footer(BlockItemContainer):
+    def __init__(self, footer_elm, parent):
+        super(_Footer, self).__init__(footer_elm, parent)
+        self._footer_elm = footer_elm
