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