wrap headers/footers in semantic elements, refactor visit_document

Author: Tom Keefe

mammoth/conversion.py

@@ -95,28 +95,13 @@ def visit_image(self, image, context):
             return []
 
     def visit_document(self, document, context):
+        headers = self.visit_headers(document.headers, context)
         nodes = self._visit_all(document.children, context)
+        notes_list = self.visit_notes(document.notes, context)
+        comments = self.visit_comments(context)
+        footers = self.visit_footers(document.footers, context)
 
-        headers = []
-        footers = []
-
-        if self._include_headers_and_footers:
-            headers = self.visit_headers(document.headers, context)
-            footers = self.visit_footers(document.footers, context)
-
-        notes = [
-            document.notes.resolve(reference)
-            for reference in self._note_references
-        ]
-        notes_list = html.element("ol", {}, self._visit_all(notes, context))
-        
-        comments = html.element("dl", {}, [
-            html_node
-            for referenced_comment in self._referenced_comments
-            for html_node in self.visit_comment(referenced_comment, context)
-        ])
-
-        return headers + nodes + [notes_list, comments] + footers
+        return headers +  nodes + [notes_list, comments] + footers
 
 
     def visit_paragraph(self, paragraph, context):
@@ -282,6 +267,12 @@ def visit_note(self, note, context):
             html.element("li", {"id": self._note_html_id(note)}, note_body)
         ]
 
+    def visit_notes(self, notes, context):
+        resolved_notes = [
+            notes.resolve(reference)
+            for reference in self._note_references
+        ]
+        return html.element("ol", {}, self._visit_all(resolved_notes, context))
 
     def visit_comment_reference(self, reference, context):
         def nodes():
@@ -325,18 +316,31 @@ def visit_comment(self, referenced_comment, context):
             html.element("dd", {}, body),
         ]
 
+    def visit_comments(self, context):
+        return html.element("dl", {}, [
+            html_node
+            for referenced_comment in self._referenced_comments
+            for html_node in self.visit_comment(referenced_comment, context)
+        ])
+
     def visit_header(self, header, context):
         return self._visit_all(header.children, context)
 
     def visit_headers(self, headers, context):
+        if not self._include_headers_and_footers:
+            return []
+
         all_headers = [
             html_node
             for h in headers
             for html_node in self.visit_header(h, context)
         ]
 
         if not self._deduplicate_headers_and_footers:
-            return all_headers
+            return [
+                html.element("header", {}, [h])
+                for h in headers
+            ]
 
         header_values = set()
         filtered_headers = []
@@ -345,29 +349,41 @@ def visit_headers(self, headers, context):
                 filtered_headers.append(h)
                 header_values.add(h.to_text())
 
-        return filtered_headers
+        return [
+            html.element("header", {}, [f])
+            for f in filtered_headers
+        ]
 
     def visit_footer(self, footer, context):
         return self._visit_all(footer.children, context)
 
     def visit_footers(self, footers, context):
+        if not self._include_headers_and_footers:
+            return []
+
         all_footers = [
             html_node
             for f in footers
             for html_node in self.visit_footer(f, context)
         ]
 
         if not self._deduplicate_headers_and_footers:
-            return all_footers
+            return [
+                html.element("footer", {}, [f])
+                for f in all_footers
+            ]
 
         footer_values = set()
         filtered_footers = []
         for h in all_footers:
             if not h.to_text() in footer_values:
                 filtered_footers.append(h)
                 footer_values.add(h.to_text())
-
-        return filtered_footers
+        
+        return [
+            html.element("footer", {}, [f])
+            for f in filtered_footers
+        ]
 
     def _visit_all(self, elements, context):
         return [

mammoth/results.py

@@ -33,10 +33,11 @@ def combine(results):
     for result in results:
         if isinstance(result, list):
             values.append([r.value for r in result])
+            for r in result:
+                messages.extend(r.messages)
         else:
             values.append(result.value)
-            for message in result.messages:
-                messages.append(message)
+            messages.extend(result.messages)
 
     return Result(values, messages)