Author: tomaz
Date: Thu Aug 9 04:55:24 2012
New Revision: 1371040
URL: http://svn.apache.org/viewvc?rev=1371040&view=rev
Log:
More docstrings updates. Contributed by Ilgiz Islamgulov.
Modified:
libcloud/trunk/libcloud/compute/drivers/cloudstack.py
libcloud/trunk/libcloud/compute/drivers/gogrid.py
libcloud/trunk/libcloud/loadbalancer/drivers/rackspace.py
Modified: libcloud/trunk/libcloud/compute/drivers/cloudstack.py
URL:
http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/cloudstack.py?rev=1371040&r1=1371039&r2=1371040&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/cloudstack.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/cloudstack.py Thu Aug 9 04:55:24
2012
@@ -163,6 +163,10 @@ class CloudStackNodeDriver(CloudStackDri
return locations
def list_nodes(self):
+ """
+ @inherits: L{NodeDriver.list_nodes}
+ @rtype: C{list} of L{CloudStackNode}
+ """
vms = self._sync_request('listVirtualMachines')
addrs = self._sync_request('listPublicIpAddresses')
@@ -222,6 +226,10 @@ class CloudStackNodeDriver(CloudStackDri
return sizes
def create_node(self, name, size, image, location=None, **kwargs):
+ """
+ @inherits: L{NodeDriver.create_node}
+ @rtype: L{CloudStackNode}
+ """
extra_args = {}
if location is None:
location = self.list_locations()[0]
@@ -252,10 +260,18 @@ class CloudStackNodeDriver(CloudStackDri
)
def destroy_node(self, node):
+ """
+ @inherits: L{NodeDriver.reboot_node}
+ @type node: L{CloudStackNode}
+ """
self._async_request('destroyVirtualMachine', id=node.id)
return True
def reboot_node(self, node):
+ """
+ @inherits: L{NodeDriver.reboot_node}
+ @type node: L{CloudStackNode}
+ """
self._async_request('rebootVirtualMachine', id=node.id)
return True
@@ -306,6 +322,10 @@ class CloudStackNodeDriver(CloudStackDri
extra=dict(name=volumeResponse['name']))
def attach_volume(self, node, volume, device=None):
+ """
+ @inherits: L{NodeDriver.attach_volume}
+ @type node: L{CloudStackNode}
+ """
# TODO Add handling for device name
self._async_request('attachVolume', id=volume.id,
virtualMachineId=node.id)
@@ -323,8 +343,8 @@ class CloudStackNodeDriver(CloudStackDri
"""
"Allocate a public IP and bind it to a node.
- @param node: Node which should be used
- @type node: L{Node}
+ @param node: Node which should be used
+ @type node: L{CloudStackNode}
@rtype: L{CloudStackAddress}
"""
@@ -347,11 +367,11 @@ class CloudStackNodeDriver(CloudStackDri
"""
Release a public IP.
- @param node: Node which should be used
- @type node: L{Node}
+ @param node: Node which should be used
+ @type node: L{CloudStackNode}
- @param address: CloudStackAddress which should be used
- @type address: L{CloudStackAddress}
+ @param address: CloudStackAddress which should be used
+ @type address: L{CloudStackAddress}
@rtype: C{bool}
"""
@@ -368,8 +388,8 @@ class CloudStackNodeDriver(CloudStackDri
"""
"Add a NAT/firewall forwarding rule.
- @param node: Node which should be used
- @type node: L{Node}
+ @param node: Node which should be used
+ @type node: L{CloudStackNode}
@param address: CloudStackAddress which should be used
@type address: L{CloudStackAddress}
@@ -409,8 +429,8 @@ class CloudStackNodeDriver(CloudStackDri
"""
Remove a NAT/firewall forwarding rule.
- @param node: Node which should be used
- @type node: L{Node}
+ @param node: Node which should be used
+ @type node: L{CloudStackNode}
@param rule: Forwarding rule which should be used
@type rule: L{CloudStackForwardingRule}
Modified: libcloud/trunk/libcloud/compute/drivers/gogrid.py
URL:
http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/gogrid.py?rev=1371040&r1=1371039&r2=1371040&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/gogrid.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/gogrid.py Thu Aug 9 04:55:24 2012
@@ -169,6 +169,10 @@ class GoGridNodeDriver(BaseGoGridDriver,
return images
def list_nodes(self):
+ """
+ @inherits: L{NodeDriver.list_nodes}
+ @rtype: C{list} of L{GoGridNode}
+ """
passwords_map = {}
res = self._server_list()
@@ -188,6 +192,10 @@ class GoGridNodeDriver(BaseGoGridDriver,
for el in res['list']]
def reboot_node(self, node):
+ """
+ @inherits: L{NodeDriver.reboot_node}
+ @type node: L{GoGridNode}
+ """
id = node.id
power = 'restart'
res = self._server_power(id, power)
@@ -196,6 +204,10 @@ class GoGridNodeDriver(BaseGoGridDriver,
return True
def destroy_node(self, node):
+ """
+ @inherits: L{NodeDriver.reboot_node}
+ @type node: L{GoGridNode}
+ """
id = node.id
res = self._server_delete(id)
if not res.success():
@@ -268,7 +280,7 @@ class GoGridNodeDriver(BaseGoGridDriver,
specified, first available IP address will be picked
@type ex_ip: C{str}
- @rtype: L{Node}
+ @rtype: L{GoGridNode}
"""
name = kwargs['name']
image = kwargs['image']
@@ -301,6 +313,8 @@ class GoGridNodeDriver(BaseGoGridDriver,
@keyword ex_ip: Public IP address to use for a Node. If not
specified, first available IP address will be picked
@type ex_ip: C{str}
+
+ @rtype: L{GoGridNode}
"""
node = self.ex_create_node_nowait(**kwargs)
@@ -334,7 +348,7 @@ class GoGridNodeDriver(BaseGoGridDriver,
http://wiki.gogrid.com/wiki/index.php/MyGSI
@keyword node: node to use as a base for image
- @type node: L{Node}
+ @type node: L{GoGridNode}
@keyword name: name for new image
@type name: C{str}
@@ -352,7 +366,7 @@ class GoGridNodeDriver(BaseGoGridDriver,
"""Change attributes of a node.
@keyword node: node to be edited (required)
- @type node: L{Node}
+ @type node: L{GoGridNode}
@keyword size: new size of a node (required)
@type size: L{NodeSize}
Modified: libcloud/trunk/libcloud/loadbalancer/drivers/rackspace.py
URL:
http://svn.apache.org/viewvc/libcloud/trunk/libcloud/loadbalancer/drivers/rackspace.py?rev=1371040&r1=1371039&r2=1371040&view=diff
==============================================================================
--- libcloud/trunk/libcloud/loadbalancer/drivers/rackspace.py (original)
+++ libcloud/trunk/libcloud/loadbalancer/drivers/rackspace.py Thu Aug 9
04:55:24 2012
@@ -674,7 +674,7 @@ class RackspaceLBDriver(Driver, OpenStac
@param balancer: Balancer which should be used
@type balancer: L{LoadBalancer}
- @rtype: C{list} of L{RackspaceAccessRuleType}
+ @rtype: C{list} of L{RackspaceAccessRule}
"""
uri = '/loadbalancers/%s/accesslist' % (balancer.id)
resp = self.connection.request(uri)
