diff --git a/marconi/transport/__init__.py b/marconi/transport/__init__.py index 2fc326f5c..ad6437ed4 100644 --- a/marconi/transport/__init__.py +++ b/marconi/transport/__init__.py @@ -1,3 +1,3 @@ """Marconi Transport Drivers""" -from marconi.transport.driver_base import DriverBase # NOQA +from marconi.transport.base import DriverBase # NOQA diff --git a/marconi/transport/driver_base.py b/marconi/transport/base.py similarity index 77% rename from marconi/transport/driver_base.py rename to marconi/transport/base.py index 0e5832670..8c06d1bef 100644 --- a/marconi/transport/driver_base.py +++ b/marconi/transport/base.py @@ -17,10 +17,14 @@ import abc class DriverBase: + """Base class for Transport Drivers to document the expected interface.""" + __metaclass__ = abc.ABCMeta @abc.abstractmethod def listen(): - #TODO(kgriffs): If this is all there is to DriverBase, do we - # even need it? + """ + Called to start listening for client requests when Marconi is + ran in self-hosting mode. + """ pass