hyperlink testing

Author: Benjamin-T

docx/oxml/__init__.py

@@ -206,13 +206,13 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:tabs',            CT_TabStops)
 register_element_cls('w:widowControl',    CT_OnOff)
 
-from .text.run import CT_Br, CT_R, CT_Text, CT_SimpleField, CT_FldChar
+from .text.run import CT_Br, CT_R, CT_Text, CT_SimpleField, CT_FldChar, CT_Hyperlink
 register_element_cls('w:br', CT_Br)
 register_element_cls('w:r',  CT_R)
 register_element_cls('w:t',  CT_Text)
 register_element_cls('w:fldSimple',  CT_SimpleField)
 register_element_cls('w:fldChar',  CT_FldChar)
-
+register_element_cls('w:hyperlink', CT_Hyperlink)
 
 from docx.oxml.bookmark import CT_Bookmark, CT_MarkupRange  # noqa
 register_element_cls('w:bookmarkEnd', CT_MarkupRange)

docx/oxml/text/run.py

@@ -7,7 +7,11 @@
 from ..ns import qn
 from ..simpletypes import ST_BrClear, ST_BrType, ST_OnOff, ST_String, ST_FldCharType
 from ..xmlchemy import (
-    BaseOxmlElement, OptionalAttribute, ZeroOrMore, ZeroOrOne, RequiredAttribute
+    BaseOxmlElement,
+    OptionalAttribute,
+    ZeroOrMore,
+    ZeroOrOne,
+    RequiredAttribute,
 )
 from docx.oxml import OxmlElement
 from docx.enum.fields import WD_FIELDCODE
@@ -17,48 +21,71 @@ class CT_SimpleField(BaseOxmlElement):
     """
     `<w:fldSimple>` element, indicating a simple field character.
     """
+
     instr = RequiredAttribute("w:instr", ST_String)
-    fldLock = OptionalAttribute('w:fldLock', ST_OnOff)
-    dirty = OptionalAttribute('w:dirty', ST_OnOff)
+    fldLock = OptionalAttribute("w:fldLock", ST_OnOff)
+    dirty = OptionalAttribute("w:dirty", ST_OnOff)
 
     def set_field(self, field_name, properties):
         if getattr(WD_FIELDCODE, field_name):
-            self.instr = field_name + ' ' + properties
+            self.instr = field_name + " " + properties
+
 
 class CT_FldChar(BaseOxmlElement):
     """
     `<w:fldChar>` element, indicating a simple field character.
     """
+
     fldCharType = RequiredAttribute("w:fldCharType", ST_FldCharType)
     instrText = RequiredAttribute("w:instrText", ST_String)
-    fldLock = OptionalAttribute('w:fldLock', ST_OnOff)
-    dirty = OptionalAttribute('w:dirty', ST_OnOff)
+    fldLock = OptionalAttribute("w:fldLock", ST_OnOff)
+    dirty = OptionalAttribute("w:dirty", ST_OnOff)
 
     def set_field(self, codes):
         self.instrText = code
 
+
+class CT_Hyperlink(BaseOxmlElement):
+    """`w:hyperlink` element"""
+
+    anchor = RequiredAttribute("w:anchor", ST_String)
+
+
+    def set_anchor(self, bookmark):
+        self.anchor = bookmark
+
+    def set_hyperlink_text(self, text):
+        new_r = OxmlElement('w:r')
+        new_r.style = "Hyperlink"
+        new_r.text = text
+        self.insert(0, new_r)
+
+
 class CT_Br(BaseOxmlElement):
     """
     ``<w:br>`` element, indicating a line, page, or column break in a run.
     """
-    type = OptionalAttribute('w:type', ST_BrType)
-    clear = OptionalAttribute('w:clear', ST_BrClear)
+
+    type = OptionalAttribute("w:type", ST_BrType)
+    clear = OptionalAttribute("w:clear", ST_BrClear)
 
 
 class CT_R(BaseOxmlElement):
     """
     ``<w:r>`` element, containing the properties and text for a run.
     """
+
     bookmarkStart = ZeroOrMore("w:bookmarkStart")
     bookmarkEnd = ZeroOrMore("w:bookmarkEnd")
-    rPr = ZeroOrOne('w:rPr')
-    t = ZeroOrMore('w:t')
-    br = ZeroOrMore('w:br')
-    cr = ZeroOrMore('w:cr')
-    tab = ZeroOrMore('w:tab')
-    drawing = ZeroOrMore('w:drawing')
-    fldsimple = ZeroOrMore('w:fldSimple')
-    fldChar = ZeroOrMore('w:fldChar')
+    rPr = ZeroOrOne("w:rPr")
+    t = ZeroOrMore("w:t")
+    br = ZeroOrMore("w:br")
+    cr = ZeroOrMore("w:cr")
+    tab = ZeroOrMore("w:tab")
+    drawing = ZeroOrMore("w:drawing")
+    fldsimple = ZeroOrMore("w:fldSimple")
+    fldChar = ZeroOrMore("w:fldChar")
+    hyperlink = ZeroOrMore("w:hyperlink")
 
     def _insert_rPr(self, rPr):
         self.insert(0, rPr)
@@ -70,7 +97,7 @@ def add_t(self, text):
         """
         t = self._add_t(text=text)
         if len(text.strip()) < len(text):
-            t.set(qn('xml:space'), 'preserve')
+            t.set(qn("xml:space"), "preserve")
         return t
 
     def add_drawing(self, inline_or_anchor):
@@ -117,15 +144,15 @@ def text(self):
         child elements like ``<w:tab/>`` translated to their Python
         equivalent.
         """
-        text = ''
+        text = ""
         for child in self:
-            if child.tag == qn('w:t'):
+            if child.tag == qn("w:t"):
                 t_text = child.text
-                text += t_text if t_text is not None else ''
-            elif child.tag == qn('w:tab'):
-                text += '\t'
-            elif child.tag in (qn('w:br'), qn('w:cr')):
-                text += '\n'
+                text += t_text if t_text is not None else ""
+            elif child.tag == qn("w:tab"):
+                text += "\t"
+            elif child.tag in (qn("w:br"), qn("w:cr")):
+                text += "\n"
         return text
 
     @text.setter
@@ -149,6 +176,7 @@ class _RunContentAppender(object):
     appended. Likewise a newline or carriage return character ('\n', '\r')
     causes a ``<w:cr>`` element to be appended.
     """
+
     def __init__(self, r):
         self._r = r
         self._bfr = []
@@ -180,17 +208,17 @@ def add_char(self, char):
         which must be called at the end of text to ensure any pending
         ``<w:t>`` element is written.
         """
-        if char == '\t':
+        if char == "\t":
             self.flush()
             self._r.add_tab()
-        elif char in '\r\n':
+        elif char in "\r\n":
             self.flush()
             self._r.add_br()
         else:
             self._bfr.append(char)
 
     def flush(self):
-        text = ''.join(self._bfr)
+        text = "".join(self._bfr)
         if text:
             self._r.add_t(text)
         del self._bfr[:]

docx/text/run.py

@@ -30,6 +30,11 @@ def add_field(self, field_name, properties):
         fld.set_field(field_name, properties)
         return fld
 
+    def add_hyperlink(self, bookmark_name):
+        hyp = self._r.add_hyperlink()
+        hyp.set_anchor(bookmark_name)
+        return hyp
+
     def add_break(self, break_type=WD_BREAK.LINE):
         """
         Add a break element of *break_type* to this run. *break_type* can