Skip to content

Instantly share code, notes, and snippets.

@phillipkent
Created April 17, 2019 12:27
Show Gist options
  • Save phillipkent/708887c3d165f869c24b2d5befb29b9a to your computer and use it in GitHub Desktop.
Save phillipkent/708887c3d165f869c24b2d5befb29b9a to your computer and use it in GitHub Desktop.
Python code using the python-docx module to convert a DOCX file to HTML
# Converts a docx file with tables and images to (simple) HTML
# ORIGINAL CODE BY DAVID SSALI AT SOURCE: https://medium.com/@dvdssali/docx-to-html-1374eb6491a1
#
# Requires the Python module 'python-docx' <https://python-docx.readthedocs.io>
#
# Example use:
# >>> s = convert('./SOURCEDIR', 'SAMPLE.docx')
# >>> print(s)
# or
# $ python .\convert-docx-to-html.py > temp.html
from docx import Document
from docx.document import Document as _Document
from docx.oxml.text.paragraph import CT_P
from docx.oxml.table import CT_Tbl
from docx.table import _Cell, Table
from docx.text.paragraph import Paragraph
import xml.etree.ElementTree as ET
import time
import re
import os
def convert(dir_path,file):
##dir_path = "./SOURCEDIR"
##file = "SAMPLE.docx"
# image_path will be a directory to store image files; if the directory does not exist it will be created
splitname = re.split('[. ]', file)
if len(splitname) > 2:
image_path= ''.join(splitname[:2]) + '-images'
else:
image_path= splitname[0] + '-images'
if not os.path.isdir(image_path):
os.mkdir(image_path)
document = Document(dir_path + '/' + file)
body = ""
list_items = []
for block in iter_block_items(document):
if isinstance(block, Paragraph):
tmp_heading_type = get_heading_type(block)
if re.match("List\sParagraph",tmp_heading_type):
list_items.append("<li>" + block.text + "</li>")
else:
images = render_image(document,block,image_path,image_path)
if len(list_items) > 0:
body += render_list_items(list_items)
list_items = []
if len(images) > 0:
body = body + images
else:
# modified to use a different outer_tag if a 'Heading' style is found in the original paragraph
if 'Heading' in tmp_heading_type:
outer_tag = 'h'+tmp_heading_type.split(' ')[-1]
else:
outer_tag = 'p'
body = body + render_runs(block.runs, outer_tag)
elif isinstance(block, Table):
body += render_table(block,document,image_path)
return body
def iter_block_items(parent):
"""
Generate a reference to each paragraph and table child within *parent*,
in document order. Each returned value is an instance of either Table or
Paragraph. *parent* would most commonly be a reference to a main
Document object, but also works for a _Cell object, which itself can
contain paragraphs and tables.
"""
if isinstance(parent, _Document):
parent_elm = parent.element.body
elif isinstance(parent, _Cell):
parent_elm = parent._tc
else:
raise ValueError("something's not right")
for child in parent_elm.iterchildren():
if isinstance(child, CT_P):
yield Paragraph(child, parent)
elif isinstance(child, CT_Tbl):
yield Table(child, parent)
def table_print(block):
table = block
for row in table.rows:
for cell in row.cells:
for paragraph in cell.paragraphs:
print(paragraph.text,' ',end='')
print("\n")
# Modified to treat cell content as a set of blocks to process
def render_table(block,document,image_path):
table = block
html = "<table class='table table-bordered' border='1'>"
for row in table.rows:
html += "<tr>"
for cell in row.cells:
html += "<td>"
# ---
cbody = ""
clist_items = []
for cblock in iter_block_items(cell):
if isinstance(cblock, Paragraph):
tmp_heading_type = get_heading_type(cblock)
if re.match("List\sParagraph",tmp_heading_type):
clist_items.append("<li>" + block.text + "</li>")
else:
images = render_image(document,cblock,image_path,image_path)
if len(clist_items) > 0:
cbody += render_list_items(clist_items)
clist_items = []
if len(images) > 0:
cbody = cbody + images
else:
cbody = cbody + render_runs(cblock.runs)
elif isinstance(cblock, Table):
cbody += render_table(cblock)
html += cbody + " "
html += "</td>"
html += "</tr>"
html += "</table>"
return html
# Modified to use a different outer_tag if a 'Heading' style is found in the original paragraph
def render_runs(runs, outer_tag='p'):
html = "<" + outer_tag + ">"
for run in runs:
html = html + run.text
html += "</" + outer_tag + ">"
return html
def render_list_items(items):
html = "<ul>"
for item in items:
html += item
html += "</ul>"
return html
def get_heading_type(block):
return block.style.name
def render_image(document,par,dir_path,book_id):
"""get all of the images in a paragraph
:param par: a paragraph object from docx
:return: a list of r:embed
"""
ids = []
root = ET.fromstring(par._p.xml)
namespace = {
'a':"http://schemas.openxmlformats.org/drawingml/2006/main", \
'r':"http://schemas.openxmlformats.org/officeDocument/2006/relationships", \
'wp':"http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing"}
inlines = root.findall('.//wp:inline',namespace)
for inline in inlines:
imgs = inline.findall('.//a:blip', namespace)
for img in imgs:
id = img.attrib['{{{0}}}embed'.format(namespace['r'])]
ids.append(id)
inlines = root.findall('.//wp:anchor',namespace)
for inline in inlines:
imgs = inline.findall('.//a:blip', namespace)
for img in imgs:
id = img.attrib['{{{0}}}embed'.format(namespace['r'])]
ids.append(id)
response = ""
if len(ids) > 0:
for id in ids:
image_part = document.part.related_parts[id]
millis = int(round(time.time() * 1000))
file_name = str(id) + "-" + str(book_id) + "-" + str(millis) + ".png"
fr = open(dir_path + "/" + file_name, "wb")
fr.write(image_part._blob)
fr.close()
response += "<img border='1' src='" + dir_path + "/" + file_name + "' class='img-responsive'/>"
return response
if __name__ == '__main__':
s = convert('./SOURCEDIR', 'SAMPLE.docx')
print(s)
@stefan-hock20
Copy link

Hi Phillip
thx for the code.
Unfortunately I got an error message when running the code:
cbody += render_table(cblock)
TypeError: render_table() missing 2 required positional arguments: 'document' and 'image_path'

when I change the line from
cbody += render_table(cblock) --> cbody += render_table(cblock, document, image_path)

no more errors but I don't get the images extracted. I copied and pasted a image into the Word document and it is ignored.
Any help would be appreciated.
Stefan

@dsunjka
Copy link

dsunjka commented Apr 14, 2020

FYI - I also had an error, but a different one - needed to change a line in "render_table" to look like this:

clist_items.append("<li>" + cblock.text + "</li>")

(changed "block" to "cblock", then it worked).

After that change, the code works and exports all the images and produces a nice HTML. Thank you!

@kharade-navin
Copy link

kharade-navin commented Jul 3, 2024

Thanks for the code. I was able to execute it and can create the html file, however the output html file is blank. Any suggestions? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment