forked from python-openxml/python-docx
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathns.py
More file actions
114 lines (94 loc) · 3.56 KB
/
ns.py
File metadata and controls
114 lines (94 loc) · 3.56 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# encoding: utf-8
"""
Namespace-related objects.
"""
from __future__ import absolute_import, print_function, unicode_literals
nsmap = {
'a': ('http://schemas.openxmlformats.org/drawingml/2006/main'),
'c': ('http://schemas.openxmlformats.org/drawingml/2006/chart'),
'cp': ('http://schemas.openxmlformats.org/package/2006/metadata/core-pr'
'operties'),
'dc': ('http://purl.org/dc/elements/1.1/'),
'dcmitype': ('http://purl.org/dc/dcmitype/'),
'dcterms': ('http://purl.org/dc/terms/'),
'dgm': ('http://schemas.openxmlformats.org/drawingml/2006/diagram'),
'pic': ('http://schemas.openxmlformats.org/drawingml/2006/picture'),
'r': ('http://schemas.openxmlformats.org/officeDocument/2006/relations'
'hips'),
'w': ('http://schemas.openxmlformats.org/wordprocessingml/2006/main'),
'wp': ('http://schemas.openxmlformats.org/drawingml/2006/wordprocessing'
'Drawing'),
'xml': ('http://www.w3.org/XML/1998/namespace'),
'xsi': ('http://www.w3.org/2001/XMLSchema-instance'),
}
pfxmap = dict((value, key) for key, value in nsmap.items())
class NamespacePrefixedTag(str):
"""
Value object that knows the semantics of an XML tag having a namespace
prefix.
"""
def __new__(cls, nstag, *args):
return super(NamespacePrefixedTag, cls).__new__(cls, nstag)
def __init__(self, nstag):
self._pfx, self._local_part = nstag.split(':')
self._ns_uri = nsmap[self._pfx]
@property
def clark_name(self):
return '{%s}%s' % (self._ns_uri, self._local_part)
@classmethod
def from_clark_name(cls, clark_name):
nsuri, local_name = clark_name[1:].split('}')
nstag = '%s:%s' % (pfxmap[nsuri], local_name)
return cls(nstag)
@property
def local_part(self):
"""
Return the local part of the tag as a string. E.g. 'foobar' is
returned for tag 'f:foobar'.
"""
return self._local_part
@property
def nsmap(self):
"""
Return a dict having a single member, mapping the namespace prefix of
this tag to it's namespace name (e.g. {'f': 'http://foo/bar'}). This
is handy for passing to xpath calls and other uses.
"""
return {self._pfx: self._ns_uri}
@property
def nspfx(self):
"""
Return the string namespace prefix for the tag, e.g. 'f' is returned
for tag 'f:foobar'.
"""
return self._pfx
@property
def nsuri(self):
"""
Return the namespace URI for the tag, e.g. 'http://foo/bar' would be
returned for tag 'f:foobar' if the 'f' prefix maps to
'http://foo/bar' in nsmap.
"""
return self._ns_uri
def nsdecls(*prefixes):
"""
Return a string containing a namespace declaration for each of the
namespace prefix strings, e.g. 'p', 'ct', passed as *prefixes*.
"""
return ' '.join(['xmlns:%s="%s"' % (pfx, nsmap[pfx]) for pfx in prefixes])
def nspfxmap(*nspfxs):
"""
Return a dict containing the subset namespace prefix mappings specified by
*nspfxs*. Any number of namespace prefixes can be supplied, e.g.
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)