From 1cc8b389064a09d9989769e1e1d0a0fc3aabffd8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20L=C3=A9one?= Date: Fri, 16 Mar 2018 10:49:31 +0100 Subject: [PATCH] Use standard triple double-quoted docstring --- libcloud/compute/drivers/cloudscale.py | 32 +++++++++++----------- libcloud/compute/drivers/ktucloud.py | 2 +- libcloud/compute/drivers/profitbricks.py | 8 +++--- libcloud/compute/drivers/vcloud.py | 4 +-- libcloud/loadbalancer/drivers/ninefold.py | 2 +- libcloud/test/common/test_upcloud.py | 4 +-- libcloud/test/compute/test_profitbricks.py | 12 ++++---- 7 files changed, 32 insertions(+), 32 deletions(-) diff --git a/libcloud/compute/drivers/cloudscale.py b/libcloud/compute/drivers/cloudscale.py index 1023b22397..43155fffbb 100644 --- a/libcloud/compute/drivers/cloudscale.py +++ b/libcloud/compute/drivers/cloudscale.py @@ -86,25 +86,25 @@ def __init__(self, key, **kwargs): super(CloudscaleNodeDriver, self).__init__(key, **kwargs) def list_nodes(self): - ''' + """ List all your existing compute nodes. - ''' + """ return self._list_resources('/v1/servers', self._to_node) def list_sizes(self): - ''' + """ Lists all available sizes. On cloudscale these are known as flavors. - ''' + """ return self._list_resources('/v1/flavors', self._to_size) def list_images(self): - ''' + """ List all images. Images are identified by slugs on cloudscale.ch. This means that minor version upgrades (e.g. Ubuntu 16.04.1 to Ubuntu 16.04.2) will be possible within the same id ``ubuntu-16.04``. - ''' + """ return self._list_resources('/v1/images', self._to_image) def create_node(self, name, size, image, location=None, ex_create_attr={}): @@ -145,42 +145,42 @@ def create_node(self, name, size, image, location=None, ex_create_attr={}): return self._to_node(result.object) def reboot_node(self, node): - ''' + """ Reboot a node. It's also possible to use ``node.reboot()``. - ''' + """ return self._action(node, 'reboot') def ex_start_node(self, node): - ''' + """ Start a node. This is only possible if the node is stopped. - ''' + """ return self._action(node, 'start') def ex_stop_node(self, node): - ''' + """ Stop a specific node. Similar to ``shutdown -h now``. This is only possible if the node is running. - ''' + """ return self._action(node, 'stop') def ex_node_by_uuid(self, uuid): - ''' + """ :param str ex_user_data: A valid uuid that references your exisiting cloudscale.ch server. :type ex_user_data: ``str`` :return: The server node you asked for. :rtype: :class:`Node` - ''' + """ res = self.connection.request(self._get_server_url(uuid)) return self._to_node(res.object) def destroy_node(self, node): - ''' + """ Delete a node. It's also possible to use ``node.destroy()``. This will irreversibly delete the cloudscale.ch server and all its volumes. So please be cautious. - ''' + """ res = self.connection.request( self._get_server_url(node.id), method='DELETE' diff --git a/libcloud/compute/drivers/ktucloud.py b/libcloud/compute/drivers/ktucloud.py index 1bc8544563..75a5eef6ea 100644 --- a/libcloud/compute/drivers/ktucloud.py +++ b/libcloud/compute/drivers/ktucloud.py @@ -19,7 +19,7 @@ class KTUCloudNodeDriver(CloudStackNodeDriver): - "Driver for KTUCloud Compute platform." + """Driver for KTUCloud Compute platform.""" EMPTY_DISKOFFERINGID = '0' type = Provider.KTUCLOUD diff --git a/libcloud/compute/drivers/profitbricks.py b/libcloud/compute/drivers/profitbricks.py index 1b12452618..f702bb6c8e 100644 --- a/libcloud/compute/drivers/profitbricks.py +++ b/libcloud/compute/drivers/profitbricks.py @@ -104,11 +104,11 @@ def add_default_headers(self, headers): return headers def encode_data(self, data): - ''' + """ If a string is passed in, just return it or else if a dict is passed in, encode it as a json string. - ''' + """ if type(data) is str: return data @@ -121,13 +121,13 @@ def encode_data(self, data): def request(self, action, params=None, data=None, headers=None, method='GET', raw=False, with_full_url=False): - ''' + """ Some requests will use the href attribute directly. If this is not the case, then we should formulate the url based on the action specified. If we are using a full url, we need to remove the host and protocol components. - ''' + """ if not with_full_url or with_full_url is False: action = self.api_prefix + action.lstrip('/') else: diff --git a/libcloud/compute/drivers/vcloud.py b/libcloud/compute/drivers/vcloud.py index d2b833d97a..7c0af317c3 100644 --- a/libcloud/compute/drivers/vcloud.py +++ b/libcloud/compute/drivers/vcloud.py @@ -2226,9 +2226,9 @@ def _validate_vm_memory(vm_memory): class VCloud_5_5_NodeDriver(VCloud_5_1_NodeDriver): - '''Use 5.5 Connection class to explicitly set 5.5 for the version in + """Use 5.5 Connection class to explicitly set 5.5 for the version in Accept headers - ''' + """ connectionCls = VCloud_5_5_Connection def ex_create_snapshot(self, node): diff --git a/libcloud/loadbalancer/drivers/ninefold.py b/libcloud/loadbalancer/drivers/ninefold.py index cb28f6c6cc..1365cdf828 100644 --- a/libcloud/loadbalancer/drivers/ninefold.py +++ b/libcloud/loadbalancer/drivers/ninefold.py @@ -19,7 +19,7 @@ class NinefoldLBDriver(CloudStackLBDriver): - "Driver for load balancers on Ninefold's Compute platform." + """Driver for load balancers on Ninefold's Compute platform.""" host = 'api.ninefold.com' path = '/compute/v1.0/' diff --git a/libcloud/test/common/test_upcloud.py b/libcloud/test/common/test_upcloud.py index 4a2acb1d77..60a9ea994b 100644 --- a/libcloud/test/common/test_upcloud.py +++ b/libcloud/test/common/test_upcloud.py @@ -241,7 +241,7 @@ def test_node_statys_in_started_state_for_awhile(self): self.mock_operations.destroy_node.assert_called_once_with(1) def test_reuse(self): - "Verify that internal flag self.destroyer._stop_node is handled properly" + """Verify that internal flag self.destroyer._stop_node is handled properly""" self.mock_operations.get_node_state.side_effect = ['started', 'stopped', 'started', 'stopped'] self.assertTrue(self.destroyer.destroy_node(1)) self.assertTrue(self.destroyer.destroy_node(1)) @@ -255,7 +255,7 @@ def test_timeout(self): self.assertRaises(UpcloudTimeoutException, self.destroyer.destroy_node, 1) def test_timeout_reuse(self): - "Verify sleep count is handled properly" + """Verify sleep count is handled properly""" self.mock_operations.get_node_state.side_effect = ['maintenance'] * 50 self.assertRaises(UpcloudTimeoutException, self.destroyer.destroy_node, 1) diff --git a/libcloud/test/compute/test_profitbricks.py b/libcloud/test/compute/test_profitbricks.py index 0ece89d315..62629de4ec 100644 --- a/libcloud/test/compute/test_profitbricks.py +++ b/libcloud/test/compute/test_profitbricks.py @@ -45,9 +45,9 @@ def test_list_sizes(self): def test_list_images(self): - ''' + """ Fetch all images and then fetch with filters - ''' + """ all_images = self.driver.list_images() hdd_images = self.driver.list_images('HDD') cdd_images = self.driver.list_images('CDROM') @@ -617,9 +617,9 @@ def test_ex_describe_snapshot_failure(self): self.assertIn('Resource does not exist', cm.exception.message.value) def _verify_snapshot(self, snapshot): - ''' + """ Standard properties - ''' + """ self.assertEqual( snapshot.id, 'sshot' @@ -3463,9 +3463,9 @@ def test_ex_describe_load_balancer_failure(self): self.assertIn('Resource does not exist', cm.exception.message.value) def _verify_load_balancer(self, load_balancer): - ''' + """ Standard properties - ''' + """ self.assertEqual( load_balancer.id, 'bal-1'