From 42e40d531c580e146a576396f65bc537ace47ed6 Mon Sep 17 00:00:00 2001
From: Kurt Griffiths <kurt.griffiths@rackspace.com>
Date: Fri, 8 Mar 2013 15:43:12 -0500
Subject: [PATCH] doc(transport.driver_base): Add docstrings
Also, renamed driver_base to base.py to be consistent with storage.
Change-Id: Iff59699a7c43341c2069823a8f39373c2d6b4760
Implements: blueprint transport-base
---
marconi/transport/__init__.py | 2 +-
marconi/transport/{driver_base.py => base.py} | 8 ++++++--
2 files changed, 7 insertions(+), 3 deletions(-)
rename marconi/transport/{driver_base.py => base.py} (77%)
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