root / ncclient / content.py @ 179b00d4
History | View | Annotate | Download (3.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 | 94dd4342 | Shikhar Bhushan | "TODO: docstring"
|
16 | 94dd4342 | Shikhar Bhushan | |
17 | 94dd4342 | Shikhar Bhushan | from xml.etree import cElementTree as ET |
18 | 94dd4342 | Shikhar Bhushan | |
19 | 2f8bc438 | Shikhar Bhushan | iselement = ET.iselement |
20 | bf31e33e | Shikhar Bhushan | |
21 | 6bd810f9 | Shikhar Bhushan | ### Namespace-related ###
|
22 | 94dd4342 | Shikhar Bhushan | |
23 | 94dd4342 | Shikhar Bhushan | BASE_NS = 'urn:ietf:params:xml:ns:netconf:base:1.0'
|
24 | 1fca349b | Shikhar Bhushan | # and this is BASE_NS according to cisco devices...
|
25 | 94dd4342 | Shikhar Bhushan | CISCO_BS = 'urn:ietf:params:netconf:base:1.0'
|
26 | 94dd4342 | Shikhar Bhushan | |
27 | 94dd4342 | Shikhar Bhushan | try:
|
28 | 94dd4342 | Shikhar Bhushan | register_namespace = ET.register_namespace |
29 | 94dd4342 | Shikhar Bhushan | except AttributeError: |
30 | 94dd4342 | Shikhar Bhushan | def register_namespace(prefix, uri): |
31 | 94dd4342 | Shikhar Bhushan | from xml.etree import ElementTree |
32 | 94dd4342 | Shikhar Bhushan | # cElementTree uses ElementTree's _namespace_map, so that's ok
|
33 | 94dd4342 | Shikhar Bhushan | ElementTree._namespace_map[uri] = prefix |
34 | 94dd4342 | Shikhar Bhushan | |
35 | e91a5349 | Shikhar Bhushan | # we'd like BASE_NS to be prefixed as "netconf"
|
36 | 94dd4342 | Shikhar Bhushan | register_namespace('netconf', BASE_NS)
|
37 | 94dd4342 | Shikhar Bhushan | |
38 | bf31e33e | Shikhar Bhushan | qualify = lambda tag, ns=BASE_NS: '{%s}%s' % (ns, tag) |
39 | bf31e33e | Shikhar Bhushan | |
40 | bf31e33e | Shikhar Bhushan | # i would have written a def if lambdas weren't so much fun
|
41 | b4e9d4c2 | Shikhar Bhushan | multiqualify = lambda tag, nslist=(BASE_NS, CISCO_BS): [qualify(tag, ns)
|
42 | b4e9d4c2 | Shikhar Bhushan | for ns in nslist] |
43 | 94dd4342 | Shikhar Bhushan | |
44 | 94dd4342 | Shikhar Bhushan | unqualify = lambda tag: tag[tag.rfind('}')+1:] |
45 | 94dd4342 | Shikhar Bhushan | |
46 | ea04739a | Shikhar Bhushan | ### Build XML using Python data structures ###
|
47 | 94dd4342 | Shikhar Bhushan | |
48 | 94803aaf | Shikhar Bhushan | class XMLConverter: |
49 | 94dd4342 | Shikhar Bhushan | """Build an ElementTree.Element instance from an XML tree specification
|
50 | 94dd4342 | Shikhar Bhushan | based on nested dictionaries. TODO: describe spec
|
51 | 94dd4342 | Shikhar Bhushan | """
|
52 | 94dd4342 | Shikhar Bhushan | |
53 | 94dd4342 | Shikhar Bhushan | def __init__(self, spec): |
54 | 94dd4342 | Shikhar Bhushan | "TODO: docstring"
|
55 | 94803aaf | Shikhar Bhushan | self._root = XMLConverter.build(spec)
|
56 | cc8de468 | Shikhar Bhushan | |
57 | 94dd4342 | Shikhar Bhushan | def to_string(self, encoding='utf-8'): |
58 | 94dd4342 | Shikhar Bhushan | "TODO: docstring"
|
59 | 94dd4342 | Shikhar Bhushan | xml = ET.tostring(self._root, encoding)
|
60 | d6688264 | Shikhar Bhushan | # some etree versions don't include xml decl with utf-8
|
61 | 94dd4342 | Shikhar Bhushan | # this is a problem with some devices
|
62 | 2f8bc438 | Shikhar Bhushan | return (xml if xml.startswith('<?xml') |
63 | 2f8bc438 | Shikhar Bhushan | else '<?xml version="1.0" encoding="%s"?>%s' % (encoding, xml)) |
64 | 94dd4342 | Shikhar Bhushan | |
65 | 94dd4342 | Shikhar Bhushan | @property
|
66 | 94dd4342 | Shikhar Bhushan | def tree(self): |
67 | 94dd4342 | Shikhar Bhushan | "TODO: docstring"
|
68 | 94dd4342 | Shikhar Bhushan | return self._root |
69 | 94dd4342 | Shikhar Bhushan | |
70 | 94dd4342 | Shikhar Bhushan | @staticmethod
|
71 | 94dd4342 | Shikhar Bhushan | def build(spec): |
72 | 94dd4342 | Shikhar Bhushan | "TODO: docstring"
|
73 | d6688264 | Shikhar Bhushan | if ET.iselement(spec):
|
74 | d6688264 | Shikhar Bhushan | return spec
|
75 | d6688264 | Shikhar Bhushan | elif isinstance(spec, basestring): |
76 | d6688264 | Shikhar Bhushan | return ET.XML(spec)
|
77 | 2f8bc438 | Shikhar Bhushan | ## assume isinstance(spec, dict)
|
78 | 2f8bc438 | Shikhar Bhushan | if 'tag' in spec: |
79 | 94dd4342 | Shikhar Bhushan | ele = ET.Element(spec.get('tag'), spec.get('attributes', {})) |
80 | 2f8bc438 | Shikhar Bhushan | ele.text = spec.get('text', '') |
81 | 179b00d4 | Shikhar Bhushan | ele.tail = spec.get('tail', '') |
82 | 179b00d4 | Shikhar Bhushan | subtree = spec.get('subtree', [])
|
83 | 179b00d4 | Shikhar Bhushan | # might not be properly specified as list but may be dict
|
84 | 179b00d4 | Shikhar Bhushan | if isinstance(subtree, dict): |
85 | 179b00d4 | Shikhar Bhushan | subtree = [subtree] |
86 | 179b00d4 | Shikhar Bhushan | for subele in subtree: |
87 | 179b00d4 | Shikhar Bhushan | ele.append(XMLConverter.build(subele)) |
88 | 94dd4342 | Shikhar Bhushan | return ele
|
89 | bf31e33e | Shikhar Bhushan | elif 'comment' in spec: |
90 | 94dd4342 | Shikhar Bhushan | return ET.Comment(spec.get('comment')) |
91 | 94dd4342 | Shikhar Bhushan | else:
|
92 | 179b00d4 | Shikhar Bhushan | raise ContentError('Invalid tree spec') |
93 | 179b00d4 | Shikhar Bhushan | |
94 | 179b00d4 | Shikhar Bhushan | @staticmethod
|
95 | 179b00d4 | Shikhar Bhushan | def from_string(xml): |
96 | 179b00d4 | Shikhar Bhushan | return XMLConverter.parse(ET.fromstring(xml))
|
97 | 179b00d4 | Shikhar Bhushan | |
98 | 179b00d4 | Shikhar Bhushan | @staticmethod
|
99 | 179b00d4 | Shikhar Bhushan | def parse(root): |
100 | 179b00d4 | Shikhar Bhushan | return {
|
101 | 179b00d4 | Shikhar Bhushan | 'tag': root.tag,
|
102 | 179b00d4 | Shikhar Bhushan | 'attributes': root.attrib,
|
103 | 179b00d4 | Shikhar Bhushan | 'text': root.text,
|
104 | 179b00d4 | Shikhar Bhushan | 'tail': root.tail,
|
105 | 179b00d4 | Shikhar Bhushan | 'subtree': [ XMLConverter.parse(child) for child in root.getchildren() ] |
106 | 179b00d4 | Shikhar Bhushan | } |