oxml: extract qn() to docx.oxml.ns

Steve Canny · Steve Canny · commit 06ebca383a42 · 2014-06-15T03:00:53.000-07:00
diff --git a/docx/oxml/ns.py b/docx/oxml/ns.py
@@ -87,3 +87,14 @@ def nspfxmap(*nspfxs):
     namespaces('a', 'r', 'p').
     """
     return dict((pfx, nsmap[pfx]) for pfx in nspfxs)
+
+
+def qn(tag):
+    """
+    Stands for "qualified name", a utility function to turn a namespace
+    prefixed tag name into a Clark-notation qualified tag name for lxml. For
+    example, ``qn('p:cSld')`` returns ``'{http://schemas.../main}cSld'``.
+    """
+    prefix, tagroot = tag.split(':')
+    uri = nsmap[prefix]
+    return '{%s}%s' % (uri, tagroot)
diff --git a/docx/oxml/parts/document.py b/docx/oxml/parts/document.py
@@ -5,9 +5,10 @@
 <w:document>.
 """
 
-from docx.oxml.shared import OxmlBaseElement, qn
-from docx.oxml.table import CT_Tbl
-from docx.oxml.text import CT_P
+from ..ns import qn
+from ..shared import OxmlBaseElement
+from ..table import CT_Tbl
+from ..text import CT_P
 
 
 class CT_Document(OxmlBaseElement):
diff --git a/docx/oxml/parts/numbering.py b/docx/oxml/parts/numbering.py
@@ -4,8 +4,8 @@
 Custom element classes related to the numbering part
 """
 
-from ..shared import CT_DecimalNumber, OxmlBaseElement, OxmlElement, qn
-from ..ns import nsmap
+from ..shared import CT_DecimalNumber, OxmlBaseElement, OxmlElement
+from ..ns import nsmap, qn
 
 
 class CT_Num(OxmlBaseElement):
diff --git a/docx/oxml/parts/styles.py b/docx/oxml/parts/styles.py
@@ -4,8 +4,8 @@
 Custom element classes related to the styles part
 """
 
-from ..shared import OxmlBaseElement, qn
-from ..ns import nsmap
+from ..shared import OxmlBaseElement
+from ..ns import nsmap, qn
 
 
 class CT_Style(OxmlBaseElement):
diff --git a/docx/oxml/shape.py b/docx/oxml/shape.py
@@ -4,9 +4,9 @@
 Custom element classes for shape-related elements like ``<w:inline>``
 """
 
-from .shared import OxmlBaseElement, OxmlElement, qn
+from .shared import OxmlBaseElement, OxmlElement
 from ..shared import Emu
-from .ns import nsmap, nspfxmap
+from .ns import nsmap, nspfxmap, qn
 
 
 class CT_Blip(OxmlBaseElement):
diff --git a/docx/oxml/shared.py b/docx/oxml/shared.py
@@ -12,7 +12,7 @@
 
 from . import oxml_parser
 from .exceptions import ValidationError
-from .ns import NamespacePrefixedTag, nsmap
+from .ns import NamespacePrefixedTag, nsmap, qn
 
 
 # ===========================================================================
@@ -42,17 +42,6 @@ def oxml_fromstring(text):
     return etree.fromstring(text, oxml_parser)
 
 
-def qn(tag):
-    """
-    Stands for "qualified name", a utility function to turn a namespace
-    prefixed tag name into a Clark-notation qualified tag name for lxml. For
-    example, ``qn('p:cSld')`` returns ``'{http://schemas.../main}cSld'``.
-    """
-    prefix, tagroot = tag.split(':')
-    uri = nsmap[prefix]
-    return '{%s}%s' % (uri, tagroot)
-
-
 def serialize_for_reading(element):
     """
     Serialize *element* to human-readable XML suitable for tests. No XML
diff --git a/docx/oxml/table.py b/docx/oxml/table.py
@@ -6,10 +6,9 @@
 
 from __future__ import absolute_import, print_function, unicode_literals
 
-from docx.oxml.shared import OxmlBaseElement, OxmlElement, qn
-
 from .exceptions import ValidationError
-from .shared import CT_String
+from .ns import qn
+from .shared import CT_String, OxmlBaseElement, OxmlElement
 from .text import CT_P
 
 
diff --git a/docx/oxml/text.py b/docx/oxml/text.py
@@ -6,11 +6,9 @@
 """
 
 from ..enum.text import WD_UNDERLINE
-from .ns import nsdecls
+from .ns import nsdecls, qn
 from .parts.numbering import CT_NumPr
-from .shared import (
-    CT_String, OxmlBaseElement, OxmlElement, oxml_fromstring, qn
-)
+from .shared import CT_String, OxmlBaseElement, OxmlElement, oxml_fromstring
 
 
 class CT_Br(OxmlBaseElement):
diff --git a/features/steps/text.py b/features/steps/text.py
@@ -10,7 +10,7 @@
 
 from docx import Document
 from docx.enum.text import WD_BREAK, WD_UNDERLINE
-from docx.oxml.shared import qn
+from docx.oxml.ns import qn
 
 from helpers import test_docx, test_text
 
