Statistics
| Branch: | Tag: | Revision:

root / ncclient / content.py @ b4e9d4c2

History | View | Annotate | Download (2.9 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
NOTIFICATION_NS = 'urn:ietf:params:xml:ns:netconf:notification:1.0'
24
# and this is BASE_NS according to cisco devices...
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)
42
                                                        for ns in nslist]
43

    
44
unqualify = lambda tag: tag[tag.rfind('}')+1:]
45

    
46

    
47
### Build XML using Python data structures ###
48

    
49
class TreeBuilder:
50
    """Build an ElementTree.Element instance from an XML tree specification
51
    based on nested dictionaries. TODO: describe spec
52
    """
53
    
54
    def __init__(self, spec):
55
        "TODO: docstring"
56
        self._root = TreeBuilder.build(spec)
57
        
58
    def to_string(self, encoding='utf-8'):
59
        "TODO: docstring"
60
        xml = ET.tostring(self._root, encoding)
61
        # some etree versions don't always include xml decl
62
        # this is a problem with some devices
63
        if not xml.startswith('<?xml'):
64
            return '<?xml version="1.0" encoding="%s"?>%s' % (encoding, xml)
65
        else:
66
            return xml
67
    
68
    @property
69
    def tree(self):
70
        "TODO: docstring"
71
        return self._root
72
    
73
    @staticmethod
74
    def build(spec):
75
        "TODO: docstring"
76
        if 'tag' in spec:
77
            ele = ET.Element(spec.get('tag'), spec.get('attributes', {}))
78
            ele.text = spec.get('text', '')
79
            children = spec.get('children', [])
80
            if isinstance(children, dict):
81
                children = [children]
82
            for child in children:
83
                ele.append(TreeBuilder.build(child))
84
            return ele
85
        elif 'comment' in spec:
86
            return ET.Comment(spec.get('comment'))
87
        else:
88
            raise ValueError('Invalid tree spec')