Python – How to add hyperlinks to images in python-docx

I added an image using python docx. Now, I want to add a hyperlink. How to do this?

import io
import urllib
from docx import Document
from docx.shared import Inches

document = Document()
p = document.add_paragraph()
r = p.add_run()
url = r'http://www.example.com/a.jpg'
io_url = io. BytesIO(urllib.request.urlopen(url).read())
r.add_picture(io_url)
#TODO: add a hyperlink 'http://mywebsite.com' to r
document.save('example.docx')

Thank you so much.

The docx library doesn’t seem to have implemented the ability to add hyperlinks to documentation yet, but describes a workaround in their GitHub ticket.

This is link discussion and specific code snippets that you can use to add hyperlinks. You can even assign a color to your hyperlink or underline it. I won’t copy and paste the code here, it’s all thanks to the people involved in the extensive discussion.

The following code example (This workaround is credited to johanvandegriff on GitHub.) )

import docx

def add_hyperlink(paragraph, url, text, color, underline):
    """
    A function that places a hyperlink within a paragraph object.

:param paragraph: The paragraph we are adding the hyperlink to.
    :param url: A string containing the required url
    :param text: The text displayed for the url
    :return: The hyperlink object
    """

# This gets access to the document.xml.rels file and gets a new relation id value
    part = paragraph.part
    r_id = part.relate_to(url, docx.opc.constants.RELATIONSHIP_TYPE. HYPERLINK, is_external=True)

# Create the w:hyperlink tag and add needed values
    hyperlink = docx.oxml.shared.OxmlElement('w:hyperlink')
    hyperlink.set(docx.oxml.shared.qn('r:id'), r_id, )

# Create a w:r element
    new_run = docx.oxml.shared.OxmlElement('w:r')

# Create a new w:rPr element
    rPr = docx.oxml.shared.OxmlElement('w:rPr')

# Add color if it is given
    if not color is None:
      c = docx.oxml.shared.OxmlElement('w:color')
      c.set(docx.oxml.shared.qn('w:val'), color)
      rPr.append(c)

# Remove underlining if it is requested
    if not underline:
      u = docx.oxml.shared.OxmlElement('w:u')
      u.set(docx.oxml.shared.qn('w:val'), 'none')
      rPr.append(u)

# Join all the xml elements together add add the required text to the w:r element
    new_run.append(rPr)
    new_run.text = text
    hyperlink.append(new_run)

paragraph._p.append(hyperlink)

return hyperlink

document = docx. Document()
p = document.add_paragraph()

#add a hyperlink with the normal formatting (blue underline)
hyperlink = add_hyperlink(p, 'http://www.google.com', 'Google', None, True)

#add a hyperlink with a custom color and no underline
hyperlink = add_hyperlink(p, 'http://www.google.com', 'Google', 'FF8822', False)

document.save('demo.docx')