Fix typos in the code using "codespell" package, enforce codespell check as part of CI

CHANGES.rst

@@ -69,6 +69,15 @@ Other
   (GITHUB-1901)
   [RS Nikhil Krishna - @rsnk96]
 
+- Fix minor typos in the code using codespell package and enforce this check as
+  part of our GHA CI system.
+  (GITHUB-1923)
+  [Tomaz Muraus - @Kami]
+
+- Indicate we also support Python 3.12 (beta).
+  (GITHUB-1920)
+  [Tomaz Muraus - @Kami]
+
 Changes in Apache Libcloud 3.7.0
 --------------------------------
 

libcloud/common/base.py

@@ -482,7 +482,7 @@ def connect(self, host=None, port=None, base_url=None, **kwargs):
             kwargs.update({"proxy_url": self.proxy_url})
 
         connection = self.conn_class(**kwargs)
-        # You can uncoment this line, if you setup a reverse proxy server
+        # You can uncomment this line, if you setup a reverse proxy server
         # which proxies to your endpoint, and lets you easily capture
         # connections in cleartext when you setup the proxy to do SSL
         # for you
@@ -714,11 +714,11 @@ def _retryable_request(
 
     def morph_action_hook(self, action):
         """
-        Here we strip any duplicated leading or traling slashes to
+        Here we strip any duplicated leading or trailing slashes to
         prevent typos and other issues where some APIs don't correctly
         handle double slashes.
 
-        Keep in mind that in some situations, "/" is a vallid path name
+        Keep in mind that in some situations, "/" is a valid path name
         so we have a module flag which disables this behavior
         (https://github.com/apache/libcloud/issues/1529).
         """

libcloud/common/cloudstack.py

@@ -175,7 +175,7 @@ def _sync_request(
 
         command = command.lower()
 
-        # Work around for older verions which don't return "response" suffix
+        # Work around for older versions which don't return "response" suffix
         # in delete ingress rule response command name
         if (
             command == "revokesecuritygroupingress"

libcloud/common/dimensiondata.py

@@ -18,7 +18,7 @@
 from time import sleep
 from base64 import b64encode
 
-# TODO: use disutils.version when Travis CI fixed the pylint issue with version
+# TODO: use distutils.version when Travis CI fixed the pylint issue with version
 # from distutils.version import LooseVersion
 from libcloud.utils.py3 import b, httplib, basestring
 from libcloud.utils.xml import findtext
@@ -225,7 +225,7 @@ def dd_object_to_id(obj, obj_type, id_value="id"):
         )
 
 
-# TODO: use disutils.version when Travis CI fixed the pylint issue with version
+# TODO: use distutils.version when Travis CI fixed the pylint issue with version
 #       This is a temporary workaround.
 def LooseVersion(version):
     return float(version)
@@ -1430,7 +1430,7 @@ def __init__(self, id, status, percentage=0):
         """
         Initialize an instance of :class:`DimensionDataBackupClientRunningJob`
 
-        :param id: The unqiue ID of the job
+        :param id: The unique ID of the job
         :type  id: ``str``
 
         :param status: The status of the job i.e. Waiting
@@ -1456,7 +1456,7 @@ def __init__(self, type, is_file_system, description):
         """
         Initialize an instance of :class:`DimensionDataBackupClientType`
 
-        :param type: The type of client i.e. (FA.Linux, MySQL, ect.)
+        :param type: The type of client i.e. (FA.Linux, MySQL, etc.)
         :type  type: ``str``
 
         :param is_file_system: The name of the iRule

libcloud/common/gridscale.py

@@ -70,7 +70,7 @@ def add_default_headers(self, headers):
         """
         add parameters that are necessary for each request to be successful
 
-        :param headers: Authentification token
+        :param headers: Authentication token
         :type headers: ``str``
         :return: None
         """

libcloud/common/nttcis.py

@@ -25,7 +25,7 @@
 from typing import Dict
 from functools import wraps
 
-# TODO: use disutils.version when Travis CI fixed the pylint issue with version
+# TODO: use distutils.version when Travis CI fixed the pylint issue with version
 # from distutils.version import LooseVersion
 from libcloud.utils.py3 import b, httplib, basestring
 from libcloud.utils.xml import findtext
@@ -251,7 +251,7 @@ def dd_object_to_id(obj, obj_type, id_value="id"):
         )
 
 
-# TODO: use disutils.version when Travis CI fixed the pylint issue with version
+# TODO: use distutils.version when Travis CI fixed the pylint issue with version
 #       This is a temporary workaround.
 def LooseVersion(version):
     return float(version)
@@ -803,7 +803,7 @@ def __init__(self, id, adapter_type, bus_number, state):
         :param bus_number: The bus number occupied on the virtual hardware
         :type  bus_nubmer: ``str``
 
-        :param state: Curent state (i.e. NORMAL)
+        :param state: Current state (i.e. NORMAL)
         :type  speed: ``str``
 
         :param state: State of the disk (i.e. PENDING)
@@ -1614,7 +1614,7 @@ def __init__(self, id, status, percentage=0):
         """
         Initialize an instance of :class:`NttCisBackupClientRunningJob`
 
-        :param id: The unqiue ID of the job
+        :param id: The unique ID of the job
         :type  id: ``str``
 
         :param status: The status of the job i.e. Waiting
@@ -1640,7 +1640,7 @@ def __init__(self, type, is_file_system, description):
         """
         Initialize an instance of :class:`NttCisBackupClientType`
 
-        :param type: The type of client i.e. (FA.Linux, MySQL, ect.)
+        :param type: The type of client i.e. (FA.Linux, MySQL, etc.)
         :type  type: ``str``
 
         :param is_file_system: The name of the iRule

libcloud/common/openstack.py

@@ -334,7 +334,7 @@ def add_default_headers(self, headers):
         headers[AUTH_TOKEN_HEADER] = self.auth_token
         headers["Accept"] = self.accept_format
         if self._ex_force_microversion:
-            # If service not set in microversion, asume compute
+            # If service not set in microversion, assume compute
             microversion = self._ex_force_microversion.strip().split()
             if len(microversion) == 2:
                 service_type = microversion[0]

libcloud/common/upcloud.py

@@ -136,7 +136,7 @@ def _do_destroy_node(self, node_id):
                 self._sleep()
             return self._do_destroy_node(node_id)
         elif state == "maintenance":
-            # Lets wait maintenace state to go away and retry destroy
+            # Lets wait maintenance state to go away and retry destroy
             self._sleep()
             return self._do_destroy_node(node_id)
         elif state is None:  # Server not found any more
@@ -153,7 +153,7 @@ class UpcloudNodeOperations:
     """
     Helper class to start and stop node.
 
-    :param  conneciton: Connection instance
+    :param  connection: Connection instance
     :type   connection: :class:`.UpcloudConnection`
     """
 

libcloud/common/worldwidedns.py

@@ -62,7 +62,7 @@ def __init__(self, http_code, driver=None):
 
 class CouldntRemoveDomain(WorldWideDNSException):
     def __init__(self, http_code, driver=None):
-        value = "Error occured removing domain from name server, try again"
+        value = "Error occurred removing domain from name server, try again"
         super().__init__(value, http_code, 406, driver)
 
 

libcloud/common/zonomi.py

@@ -71,10 +71,10 @@ def parse_body_and_errors(self):
             errors.append(error_dict)
 
         # Data handling
-        childrens = list(xml_body)
-        if len(childrens) == 3:
-            result_counts = childrens[1]
-            actions = childrens[2]
+        children = list(xml_body)
+        if len(children) == 3:
+            result_counts = children[1]
+            actions = children[2]
 
         if actions is not None:
             actions_childrens = list(actions)

libcloud/compute/drivers/abiquo.py

@@ -486,7 +486,7 @@ def list_sizes(self, location=None):
 
         If you call the method :class:`AbiquoNodeDriver.create_node` with the
         size informed, it will just override the 'ram' value of the 'image'
-        template. So it is no too much usefull work with sizes...
+        template. So it is no too much useful work with sizes...
 
         :return: The list of sizes
         :rtype:  ``list`` of :class:`NodeSizes`
@@ -546,7 +546,7 @@ def reboot_node(self, node):
         return res.async_success()  # pylint: disable=maybe-no-member
 
     # -------------------------
-    # Extenstion methods
+    # Extension methods
     # -------------------------
 
     def _ex_connection_class_kwargs(self):

libcloud/compute/drivers/cloudscale.py

@@ -177,7 +177,7 @@ def ex_stop_node(self, node):
 
     def ex_node_by_uuid(self, uuid):
         """
-        :param str ex_user_data: A valid uuid that references your exisiting
+        :param str ex_user_data: A valid uuid that references your existing
             cloudscale.ch server.
         :type       ex_user_data:  ``str``
 

libcloud/compute/drivers/cloudstack.py

@@ -419,7 +419,7 @@ class CloudStackAddress:
     :param      vpc_id: VPC the ip belongs to
     :type       vpc_id: ``str``
 
-    :param      virtualmachine_id: The ID of virutal machine this address
+    :param      virtualmachine_id: The ID of virtual machine this address
                                    is assigned to
     :type       virtualmachine_id: ``str``
     """

libcloud/compute/drivers/dimensiondata.py

@@ -2728,7 +2728,7 @@ def ex_modify_tag_key(
         :param tag_key: The tag key you want to modify (required)
         :type  tag_key: :class:`DimensionDataTagKey` or ``str``
 
-        :param name: Set to modifiy the name of the tag key
+        :param name: Set to modify the name of the tag key
         :type  name: ``str``
 
         :param description: Set to modify the description of the tag key

libcloud/compute/drivers/ec2.py

@@ -2270,7 +2270,7 @@ def _wait_for_import_snapshot_completion(self, import_task_id, timeout=1800, int
         :param timeout: Timeout value for snapshot generation
         :type timeout: ``float``
 
-        :param interval: Time interval for repetative describe
+        :param interval: Time interval for repetitive describe
                          import snapshot tasks requests
         :type interval: ``float``
 
@@ -3868,7 +3868,7 @@ def ex_list_internet_gateways(self, gateway_ids=None, filters=None):
                                  returned.
         :type       gateway_ids: ``list``
 
-        :param      filters: The filters so the list returned inclues
+        :param      filters: The filters so the list returned includes
                              information for certain gateways only.
         :type       filters: ``dict``
 
@@ -5277,7 +5277,7 @@ def _get_common_security_group_params(
     def _get_security_groups(self, element):
         """
         Parse security groups from the provided element and return a
-        list of security groups with the id ane name key/value pairs.
+        list of security groups with the id and name key/value pairs.
 
         :rtype: ``list`` of ``dict``
         """

libcloud/compute/drivers/ecs.py

@@ -358,7 +358,7 @@ def list_nodes(self, ex_node_ids=None, ex_filters=None):
                                will be returned.
         :type   ex_node_ids: ``list`` of ``str``
         :keyword  ex_filters: node attribute and value pairs to filter nodes.
-                              Only the nodes which matchs all the pairs will
+                              Only the nodes which matches all the pairs will
                               be returned.
                               If the filter attribute need a json array value,
                               use ``list`` object, the driver will convert it.
@@ -850,7 +850,7 @@ def list_volumes(self, ex_volume_ids=None, ex_filters=None):
         :type ex_volume_ids: ``list`` of ``str``
 
         :keyword ex_filters: volume attribute and value pairs to filter
-                             volumes. Only the volumes which matchs all will
+                             volumes. Only the volumes which matches all will
                              be returned.
                              If the filter attribute need a json array value,
                              use ``list`` object, the driver will convert it.
@@ -889,7 +889,7 @@ def list_volume_snapshots(self, volume, ex_snapshot_ids=[], ex_filters=None):
         :type ex_snapshot_ids: ``list`` of ``str``
 
         :keyword ex_filters: snapshot attribute and value pairs to filter
-                             snapshots. Only the snapshot which matchs all
+                             snapshots. Only the snapshot which matches all
                              the pairs will be returned.
                              If the filter attribute need a json array value,
                              use ``list`` object, the driver will convert it.
@@ -1086,7 +1086,7 @@ def list_images(self, location=None, ex_image_ids=None, ex_filters=None):
         :type ex_image_ids: ``list`` of ``str``
 
         :keyword ex_filters: image attribute and value pairs to filter
-                             images. Only the image which matchs all
+                             images. Only the image which matches all
                              the pairs will be returned.
                              If the filter attribute need a json array value,
                              use ``list`` object, the driver will convert it.

libcloud/compute/drivers/gce.py

@@ -4812,7 +4812,7 @@ def _create_instance_properties(
 
         :keyword  accelerator_count: Support for passing in the number of
                                      requested 'accelerator_type' accelerators
-                                     attached to the VM. Will only pay atention
+                                     attached to the VM. Will only pay attention
                                      to this field if 'accelerator_type' is not
                                      None.
         :type     accelerator_count: ``int`` or ``None``
@@ -10110,7 +10110,7 @@ def _set_project_metadata(self, metadata=None, force=False, current_keys=""):
         :rtype:  ``dict``
         """
         if metadata is None:
-            # User wants to delete metdata, but if 'force' is False
+            # User wants to delete metadata, but if 'force' is False
             # and we already have sshKeys, we should retain them.
             # Otherwise, delete ALL THE THINGS!
             if not force and current_keys:

libcloud/compute/drivers/gig_g8.py

@@ -207,7 +207,7 @@ def create_node(
         :param network: G8 Network to place vm in
         :type  size: :class:`G8Network`
 
-        :param ex_description: Descripton of vm
+        :param ex_description: Description of vm
         :type  size: : ``str``
 
         :param auth: an SSH key
@@ -321,7 +321,7 @@ def ex_create_network(self, name, private_network="192.168.103.0/24", type="vgw"
         """
         Create network also known as cloudspace
 
-        :param name: the name to assing to the network
+        :param name: the name to assign to the network
         :type  name: ``str``
 
         :param private_network: subnet used as private network
@@ -507,7 +507,7 @@ def create_volume(self, size, name, ex_description, ex_disk_type="D"):
         :param name: Name of the volume
         :type  name: ``str``
 
-        :param description: Descripton of the volume
+        :param description: Description of the volume
         :type  description: ``str``
 
         :param disk_type: Type of the disk depending on the G8

libcloud/compute/drivers/gridscale.py

@@ -471,7 +471,7 @@ def destroy_node(self, node, ex_destroy_associated_resources=False):
         # 1. Delete the server itself
         result = self._sync_request(endpoint="objects/servers/{}".format(node.id), method="DELETE")
 
-        # 2. Destroy associated resouces (if requested)
+        # 2. Destroy associated resources (if requested)
         if ex_destroy_associated_resources:
             for volume in associated_volumes:
                 self.destroy_volume(volume=volume)
@@ -752,7 +752,7 @@ def ex_link_network_to_node(self, node, network):
         :param network: Network you want to link.
         :type network: :class:`.GridscaleNetwork`
 
-        :return: ``True`` if linked sucessfully, otherwise ``False``
+        :return: ``True`` if linked successfully, otherwise ``False``
         :rtype: ``bool``
         """
         result = self._sync_request(

libcloud/compute/drivers/kamatera.py

@@ -114,7 +114,7 @@ def list_images(self, location):
         """
         List available disk images.
 
-        :param location: Location of the deployement.
+        :param location: Location of the deployment.
                          Available disk images depend on location.
         :type location: :class:`.NodeLocation`