root / ncclient / content.py @ bf31e33e
History | View | Annotate | Download (2.8 kB)
1 |
# Copyright 2009 Shikhar Bhushan
|
---|---|
2 |
#
|
3 |
# Licensed under the Apache License, Version 2.0 (the "License");
|
4 |
# you may not use this file except in compliance with the License.
|
5 |
# You may obtain a copy of the License at
|
6 |
#
|
7 |
# http://www.apache.org/licenses/LICENSE-2.0
|
8 |
#
|
9 |
# Unless required by applicable law or agreed to in writing, software
|
10 |
# distributed under the License is distributed on an "AS IS" BASIS,
|
11 |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12 |
# See the License for the specific language governing permissions and
|
13 |
# limitations under the License.
|
14 |
|
15 |
"TODO: docstring"
|
16 |
|
17 |
from xml.etree import cElementTree as ET |
18 |
|
19 |
|
20 |
### Namespace-related ###
|
21 |
|
22 |
BASE_NS = 'urn:ietf:params:xml:ns:netconf:base:1.0'
|
23 |
|
24 |
# cisco returns incorrectly namespaced xml
|
25 |
CISCO_BS = 'urn:ietf:params:netconf:base:1.0'
|
26 |
|
27 |
try:
|
28 |
register_namespace = ET.register_namespace |
29 |
except AttributeError: |
30 |
def register_namespace(prefix, uri): |
31 |
from xml.etree import ElementTree |
32 |
# cElementTree uses ElementTree's _namespace_map, so that's ok
|
33 |
ElementTree._namespace_map[uri] = prefix |
34 |
|
35 |
# we'd like BASE_NS to be prefixed as "netconf"
|
36 |
register_namespace('netconf', BASE_NS)
|
37 |
|
38 |
qualify = lambda tag, ns=BASE_NS: '{%s}%s' % (ns, tag) |
39 |
|
40 |
# i would have written a def if lambdas weren't so much fun
|
41 |
multiqualify = lambda tag, nslist=(BASE_NS, CISCO_BS): [qualify(tag, ns) for ns in nslist] |
42 |
|
43 |
unqualify = lambda tag: tag[tag.rfind('}')+1:] |
44 |
|
45 |
|
46 |
### Build XML using Python data structures ###
|
47 |
|
48 |
class TreeBuilder: |
49 |
"""Build an ElementTree.Element instance from an XML tree specification
|
50 |
based on nested dictionaries. TODO: describe spec
|
51 |
"""
|
52 |
|
53 |
def __init__(self, spec): |
54 |
"TODO: docstring"
|
55 |
self._root = TreeBuilder.build(spec)
|
56 |
|
57 |
def to_string(self, encoding='utf-8'): |
58 |
"TODO: docstring"
|
59 |
xml = ET.tostring(self._root, encoding)
|
60 |
# some etree versions don't always include xml decl
|
61 |
# this is a problem with some devices
|
62 |
if not xml.startswith('<?xml'): |
63 |
return '<?xml version="1.0" encoding="%s"?>%s' % (encoding, xml) |
64 |
else:
|
65 |
return xml
|
66 |
|
67 |
@property
|
68 |
def tree(self): |
69 |
"TODO: docstring"
|
70 |
return self._root |
71 |
|
72 |
@staticmethod
|
73 |
def build(spec): |
74 |
"TODO: docstring"
|
75 |
if 'tag' in spec: |
76 |
ele = ET.Element(spec.get('tag'), spec.get('attributes', {})) |
77 |
ele.text = spec.get('text', '') |
78 |
children = spec.get('children', [])
|
79 |
if isinstance(children, dict): |
80 |
children = [children] |
81 |
for child in children: |
82 |
ele.append(TreeBuilder.build(child)) |
83 |
return ele
|
84 |
elif 'comment' in spec: |
85 |
return ET.Comment(spec.get('comment')) |
86 |
else:
|
87 |
raise ValueError('Invalid tree spec') |