Add some docstrings to driver base

Eliminates spurious missed lines from coverage report.
This commit is contained in:
Mark McLoughlin 2013-06-15 19:13:45 +01:00
parent 2eda85e3ba
commit 2be7df70b0

View File

@ -34,12 +34,11 @@ class IncomingMessage(object):
@abc.abstractmethod
def reply(self, reply=None, failure=None):
pass
"Send a reply or failure back to the client."
@abc.abstractmethod
def done(self):
# so the transport can ack the message
pass
"The message has been dispatched and replied to."
class Listener(object):
@ -53,8 +52,7 @@ class Listener(object):
@abc.abstractmethod
def poll(self):
# returns an IncomingMessage
pass
"Blocking until a message is pending and return IncomingMessage."
class BaseDriver(object):
@ -70,9 +68,7 @@ class BaseDriver(object):
def send(self, target, ctxt, message,
wait_for_reply=None, timeout=None, envelope=False):
"""Send a message to the given target."""
return None
@abc.abstractmethod
def listen(self, target):
"""Construct a Listener for the given target."""
return None