Some pep8, style and docstring fixes.

Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/9f173d09
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/9f173d09
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/9f173d09

Branch: refs/heads/trunk
Commit: 9f173d09b9f2b442c9870324bed3ba21239a9982
Parents: f15bc5e
Author: Tomaz Muraus <[email protected]>
Authored: Tue Oct 15 12:07:37 2013 +0200
Committer: Tomaz Muraus <[email protected]>
Committed: Tue Oct 15 12:07:37 2013 +0200

----------------------------------------------------------------------
 libcloud/compute/base.py               | 10 ++++-----
 libcloud/compute/drivers/cloudstack.py | 34 +++++++++++++++++++----------
 libcloud/compute/drivers/ec2.py        | 20 +++++++++++------
 3 files changed, 40 insertions(+), 24 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/9f173d09/libcloud/compute/base.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/base.py b/libcloud/compute/base.py
index 2cb3ff2..ab2fa07 100644
--- a/libcloud/compute/base.py
+++ b/libcloud/compute/base.py
@@ -438,19 +438,19 @@ class VolumeSnapshot(object):
     """
     def __init__(self, id, driver, size=None, extra=None):
         """
-        Initialize VolumeSnapshot object
+        VolumeSnapshot constructor.
 
-        :param      id: Snapshot ID
+        :param      id: Snapshot ID.
         :type       id: ``str``
 
-        :param      size: A snapshot size in Gb
+        :param      size: A snapshot size in GB.
         :type       size: ``int``
 
-        :param      extra: Platform depends parameters for snapshot
+        :param      extra: Provider depends parameters for snapshot.
         :type       extra: ``dict``
         """
-        self.driver = driver
         self.id = id
+        self.driver = driver
         self.size = size
         self.extra = extra or {}
 

http://git-wip-us.apache.org/repos/asf/libcloud/blob/9f173d09/libcloud/compute/drivers/cloudstack.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/cloudstack.py 
b/libcloud/compute/drivers/cloudstack.py
index 462738a..92ce64f 100644
--- a/libcloud/compute/drivers/cloudstack.py
+++ b/libcloud/compute/drivers/cloudstack.py
@@ -115,10 +115,12 @@ class CloudStackPortForwardingRule(object):
         :param      protocol: TCP/IP Protocol (TCP, UDP)
         :type       protocol: ``str``
 
-        :param      public_port: External port for rule (or started port if 
used port range)
+        :param      public_port: External port for rule (or start port if
+                                 public_end_port is also provided)
         :type       public_port: ``int``
 
-        :param      private_port: Internal node port for rule (or started port 
if used port range)
+        :param      private_port: Internal node port for rule (or start port if
+                                  public_end_port is also provided)
         :type       private_port: ``int``
 
         :param      public_end_port: End of external port range
@@ -339,14 +341,15 @@ class CloudStackNodeDriver(CloudStackDriverMixIn, 
NodeDriver):
             result = self._sync_request('listPortForwardingRules')
             for r in result.get('portforwardingrule', []):
                 if str(r['virtualmachineid']) == node.id:
-                    addr = [a for a in public_ips if a.address == 
r['ipaddress']]
+                    addr = [a for a in public_ips if
+                            a.address == r['ipaddress']]
                     rule = CloudStackPortForwardingRule(node, r['id'],
                                                         addr[0],
                                                         r['protocol'].upper(),
                                                         r['publicport'],
                                                         r['privateport'],
                                                         r['publicendport'],
-                                                        r['privateendport'],)
+                                                        r['privateendport'])
                     if not addr[0].address in node.public_ips:
                         node.public_ips.append(addr[0].address)
                     rules.append(rule)
@@ -473,7 +476,7 @@ class CloudStackNodeDriver(CloudStackDriverMixIn, 
NodeDriver):
 
         :rtype: ``bool``
         """
-        res = self._async_request('destroyVirtualMachine', id=node.id)
+        self._async_request('destroyVirtualMachine', id=node.id)
         return True
 
     def reboot_node(self, node):
@@ -483,7 +486,7 @@ class CloudStackNodeDriver(CloudStackDriverMixIn, 
NodeDriver):
 
         :rtype: ``bool``
         """
-        res = self._async_request('rebootVirtualMachine', id=node.id)
+        self._async_request('rebootVirtualMachine', id=node.id)
         return True
 
     def ex_start(self, node):
@@ -628,15 +631,18 @@ class CloudStackNodeDriver(CloudStackDriverMixIn, 
NodeDriver):
         """
         List all volumes
 
+        :param node: Only return volumns for the provided node.
         :type node: :class:`CloudStackNode`
 
         :rtype: ``list`` of :class:`StorageVolume`
         """
-        list_volumes = []
         if node:
-            volumes = self._sync_request('listVolumes', 
virtualmachineid=node.id)
+            volumes = self._sync_request('listVolumes',
+                                         virtualmachineid=node.id)
         else:
             volumes = self._sync_request('listVolumes')
+
+        list_volumes = []
         for vol in volumes['volume']:
             list_volumes.append(StorageVolume(id=vol['id'],
                                 name=vol['name'],
@@ -693,13 +699,14 @@ class CloudStackNodeDriver(CloudStackDriverMixIn, 
NodeDriver):
         """
         rules = []
         result = self._sync_request('listPortForwardingRules')
-        if not result == {}:
+        if result != {}:
             public_ips = self.ex_list_public_ips()
             nodes = self.list_nodes()
             for rule in result['portforwardingrule']:
                 node = [n for n in nodes
                         if n.id == str(rule['virtualmachineid'])]
-                addr = [a for a in public_ips if a.address == 
rule['ipaddress']]
+                addr = [a for a in public_ips if
+                        a.address == rule['ipaddress']]
                 rules.append(CloudStackPortForwardingRule
                              (node[0],
                               rule['id'],
@@ -714,7 +721,9 @@ class CloudStackNodeDriver(CloudStackDriverMixIn, 
NodeDriver):
 
     def ex_create_port_forwarding_rule(self, address, private_port,
                                        public_port, protocol, node,
-                                       public_end_port=None, 
private_end_port=None, openfirewall=True):
+                                       public_end_port=None,
+                                       private_end_port=None,
+                                       openfirewall=True):
         """
         Creates a Port Forwarding Rule, used for Source NAT
 
@@ -946,7 +955,8 @@ class CloudStackNodeDriver(CloudStackDriverMixIn, 
NodeDriver):
 
         extra_args = kwargs.copy()
 
-        res = self._sync_request('deleteSSHKeyPair', name=keypair, 
**extra_args)
+        res = self._sync_request('deleteSSHKeyPair', name=keypair,
+                                 **extra_args)
         return res['success']
 
     def ex_import_keypair_from_string(self, name, key_material):

http://git-wip-us.apache.org/repos/asf/libcloud/blob/9f173d09/libcloud/compute/drivers/ec2.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/ec2.py b/libcloud/compute/drivers/ec2.py
index 2362d91..2df50a3 100644
--- a/libcloud/compute/drivers/ec2.py
+++ b/libcloud/compute/drivers/ec2.py
@@ -798,10 +798,15 @@ class BaseEC2NodeDriver(NodeDriver):
 
     def list_snapshots(self, snapshot=None, owner=None):
         """
-        Describe all snapshots
-        @param snapshot: If this setted, describe only this snapshot id
-        @param owner: Owner for snapshot: self|amazon|ID
-        @return: C{list(VolumeSnapshots)}
+        Describe all snapshots.
+
+        :param snapshot: If provided, only return snapshot information for the
+                         provided snapshot.
+
+        :param owner: Owner for snapshot: self|amazon|ID
+        :type owner: ``str``
+
+        :rtype: ``list`` of :class:`VolumeSnapshot`
         """
         params = {
             'Action': 'DescribeSnapshots',
@@ -860,11 +865,12 @@ class BaseEC2NodeDriver(NodeDriver):
         }
 
     def ex_delete_keypair(self, keypair):
-        """Destroy a keypair by name
+        """
+        Delete a key pair by name.
 
-        @note: This is a non-standard extension API, and only works for EC2.
+        @note: This is a non-standard extension API, and only works with EC2.
 
-        :param      keypair: The name of the keypair to Delete.
+        :param      keypair: The name of the keypair to delete.
         :type       keypair: ``str``
 
         :rtype: ``bool``

Reply via email to