If you ever had a need to programmatically examine the text in a Microsoft Word document, getting the text out in the first place can be challenging. Sure, you can manually save your document to a plain text file that’s much easier to process, but if you have multiple documents to examine, that can be painful.
Recently I had such a need and found this Toward Data Science article quite helpful. But let’s take the challenge a little further: suppose you had a document with multiple sections and need to pull the text from specific sections.
Let’s suppose I need to pull just the text from the “sub-sections”. In my example, I have three sub-sections: Sub-Section 1, Sub-Section 2, and Sub-Section 3. In my Word document, I’ve styled these headers as “Heading 2” text. Here’s how I went about pull out the text for each of these sections.
Step 1: Import your packages
For my needs, I only need to import zipfile and ElementTree, which is nice as I didn’t need to install any third party packages:
import zipfile
import xml.etree.ElementTree as ET
Step 2: Parse the document XML
doc = zipfile.ZipFile('./data/test.docx').read('word/document.xml')
root = ET.fromstring(doc)
Step 3: Explore the XML for the sections and text you want
You’ll spend most of your time here, trying to figure out what elements hold the contents in which you are interested. The XML of Microsoft documents follows the WordprocessingML standard, which can be quite complicated. I spent a lot of time manually reviewing my XML looking for the elements I needed. You can write out the XML like so:
ET.tostring(root)
Step 4: Find all the paragraphs
To solve my problem, I first decided to pull together a collection of all the paragraphs in the document so that I could later iterate across them and make decisions. To make that work a little easier, I also declared a namespace object used by Microsoft’s WordprocessingML standard:
# Microsoft's XML makes heavy use of XML namespaces; thus, we'll need to reference that in our code
ns = {'w': 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'}
body = root.find('w:body', ns) # find the XML "body" tag
p_sections = body.findall('w:p', ns) # under the body tag, find all the paragraph sections
It can be helpful to actually see the text in each of these sections. Through researching Microsoft’s XML standard, I know that document text is usually contained in “t” elements. So, if I write an XPath query to find all the “t” elements within a given section, I can join the text of all those elements together to get the full text of the paragraph. This code does that:
for p in p_sections:
text_elems = p.findall('.//w:t', ns)
print(''.join([t.text for t in text_elems]))
print()
Step 5: Find all the “Heading 2” sections
Now, let’s iterate through each paragraph section and see if we can figure out which sections have been styled with “Heading 2”. If we can find those Heading 2 sections, we’ll then know that the subsequent text is the text we need.
Through researching more the XML standard, I found that if I search for pStyle elements that contain the value “Heading2”, these will be the sections I’m after. To make my code a little cleaner, I wrote functions to both evaluate each section for the Heading 2 style and extract the full text of the section:
def is_heading2_section(p):
"""Returns True if the given paragraph section has been styled as a Heading2"""
return_val = False
heading_style_elem = p.find(".//w:pStyle[@w:val='Heading2']", ns)
if heading_style_elem is not None:
return_val = True
return return_val
def get_section_text(p):
"""Returns the joined text of the text elements under the given paragraph tag"""
return_val = ''
text_elems = p.findall('.//w:t', ns)
if text_elems is not None:
return_val = ''.join([t.text for t in text_elems])
return return_val
section_labels = [get_section_text(s) if is_heading2_section(s) else '' for s in p_sections]
Now, if I print out my section_labels list, I see this:
Step 6: Finally, extract the Heading 2 headers and subsequent text
Now, I can use simple list comprehension to glue together both the section headers and associated text of the three sub-sections I’m after:
section_text = [{'title': t, 'text': get_section_text(p_sections[i+1])} for i, t in enumerate(section_labels) if len(t) > 0]
And that list looks like this:
You can download my code here.
Recent Comments