Revision 94803aaf ncclient/rpc/rpc.py
b/ncclient/rpc/rpc.py | ||
---|---|---|
21 | 21 |
from ncclient.content import unqualify as __ |
22 | 22 |
from ncclient.glue import Listener |
23 | 23 |
|
24 |
from . import logger
|
|
24 |
from listener import RPCReplyListener
|
|
25 | 25 |
from reply import RPCReply |
26 | 26 |
|
27 |
import logging |
|
28 |
logger = logging.getLogger('ncclient.rpc') |
|
27 | 29 |
|
28 |
# Cisco does not include message-id attribute in <rpc-reply> in case of an error. |
|
29 |
# This is messed up however we have to deal with it. |
|
30 |
# So essentially, there can be only one operation at a time if we are talking to |
|
31 |
# a Cisco device. |
|
32 |
|
|
33 |
def cisco_check(session): |
|
34 |
try: |
|
35 |
return session.is_remote_cisco |
|
36 |
except AttributeError: |
|
37 |
return False |
|
38 | 30 |
|
39 | 31 |
class RPC(object): |
40 | 32 |
|
41 |
def __init__(self, session, async=False): |
|
42 |
if cisco_check(session) and async:
|
|
43 |
raise UserWarning('Asynchronous mode not supported for Cisco devices')
|
|
33 |
def __init__(self, session, async=False, timeout=None):
|
|
34 |
if not session.can_pipeline:
|
|
35 |
raise UserWarning('Asynchronous mode not supported for this device/session')
|
|
44 | 36 |
self._session = session |
45 | 37 |
self._async = async |
38 |
self._timeout = timeout |
|
46 | 39 |
self._id = uuid1().urn |
47 | 40 |
self._listener = RPCReplyListener(session) |
48 | 41 |
self._listener.register(self._id, self) |
49 | 42 |
self._reply = None |
50 | 43 |
self._reply_event = Event() |
51 | 44 |
|
52 |
def _build(self, op, encoding='utf-8'): |
|
53 |
if isinstance(op, dict): |
|
54 |
return self.build_from_spec(self._id, op, encoding) |
|
55 |
else: |
|
56 |
return self.build_from_string(self._id, op, encoding) |
|
45 |
def _build(opspec, encoding='utf-8'): |
|
46 |
"TODO: docstring" |
|
47 |
spec = { |
|
48 |
'tag': _('rpc'), |
|
49 |
'attributes': {'message-id': self._id}, |
|
50 |
'children': opspec |
|
51 |
} |
|
52 |
return TreeBuilder(spec).to_string(encoding) |
|
57 | 53 |
|
58 |
def _request(self, op): |
|
54 |
def _request(self, op, timeout=None):
|
|
59 | 55 |
req = self._build(op) |
60 | 56 |
self._session.send(req) |
61 | 57 |
if self._async: |
62 | 58 |
return self._reply_event |
63 | 59 |
else: |
64 |
self._reply_event.wait() |
|
65 |
self._reply.parse() |
|
66 |
return self._reply |
|
60 |
self._reply_event.wait(timeout) |
|
61 |
if self._reply_event.isSet(): |
|
62 |
self._reply.parse() |
|
63 |
return self._reply |
|
64 |
else: |
|
65 |
raise ReplyTimeoutError |
|
67 | 66 |
|
68 | 67 |
def _delivery_hook(self): |
69 | 68 |
'For subclasses' |
... | ... | |
83 | 82 |
return self._reply |
84 | 83 |
|
85 | 84 |
@property |
86 |
def is_async(self): |
|
87 |
return self._async |
|
88 |
|
|
89 |
@property |
|
90 | 85 |
def id(self): |
91 | 86 |
return self._id |
92 | 87 |
|
... | ... | |
98 | 93 |
def reply_event(self): |
99 | 94 |
return self._reply_event |
100 | 95 |
|
101 |
@staticmethod |
|
102 |
def build_from_spec(msgid, opspec, encoding='utf-8'): |
|
103 |
"TODO: docstring" |
|
104 |
spec = { |
|
105 |
'tag': _('rpc'), |
|
106 |
'attributes': {'message-id': msgid}, |
|
107 |
'children': opspec |
|
108 |
} |
|
109 |
return TreeBuilder(spec).to_string(encoding) |
|
110 |
|
|
111 |
@staticmethod |
|
112 |
def build_from_string(msgid, opstr, encoding='utf-8'): |
|
113 |
"TODO: docstring" |
|
114 |
decl = '<?xml version="1.0" encoding="%s"?>' % encoding |
|
115 |
doc = (u'<rpc message-id="%s" xmlns="%s">%s</rpc>' % |
|
116 |
(msgid, BASE_NS, opstr)).encode(encoding) |
|
117 |
return '%s%s' % (decl, doc) |
|
118 |
|
|
119 |
|
|
120 |
class RPCReplyListener(Listener): |
|
121 |
|
|
122 |
# TODO - determine if need locking |
|
123 |
|
|
124 |
# one instance per session |
|
125 |
def __new__(cls, session): |
|
126 |
instance = session.get_listener_instance(cls) |
|
127 |
if instance is None: |
|
128 |
instance = object.__new__(cls) |
|
129 |
instance._id2rpc = WeakValueDictionary() |
|
130 |
instance._cisco = cisco_check(session) |
|
131 |
instance._errback = None |
|
132 |
session.add_listener(instance) |
|
133 |
return instance |
|
134 |
|
|
135 |
def __str__(self): |
|
136 |
return 'RPCReplyListener' |
|
137 |
|
|
138 |
def set_errback(self, errback): |
|
139 |
self._errback = errback |
|
140 |
|
|
141 |
def register(self, id, rpc): |
|
142 |
self._id2rpc[id] = rpc |
|
143 |
|
|
144 |
def callback(self, root, raw): |
|
145 |
tag, attrs = root |
|
146 |
if __(tag) != 'rpc-reply': |
|
147 |
return |
|
148 |
rpc = None |
|
149 |
for key in attrs: |
|
150 |
if __(key) == 'message-id': |
|
151 |
id = attrs[key] |
|
152 |
try: |
|
153 |
rpc = self._id2rpc.pop(id) |
|
154 |
except KeyError: |
|
155 |
logger.warning('[RPCReplyListener.callback] no object ' |
|
156 |
+ 'registered for message-id: [%s]' % id) |
|
157 |
except Exception as e: |
|
158 |
logger.debug('[RPCReplyListener.callback] error - %r' % e) |
|
159 |
break |
|
160 |
else: |
|
161 |
if self._cisco: |
|
162 |
assert(len(self._id2rpc) == 1) |
|
163 |
rpc = self._id2rpc.values()[0] |
|
164 |
self._id2rpc.clear() |
|
165 |
else: |
|
166 |
logger.warning('<rpc-reply> without message-id received: %s' % raw) |
|
167 |
logger.debug('[RPCReplyListener.callback] delivering to %r' % rpc) |
|
168 |
rpc.deliver(raw) |
|
96 |
def set_async(self, bool): self._async = bool |
|
97 |
async = property(fget=lambda self: self._async, fset=set_async) |
|
169 | 98 |
|
170 |
def errback(self, err): |
|
171 |
if self._errback is not None: |
|
172 |
self._errback(err) |
|
99 |
def set_timeout(self, timeout): self._timeout = timeout |
|
100 |
timeout = property(fget=lambda self: self._timeout, fset=set_timeout) |
Also available in: Unified diff