root / ncclient / content.py @ 614a698d
History | View | Annotate | Download (6.5 kB)
1 | 94dd4342 | Shikhar Bhushan | # Copyright 2009 Shikhar Bhushan
|
---|---|---|---|
2 | 94dd4342 | Shikhar Bhushan | #
|
3 | 94dd4342 | Shikhar Bhushan | # Licensed under the Apache License, Version 2.0 (the "License");
|
4 | 94dd4342 | Shikhar Bhushan | # you may not use this file except in compliance with the License.
|
5 | 94dd4342 | Shikhar Bhushan | # You may obtain a copy of the License at
|
6 | 94dd4342 | Shikhar Bhushan | #
|
7 | 94dd4342 | Shikhar Bhushan | # http://www.apache.org/licenses/LICENSE-2.0
|
8 | 94dd4342 | Shikhar Bhushan | #
|
9 | 94dd4342 | Shikhar Bhushan | # Unless required by applicable law or agreed to in writing, software
|
10 | 94dd4342 | Shikhar Bhushan | # distributed under the License is distributed on an "AS IS" BASIS,
|
11 | 94dd4342 | Shikhar Bhushan | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12 | 94dd4342 | Shikhar Bhushan | # See the License for the specific language governing permissions and
|
13 | 94dd4342 | Shikhar Bhushan | # limitations under the License.
|
14 | 94dd4342 | Shikhar Bhushan | |
15 | 4de03d63 | Shikhar Bhushan | from cStringIO import StringIO |
16 | 94dd4342 | Shikhar Bhushan | from xml.etree import cElementTree as ET |
17 | 94dd4342 | Shikhar Bhushan | |
18 | ebf2bbc6 | Shikhar Bhushan | from ncclient import NCClientError |
19 | ebf2bbc6 | Shikhar Bhushan | |
20 | a14c36f9 | Shikhar Bhushan | class ContentError(NCClientError): |
21 | 614a698d | Shikhar Bhushan | "Raised by methods of the :mod:`content` module in case of an error."
|
22 | a14c36f9 | Shikhar Bhushan | pass
|
23 | bf31e33e | Shikhar Bhushan | |
24 | 65c6a607 | Shikhar Bhushan | ### Namespace-related
|
25 | 94dd4342 | Shikhar Bhushan | |
26 | 614a698d | Shikhar Bhushan | # : Base NETCONf namespace
|
27 | 94dd4342 | Shikhar Bhushan | BASE_NS = 'urn:ietf:params:xml:ns:netconf:base:1.0'
|
28 | 614a698d | Shikhar Bhushan | # : ... and this is BASE_NS according to Cisco devices tested
|
29 | 94dd4342 | Shikhar Bhushan | CISCO_BS = 'urn:ietf:params:netconf:base:1.0'
|
30 | 94dd4342 | Shikhar Bhushan | |
31 | 94dd4342 | Shikhar Bhushan | try:
|
32 | 94dd4342 | Shikhar Bhushan | register_namespace = ET.register_namespace |
33 | 94dd4342 | Shikhar Bhushan | except AttributeError: |
34 | 94dd4342 | Shikhar Bhushan | def register_namespace(prefix, uri): |
35 | 94dd4342 | Shikhar Bhushan | from xml.etree import ElementTree |
36 | 94dd4342 | Shikhar Bhushan | # cElementTree uses ElementTree's _namespace_map, so that's ok
|
37 | 94dd4342 | Shikhar Bhushan | ElementTree._namespace_map[uri] = prefix |
38 | 94dd4342 | Shikhar Bhushan | |
39 | e91a5349 | Shikhar Bhushan | # we'd like BASE_NS to be prefixed as "netconf"
|
40 | 94dd4342 | Shikhar Bhushan | register_namespace('netconf', BASE_NS)
|
41 | 94dd4342 | Shikhar Bhushan | |
42 | 65c6a607 | Shikhar Bhushan | qualify = lambda tag, ns=BASE_NS: tag if ns is None else '{%s}%s' % (ns, tag) |
43 | bf31e33e | Shikhar Bhushan | |
44 | 0cdb8b3c | Shikhar Bhushan | # deprecated
|
45 | 65c6a607 | Shikhar Bhushan | multiqualify = lambda tag, nslist=(BASE_NS, CISCO_BS): [qualify(tag, ns) for ns in nslist] |
46 | 94dd4342 | Shikhar Bhushan | |
47 | 94dd4342 | Shikhar Bhushan | unqualify = lambda tag: tag[tag.rfind('}')+1:] |
48 | 94dd4342 | Shikhar Bhushan | |
49 | 65c6a607 | Shikhar Bhushan | ### XML with Python data structures
|
50 | 65c6a607 | Shikhar Bhushan | |
51 | 65c6a607 | Shikhar Bhushan | class DictTree: |
52 | 65c6a607 | Shikhar Bhushan | |
53 | 65c6a607 | Shikhar Bhushan | @staticmethod
|
54 | 65c6a607 | Shikhar Bhushan | def Element(spec): |
55 | 614a698d | Shikhar Bhushan | """DictTree -> Element
|
56 | 614a698d | Shikhar Bhushan |
|
57 | 614a698d | Shikhar Bhushan | :type spec: :obj:`dict` or :obj:`string` or :class:`~xml.etree.ElementTree.Element`
|
58 | 614a698d | Shikhar Bhushan | :rtype: :class:`~xml.etree.ElementTree.Element`
|
59 | 614a698d | Shikhar Bhushan | """
|
60 | 65c6a607 | Shikhar Bhushan | if iselement(spec):
|
61 | 65c6a607 | Shikhar Bhushan | return spec
|
62 | 65c6a607 | Shikhar Bhushan | elif isinstance(spec, basestring): |
63 | 65c6a607 | Shikhar Bhushan | return XML.Element(spec)
|
64 | 65c6a607 | Shikhar Bhushan | if not isinstance(spec, dict): |
65 | 65c6a607 | Shikhar Bhushan | raise ContentError("Invalid tree spec") |
66 | 65c6a607 | Shikhar Bhushan | if 'tag' in spec: |
67 | 65c6a607 | Shikhar Bhushan | ele = ET.Element(spec.get('tag'), spec.get('attributes', {})) |
68 | 65c6a607 | Shikhar Bhushan | ele.text = spec.get('text', '') |
69 | 65c6a607 | Shikhar Bhushan | ele.tail = spec.get('tail', '') |
70 | 65c6a607 | Shikhar Bhushan | subtree = spec.get('subtree', [])
|
71 | 65c6a607 | Shikhar Bhushan | # might not be properly specified as list but may be dict
|
72 | 65c6a607 | Shikhar Bhushan | if isinstance(subtree, dict): |
73 | 65c6a607 | Shikhar Bhushan | subtree = [subtree] |
74 | 65c6a607 | Shikhar Bhushan | for subele in subtree: |
75 | 65c6a607 | Shikhar Bhushan | ele.append(DictTree.Element(subele)) |
76 | 65c6a607 | Shikhar Bhushan | return ele
|
77 | 65c6a607 | Shikhar Bhushan | elif 'comment' in spec: |
78 | 65c6a607 | Shikhar Bhushan | return ET.Comment(spec.get('comment')) |
79 | 65c6a607 | Shikhar Bhushan | else:
|
80 | 65c6a607 | Shikhar Bhushan | raise ContentError('Invalid tree spec') |
81 | 65c6a607 | Shikhar Bhushan | |
82 | 65c6a607 | Shikhar Bhushan | @staticmethod
|
83 | 0cdb8b3c | Shikhar Bhushan | def XML(spec, encoding='UTF-8'): |
84 | 614a698d | Shikhar Bhushan | """DictTree -> XML
|
85 | 614a698d | Shikhar Bhushan |
|
86 | 614a698d | Shikhar Bhushan | :type spec: :obj:`dict` or :obj:`string` or :class:`~xml.etree.ElementTree.Element`
|
87 | 614a698d | Shikhar Bhushan | :arg encoding: chraracter encoding
|
88 | 614a698d | Shikhar Bhushan | :rtype: string
|
89 | 614a698d | Shikhar Bhushan | """
|
90 | e52e8478 | Shikhar Bhushan | return Element.XML(DictTree.Element(spec), encoding)
|
91 | 65c6a607 | Shikhar Bhushan | |
92 | 65c6a607 | Shikhar Bhushan | class Element: |
93 | 65c6a607 | Shikhar Bhushan | |
94 | 65c6a607 | Shikhar Bhushan | @staticmethod
|
95 | 65c6a607 | Shikhar Bhushan | def DictTree(ele): |
96 | 614a698d | Shikhar Bhushan | """DictTree -> Element
|
97 | 614a698d | Shikhar Bhushan |
|
98 | 614a698d | Shikhar Bhushan | :type spec: :class:`~xml.etree.ElementTree.Element`
|
99 | 614a698d | Shikhar Bhushan | :rtype: :obj:`dict`
|
100 | 614a698d | Shikhar Bhushan | """
|
101 | 65c6a607 | Shikhar Bhushan | return {
|
102 | 65c6a607 | Shikhar Bhushan | 'tag': ele.tag,
|
103 | 65c6a607 | Shikhar Bhushan | 'attributes': ele.attrib,
|
104 | 65c6a607 | Shikhar Bhushan | 'text': ele.text,
|
105 | 65c6a607 | Shikhar Bhushan | 'tail': ele.tail,
|
106 | 65c6a607 | Shikhar Bhushan | 'subtree': [ Element.DictTree(child) for child in root.getchildren() ] |
107 | 65c6a607 | Shikhar Bhushan | } |
108 | 65c6a607 | Shikhar Bhushan | |
109 | 65c6a607 | Shikhar Bhushan | @staticmethod
|
110 | 0cdb8b3c | Shikhar Bhushan | def XML(ele, encoding='UTF-8'): |
111 | 614a698d | Shikhar Bhushan | """Element -> XML
|
112 | 614a698d | Shikhar Bhushan |
|
113 | 614a698d | Shikhar Bhushan | :type spec: :class:`~xml.etree.ElementTree.Element`
|
114 | 614a698d | Shikhar Bhushan | :arg encoding: character encoding
|
115 | 614a698d | Shikhar Bhushan | :rtype: :obj:`string`
|
116 | 614a698d | Shikhar Bhushan | """
|
117 | 65c6a607 | Shikhar Bhushan | xml = ET.tostring(ele, encoding) |
118 | e52e8478 | Shikhar Bhushan | if xml.startswith('<?xml'): |
119 | e52e8478 | Shikhar Bhushan | return xml
|
120 | e52e8478 | Shikhar Bhushan | else:
|
121 | e52e8478 | Shikhar Bhushan | return '<?xml version="1.0" encoding="%s"?>%s' % (encoding, xml) |
122 | 65c6a607 | Shikhar Bhushan | |
123 | 65c6a607 | Shikhar Bhushan | class XML: |
124 | 65c6a607 | Shikhar Bhushan | |
125 | 65c6a607 | Shikhar Bhushan | @staticmethod
|
126 | 4de03d63 | Shikhar Bhushan | def DictTree(xml): |
127 | 614a698d | Shikhar Bhushan | """XML -> DictTree
|
128 | 614a698d | Shikhar Bhushan |
|
129 | 614a698d | Shikhar Bhushan | :type spec: :obj:`string`
|
130 | 614a698d | Shikhar Bhushan | :rtype: :obj:`dict`
|
131 | 614a698d | Shikhar Bhushan | """
|
132 | 4de03d63 | Shikhar Bhushan | return Element.DictTree(XML.Element(xml))
|
133 | 65c6a607 | Shikhar Bhushan | |
134 | 65c6a607 | Shikhar Bhushan | @staticmethod
|
135 | 65c6a607 | Shikhar Bhushan | def Element(xml): |
136 | 614a698d | Shikhar Bhushan | """XML -> Element
|
137 | 614a698d | Shikhar Bhushan |
|
138 | 614a698d | Shikhar Bhushan | :type xml: :obj:`string`
|
139 | 614a698d | Shikhar Bhushan | :rtype: :class:`~xml.etree.ElementTree.Element`
|
140 | 614a698d | Shikhar Bhushan | """
|
141 | 65c6a607 | Shikhar Bhushan | return ET.fromstring(xml)
|
142 | d771dffc | Shikhar Bhushan | |
143 | 4de03d63 | Shikhar Bhushan | dtree2ele = DictTree.Element |
144 | 4de03d63 | Shikhar Bhushan | dtree2xml = DictTree.XML |
145 | 4de03d63 | Shikhar Bhushan | ele2dtree = Element.DictTree |
146 | 4de03d63 | Shikhar Bhushan | ele2xml = Element.XML |
147 | 4de03d63 | Shikhar Bhushan | xml2dtree = XML.DictTree |
148 | 4de03d63 | Shikhar Bhushan | xml2ele = XML.Element |
149 | 4de03d63 | Shikhar Bhushan | |
150 | d771dffc | Shikhar Bhushan | ### Other utility functions
|
151 | d771dffc | Shikhar Bhushan | |
152 | d771dffc | Shikhar Bhushan | iselement = ET.iselement |
153 | d771dffc | Shikhar Bhushan | |
154 | 614a698d | Shikhar Bhushan | def find(ele, tag, nslist=[]): |
155 | 614a698d | Shikhar Bhushan | """If `nslist` is empty, same as :meth:`xml.etree.ElementTree.Element.find`. If it is not, `tag` is interpreted as an unqualified name and qualified using each item in `nslist`. The first match is returned.
|
156 | 614a698d | Shikhar Bhushan |
|
157 | 614a698d | Shikhar Bhushan | :arg nslist: optional list of namespaces
|
158 | d771dffc | Shikhar Bhushan | """
|
159 | 614a698d | Shikhar Bhushan | if nslist:
|
160 | d771dffc | Shikhar Bhushan | for qname in multiqualify(tag): |
161 | d771dffc | Shikhar Bhushan | found = ele.find(qname) |
162 | d771dffc | Shikhar Bhushan | if found is not None: |
163 | 614a698d | Shikhar Bhushan | return found
|
164 | 614a698d | Shikhar Bhushan | else:
|
165 | 614a698d | Shikhar Bhushan | return ele.find(tag)
|
166 | d771dffc | Shikhar Bhushan | |
167 | d771dffc | Shikhar Bhushan | def parse_root(raw): |
168 | 614a698d | Shikhar Bhushan | """Efficiently parses the root element of an XML document.
|
169 | 614a698d | Shikhar Bhushan |
|
170 | 614a698d | Shikhar Bhushan | :type raw: string
|
171 | 614a698d | Shikhar Bhushan | :returns: a tuple of `(tag, attributes)`, where `tag` is the (qualified) name of the element and `attributes` is a dictionary of its attributes.
|
172 | 0cdb8b3c | Shikhar Bhushan | """
|
173 | d771dffc | Shikhar Bhushan | fp = StringIO(raw[:1024]) # this is a guess but start element beyond 1024 bytes would be a bit absurd |
174 | d771dffc | Shikhar Bhushan | for event, element in ET.iterparse(fp, events=('start',)): |
175 | d771dffc | Shikhar Bhushan | return (element.tag, element.attrib)
|
176 | d771dffc | Shikhar Bhushan | |
177 | 614a698d | Shikhar Bhushan | def validated_element(rep, tag=None, attrs=None, text=None): |
178 | 614a698d | Shikhar Bhushan | """Checks if the root element meets the supplied criteria. Returns a :class:`~xml.etree.ElementTree.Element` instance if so, otherwise raises :exc:`ContentError`.
|
179 | 614a698d | Shikhar Bhushan |
|
180 | 614a698d | Shikhar Bhushan | :arg tag: tag name or a list of allowable tag names
|
181 | 614a698d | Shikhar Bhushan | :arg attrs: list of required attribute names, each item may be a list of allowable alternatives
|
182 | 614a698d | Shikhar Bhushan | :arg text: textual content to match
|
183 | 614a698d | Shikhar Bhushan | :type rep: :obj:`dict` or :obj:`string` or :class:`~xml.etree.ElementTree.Element`
|
184 | 614a698d | Shikhar Bhushan | :see: :ref:`dtree`
|
185 | 0cdb8b3c | Shikhar Bhushan | """
|
186 | d771dffc | Shikhar Bhushan | ele = dtree2ele(rep) |
187 | 614a698d | Shikhar Bhushan | err = False
|
188 | 614a698d | Shikhar Bhushan | if tag:
|
189 | 614a698d | Shikhar Bhushan | if isinstance(tag, basestring): tag = [tag] |
190 | 614a698d | Shikhar Bhushan | if ele.tag not in tags: |
191 | 614a698d | Shikhar Bhushan | err = True
|
192 | 614a698d | Shikhar Bhushan | if attrs:
|
193 | d771dffc | Shikhar Bhushan | for req in attrs: |
194 | 614a698d | Shikhar Bhushan | if isinstance(req, basestring): req = [req] |
195 | 614a698d | Shikhar Bhushan | for alt in req: |
196 | 614a698d | Shikhar Bhushan | if alt in ele.attrib: |
197 | d771dffc | Shikhar Bhushan | break
|
198 | d771dffc | Shikhar Bhushan | else:
|
199 | 614a698d | Shikhar Bhushan | err = True
|
200 | 614a698d | Shikhar Bhushan | if text and ele.text != text: |
201 | 614a698d | Shikhar Bhushan | err = True
|
202 | 614a698d | Shikhar Bhushan | if err:
|
203 | 614a698d | Shikhar Bhushan | raise ContentError("Element [%s] does not meet requirements" % ele.tag) |
204 | d771dffc | Shikhar Bhushan | return ele |