You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2012/07/27 00:59:28 UTC
svn commit: r1366227 - in /libcloud/trunk/libcloud: common/ compute/
compute/drivers/ dns/ dns/drivers/
Author: tomaz
Date: Thu Jul 26 22:59:27 2012
New Revision: 1366227
URL: http://svn.apache.org/viewvc?rev=1366227&view=rev
Log:
Update docstrings. Contributed by Ilgiz Islamgulov, part of LIBCLOUD-235 and
LIBCLOUD-236.
Modified:
libcloud/trunk/libcloud/common/base.py
libcloud/trunk/libcloud/common/gandi.py
libcloud/trunk/libcloud/compute/base.py
libcloud/trunk/libcloud/compute/drivers/brightbox.py
libcloud/trunk/libcloud/compute/drivers/cloudstack.py
libcloud/trunk/libcloud/compute/drivers/dummy.py
libcloud/trunk/libcloud/compute/drivers/ec2.py
libcloud/trunk/libcloud/compute/drivers/gandi.py
libcloud/trunk/libcloud/compute/drivers/gogrid.py
libcloud/trunk/libcloud/compute/drivers/joyent.py
libcloud/trunk/libcloud/compute/drivers/libvirt_driver.py
libcloud/trunk/libcloud/compute/drivers/linode.py
libcloud/trunk/libcloud/compute/drivers/openstack.py
libcloud/trunk/libcloud/compute/drivers/rimuhosting.py
libcloud/trunk/libcloud/compute/drivers/softlayer.py
libcloud/trunk/libcloud/compute/drivers/vcl.py
libcloud/trunk/libcloud/dns/base.py
libcloud/trunk/libcloud/dns/drivers/dummy.py
libcloud/trunk/libcloud/dns/drivers/rackspace.py
Modified: libcloud/trunk/libcloud/common/base.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/common/base.py (original)
+++ libcloud/trunk/libcloud/common/base.py Thu Jul 26 22:59:27 2012
@@ -785,27 +785,27 @@ class BaseDriver(object):
def __init__(self, key, secret=None, secure=True, host=None, port=None,
api_version=None, **kwargs):
"""
- @keyword key: API key or username to used
- @type key: str
+ @param key: API key or username to used (required)
+ @type key: C{str}
- @keyword secret: Secret password to be used
- @type secret: str
+ @param secret: Secret password to be used (required)
+ @type secret: C{str}
- @keyword secure: Weither to use HTTPS or HTTP. Note: Some providers
+ @param secure: Weither to use HTTPS or HTTP. Note: Some providers
only support HTTPS, and it is on by default.
- @type secure: bool
+ @type secure: C{bool}
- @keyword host: Override hostname used for connections.
- @type host: str
+ @param host: Override hostname used for connections.
+ @type host: C{str}
- @keyword port: Override port used for connections.
- @type port: int
+ @param port: Override port used for connections.
+ @type port: C{int}
- @keyword api_version: Optional API version. Only used by drivers
+ @param api_version: Optional API version. Only used by drivers
which support multiple API versions.
- @type api_version: str
+ @type api_version: C{str}
- @requires: key, secret
+ @rtype: C{None}
"""
self.key = key
Modified: libcloud/trunk/libcloud/common/gandi.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/gandi.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/common/gandi.py (original)
+++ libcloud/trunk/libcloud/common/gandi.py Thu Jul 26 22:59:27 2012
@@ -106,7 +106,14 @@ class BaseGandiDriver(object):
def __init__(self, key, secret=None, secure=False):
"""
- @requires: key, secret
+ @param key: API key or username to used (required)
+ @type key: C{str}
+
+ @param secret: Secret password to be used (required)
+ @type secret: C{str}
+
+ @param secure: Weither to use HTTPS or HTTP.
+ @type secure: C{bool}
"""
self.key = key
self.secret = secret
Modified: libcloud/trunk/libcloud/compute/base.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/base.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/base.py (original)
+++ libcloud/trunk/libcloud/compute/base.py Thu Jul 26 22:59:27 2012
@@ -446,9 +446,6 @@ class NodeDriver(BaseDriver):
def __init__(self, key, secret=None, secure=True, host=None, port=None,
api_version=None, **kwargs):
- """
- @requires: key, secret
- """
super(NodeDriver, self).__init__(key=key, secret=secret, secure=secure,
host=host, port=port,
api_version=api_version, **kwargs)
Modified: libcloud/trunk/libcloud/compute/drivers/brightbox.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/brightbox.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/brightbox.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/brightbox.py Thu Jul 26 22:59:27 2012
@@ -56,9 +56,6 @@ class BrightboxNodeDriver(NodeDriver):
def __init__(self, key, secret=None, secure=True, host=None, port=None,
api_version=API_VERSION, **kwargs):
- """
- @requires: key, secret
- """
super(BrightboxNodeDriver, self).__init__(key=key, secret=secret,
secure=secure,
host=host, port=port,
Modified: libcloud/trunk/libcloud/compute/drivers/cloudstack.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/cloudstack.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/cloudstack.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/cloudstack.py Thu Jul 26 22:59:27 2012
@@ -116,7 +116,13 @@ class CloudStackNodeDriver(CloudStackDri
def __init__(self, key, secret=None, secure=True, host=None,
path=None, port=None, *args, **kwargs):
"""
- @requires: key, secret, host or path
+ @inherits: L{NodeDriver.__init__}
+
+ @param host: The host where the API can be reached. (required)
+ @type host: C{str}
+
+ @param path: The host where the API can be reached. (required)
+ @type path: C{str}
"""
host = host if host else self.host
@@ -146,7 +152,7 @@ class CloudStackNodeDriver(CloudStackDri
'hypervisor': img['hypervisor'],
'format': img['format'],
'os': img['ostypename'],
- }))
+ }))
return images
def list_locations(self):
@@ -242,7 +248,7 @@ class CloudStackNodeDriver(CloudStackDri
'zoneid': location.id,
'ip_addresses': [],
'forwarding_rules': [],
- }
+ }
)
def destroy_node(self, node):
Modified: libcloud/trunk/libcloud/compute/drivers/dummy.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/dummy.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/dummy.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/dummy.py Thu Jul 26 22:59:27 2012
@@ -69,7 +69,10 @@ class DummyNodeDriver(NodeDriver):
def __init__(self, creds):
"""
- @requires: creds
+ @param creds: Credentials
+ @type creds: C{str}
+
+ @rtype: C{None}
"""
self.creds = creds
try:
Modified: libcloud/trunk/libcloud/compute/drivers/ec2.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/ec2.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/ec2.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/ec2.py Thu Jul 26 22:59:27 2012
@@ -1321,7 +1321,10 @@ class EucNodeDriver(EC2NodeDriver):
def __init__(self, key, secret=None, secure=True, host=None,
path=None, port=None):
"""
- @requires: key, secret
+ @inherits: L{EC2NodeDriver.__init__}
+
+ @param path: The host where the API can be reached.
+ @type path: C{str}
"""
super(EucNodeDriver, self).__init__(key, secret, secure, host, port)
if path is None:
Modified: libcloud/trunk/libcloud/compute/drivers/gandi.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/gandi.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/gandi.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/gandi.py Thu Jul 26 22:59:27 2012
@@ -53,6 +53,12 @@ class GandiNodeDriver(BaseGandiDriver, N
# TODO : which features to enable ?
features = {}
+ def __init__(self, *args, **kwargs):
+ """
+ @inherits: L{NodeDriver.__init__}
+ """
+ super(BaseGandiDriver, self).__init__(*args, **kwargs)
+
def _resource_info(self, type, id):
try:
obj = self.connection.request('%s.info' % type, int(id))
Modified: libcloud/trunk/libcloud/compute/drivers/gogrid.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/gogrid.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/gogrid.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/gogrid.py Thu Jul 26 22:59:27 2012
@@ -103,6 +103,12 @@ class GoGridNodeDriver(BaseGoGridDriver,
_instance_types = GOGRID_INSTANCE_TYPES
+ def __init__(self, *args, **kwargs):
+ """
+ @inherits: L{NodeDriver.__init__}
+ """
+ super(GoGridNodeDriver, self).__init__(*args, **kwargs)
+
def _get_state(self, element):
try:
return STATE[element['state']['name']]
@@ -345,10 +351,10 @@ class GoGridNodeDriver(BaseGoGridDriver,
def ex_edit_node(self, **kwargs):
"""Change attributes of a node.
- @keyword node: node to be edited
+ @keyword node: node to be edited (required)
@type node: L{Node}
- @keyword size: new size of a node
+ @keyword size: new size of a node (required)
@type size: L{NodeSize}
@keyword ex_description: new description of a node
@@ -373,10 +379,10 @@ class GoGridNodeDriver(BaseGoGridDriver,
def ex_edit_image(self, **kwargs):
"""Edit metadata of a server image.
- @keyword image: image to be edited
+ @keyword image: image to be edited (required)
@type image: L{NodeImage}
- @keyword public: should be the image public?
+ @keyword public: should be the image public (required)
@type public: C{bool}
@keyword ex_description: description of the image (optional)
Modified: libcloud/trunk/libcloud/compute/drivers/joyent.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/joyent.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/joyent.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/joyent.py Thu Jul 26 22:59:27 2012
@@ -98,7 +98,10 @@ class JoyentNodeDriver(NodeDriver):
def __init__(self, *args, **kwargs):
"""
- @requires: key, secret
+ @inherits: L{NodeDriver.__init__}
+
+ @keyword location: Location which should be used
+ @type location: C{str}
"""
if 'location' in kwargs:
if kwargs['location'] not in LOCATIONS:
Modified: libcloud/trunk/libcloud/compute/drivers/libvirt_driver.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/libvirt_driver.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/libvirt_driver.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/libvirt_driver.py Thu Jul 26 22:59:27 2012
@@ -49,7 +49,10 @@ class LibvirtNodeDriver(NodeDriver):
def __init__(self, uri):
"""
- @requires: uri
+ @param uri: URI (required)
+ @type uri: C{str}
+
+ @rtype: C{None}
"""
if not have_libvirt:
raise RuntimeError('Libvirt driver requires \'libvirt\' Python ' +
Modified: libcloud/trunk/libcloud/compute/drivers/linode.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/linode.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/linode.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/linode.py Thu Jul 26 22:59:27 2012
@@ -78,10 +78,10 @@ class LinodeNodeDriver(NodeDriver):
def __init__(self, key):
"""Instantiate the driver with the given API key
- @keyword key: the API key to use
- @type key: C{str}
+ @param key: the API key to use (required)
+ @type key: C{str}
- @requires: key
+ @rtype: C{None}
"""
self.datacenter = None
NodeDriver.__init__(self, key)
Modified: libcloud/trunk/libcloud/compute/drivers/openstack.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/openstack.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/openstack.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/openstack.py Thu Jul 26 22:59:27 2012
@@ -175,9 +175,6 @@ class OpenStackNodeDriver(NodeDriver, Op
def __new__(cls, key, secret=None, secure=True, host=None, port=None,
api_version=DEFAULT_API_VERSION, **kwargs):
- """
- @requires: key, secret
- """
if cls is OpenStackNodeDriver:
if api_version == '1.0':
cls = OpenStack_1_0_NodeDriver
@@ -367,6 +364,10 @@ class OpenStack_1_0_NodeDriver(OpenStack
@keyword ex_files: File Path => File contents to create on
the node
@type ex_files: C{dict}
+
+ @keyword ex_shared_ip_group_id: The server is launched into
+ that shared IP group
+ @type ex_shared_ip_group_id: C{str}
"""
name = kwargs['name']
image = kwargs['image']
Modified: libcloud/trunk/libcloud/compute/drivers/rimuhosting.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/rimuhosting.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/rimuhosting.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/rimuhosting.py Thu Jul 26 22:59:27 2012
@@ -120,7 +120,22 @@ class RimuHostingNodeDriver(NodeDriver):
def __init__(self, key, host=API_HOST, port=443,
api_context=API_CONTEXT, secure=True):
"""
- @requires: key, secret
+ @param key: API key (required)
+ @type key: C{str}
+
+ @param host: hostname for connection
+ @type host: C{str}
+
+ @param port: Override port used for connections.
+ @type port: C{int}
+
+ @param api_context: Optional API context.
+ @type api_context: C{str}
+
+ @param secure: Weither to use HTTPS or HTTP.
+ @type secure: C{bool}
+
+ @rtype: C{None}
"""
# Pass in some extra vars so that
self.key = key
Modified: libcloud/trunk/libcloud/compute/drivers/softlayer.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/softlayer.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/softlayer.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/softlayer.py Thu Jul 26 22:59:27 2012
@@ -266,7 +266,16 @@ class SoftLayerNodeDriver(NodeDriver):
def __init__(self, key, secret=None, secure=False):
"""
- @requires: key, secret
+ @param key: API key or username to used (required)
+ @type key: C{str}
+
+ @param secret: Secret password to be used (required)
+ @type secret: C{str}
+
+ @param secure: Weither to use HTTPS or HTTP.
+ @type secure: C{bool}
+
+ @rtype: C{None}
"""
self.key = key
self.secret = secret
Modified: libcloud/trunk/libcloud/compute/drivers/vcl.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/vcl.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/vcl.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/vcl.py Thu Jul 26 22:59:27 2012
@@ -130,7 +130,22 @@ class VCLNodeDriver(NodeDriver):
def __init__(self, key, secret, secure=True, host=None, port=None, *args,
**kwargs):
"""
- @requires: key, secret, host
+ @param key: API key or username to used (required)
+ @type key: C{str}
+
+ @param secret: Secret password to be used (required)
+ @type secret: C{str}
+
+ @param secure: Weither to use HTTPS or HTTP.
+ @type secure: C{bool}
+
+ @param host: Override hostname used for connections. (required)
+ @type host: C{str}
+
+ @param port: Override port used for connections.
+ @type port: C{int}
+
+ @rtype: C{None}
"""
if not host:
raise Exception('When instantiating VCL driver directly ' +
Modified: libcloud/trunk/libcloud/dns/base.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/dns/base.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/dns/base.py (original)
+++ libcloud/trunk/libcloud/dns/base.py Thu Jul 26 22:59:27 2012
@@ -135,7 +135,23 @@ class DNSDriver(BaseDriver):
def __init__(self, key, secret=None, secure=True, host=None, port=None, **kwargs):
"""
- @requires: key, secret
+ @param key: API key or username to used (required)
+ @type key: C{str}
+
+ @param secret: Secret password to be used (required)
+ @type secret: C{str}
+
+ @param secure: Weither to use HTTPS or HTTP. Note: Some providers
+ only support HTTPS, and it is on by default.
+ @type secure: C{bool}
+
+ @param host: Override hostname used for connections.
+ @type host: C{str}
+
+ @param port: Override port used for connections.
+ @type port: C{int}
+
+ @rtype: C{None}
"""
super(DNSDriver, self).__init__(key=key, secret=secret, secure=secure,
host=host, port=port, **kwargs)
Modified: libcloud/trunk/libcloud/dns/drivers/dummy.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/dns/drivers/dummy.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/dns/drivers/dummy.py (original)
+++ libcloud/trunk/libcloud/dns/drivers/dummy.py Thu Jul 26 22:59:27 2012
@@ -35,7 +35,13 @@ class DummyDNSDriver(DNSDriver):
def __init__(self, api_key, api_secret):
"""
- @requires: api_key, api_secret
+ @param api_key: API key or username to used (required)
+ @type api_key: C{str}
+
+ @param api_secret: Secret password to be used (required)
+ @type api_secret: C{str}
+
+ @rtype: C{None}
"""
self._zones = {}
Modified: libcloud/trunk/libcloud/dns/drivers/rackspace.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/dns/drivers/rackspace.py?rev=1366227&r1=1366226&r2=1366227&view=diff
==============================================================================
--- libcloud/trunk/libcloud/dns/drivers/rackspace.py (original)
+++ libcloud/trunk/libcloud/dns/drivers/rackspace.py Thu Jul 26 22:59:27 2012
@@ -131,9 +131,6 @@ class RackspaceDNSDriver(DNSDriver, Open
website = 'http://www.rackspace.com/'
def __init__(self, *args, **kwargs):
- """
- @requires: key, secret
- """
OpenStackDriverMixin.__init__(self, *args, **kwargs)
super(RackspaceDNSDriver, self).__init__(*args, **kwargs)