Updating doc strings in accordance with PEP 257. Fixing order of imports in

common.py.

3 files changed, 25 insertions, 17 deletions

diff --git a/nova/api/openstack/__init__.py b/nova/api/openstack/__init__.py
index 21d354f1c..5f9648210 100644
--- a/nova/api/openstack/__init__.py
+++ b/nova/api/openstack/__init__.py
@@ -131,7 +131,7 @@ class APIRouter(wsgi.Router):
 
 
 class APIRouterV10(APIRouter):
-    ''' Defines routes specific to OpenStack API V1.0 '''
+    """Define routes specific to OpenStack API V1.0."""
 
     def _setup_routes(self, mapper):
         APIRouter._setup_routes(self, mapper)
@@ -142,7 +142,7 @@ class APIRouterV10(APIRouter):
 
 
 class APIRouterV11(APIRouter):
-    ''' Defines routes specific to OpenStack API V1.1 '''
+    """Define routes specific to OpenStack API V1.1."""
 
     def _setup_routes(self, mapper):
         APIRouter._setup_routes(self, mapper)
diff --git a/nova/api/openstack/common.py b/nova/api/openstack/common.py
index 99fba8fef..21ceec45e 100644
--- a/nova/api/openstack/common.py
+++ b/nova/api/openstack/common.py
@@ -15,11 +15,11 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-import re
-from nova import exception
 from urlparse import urlparse
-from webob import exc
-import webob.exc
+
+import webob
+
+from nova import exception
 
 
 def limited(items, request, max_limit=1000):
@@ -79,7 +79,13 @@ def get_image_id_from_image_hash(image_service, context, image_hash):
 
 
 def get_id_from_href(href):
+    """Return the id portion of a url.
+
+    Given: http://www.foo.com/bar/123?q=4
+    Returns: 4
+
+    """
     try:
         return int(urlparse(href).path.split('/')[-1])
     except:
-        raise exc.HTTPBadRequest(_('could not parse id from href'))
+        raise webob.exc.HTTPBadRequest(_('could not parse id from href'))
diff --git a/nova/api/openstack/views/servers.py b/nova/api/openstack/views/servers.py
index 3100c46b5..fad361bd4 100644
--- a/nova/api/openstack/views/servers.py
+++ b/nova/api/openstack/views/servers.py
@@ -25,27 +25,29 @@ from nova import utils
 
 
 class ViewBuilder(object):
-    '''
-    Models a server response as a python dictionary.
+    """Model a server response as a python dictionary.
+
+    Public methods: build
     Abstract methods: _build_image, _build_flavor
-    '''
+
+    """
 
     def __init__(self, addresses_builder):
         self.addresses_builder = addresses_builder
 
     def build(self, inst, is_detail):
-        ''' Returns a dict that represenst a server '''
+        """Return a dict that represenst a server."""
         if is_detail:
             return self._build_detail(inst)
         else:
             return self._build_simple(inst)
 
     def _build_simple(self, inst):
-        ''' Returns a simple model of a server '''
+        """Return a simple model of a server."""
         return dict(server=dict(id=inst['id'], name=inst['display_name']))
 
     def _build_detail(self, inst):
-        ''' Returns a detailed model of a server '''
+        """Returns a detailed model of a server."""
         power_mapping = {
             None: 'build',
             power_state.NOSTATE: 'build',
@@ -80,16 +82,16 @@ class ViewBuilder(object):
         return dict(server=inst_dict)
 
     def _build_image(self, response, inst):
-        ''' Returns the image sub-resource of a server '''
+        """Return the image sub-resource of a server."""
         raise NotImplementedError()
 
     def _build_flavor(self, response, inst):
-        ''' Returns the flavor sub-resource of a server '''
+        """Return the flavor sub-resource of a server."""
         raise NotImplementedError()
 
 
 class ViewBuilderV10(ViewBuilder):
-    ''' Models an Openstack API V1.0 server response '''
+    """Model an Openstack API V1.0 server response."""
 
     def _build_image(self, response, inst):
         response['imageId'] = inst['image_id']
@@ -99,7 +101,7 @@ class ViewBuilderV10(ViewBuilder):
 
 
 class ViewBuilderV11(ViewBuilder):
-    ''' Models an Openstack API V1.0 server response '''
+    """Model an Openstack API V1.0 server response."""
 
     def __init__(self, addresses_builder, flavor_builder, image_builder):
         ViewBuilder.__init__(self, addresses_builder)