apache · Kami · Nov 24, 2019 · Jul 9, 2019 · Jul 9, 2019 · Jul 9, 2019
diff --git a/.gitignore b/.gitignore
@@ -31,5 +31,4 @@ lib/
 pip-selfcheck.json
 report.html
 .pytest_cache
-
-
+.mypy_cache/
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -23,10 +23,18 @@ Common
 Compute
 -------
 
+- Introduce type annotations for the base compute API methods. This means you
+  can now leverage mypy to type check (with some limitations) your code which
+  utilizes Libcloud compute API standard API methods.
+
+  Keep in mind that at this point, type annotations are only available for
+  standard compute API methods.
+  (GITHUB-1306)
+  [Tomaz Muraus]
 - [Azure ARM] Fix ``attach_volume`` method and allow maximum of 64 disks to be
   added when LUN is not specified. Previously there was a bug and only a
   maximum of 63 disks could be added.
-  (GITHUB-1372
+  (GITHUB-1372)
   [Palash Gandhi - @palashgandhi]
 
 Storage

diff --git a/example_compute.py b/example_compute.py
@@ -16,13 +16,26 @@
 from libcloud.compute.types import Provider
 from libcloud.compute.providers import get_driver
 
-EC2 = get_driver(Provider.EC2)
-Rackspace = get_driver(Provider.RACKSPACE)
+from libcloud.compute.drivers.ec2 import EC2NodeDriver
+from libcloud.compute.drivers.rackspace import RackspaceNodeDriver
+
+from typing import Type, cast
+
+ec2_cls = get_driver(Provider.EC2)
+rackspace_cls = get_driver(Provider.RACKSPACE)
+
+# NOTE: If you are using driver methods which are not part of the standard API,
+# you need to explicitly cast the driver class reference to the correct class
+# for type checking to work correctly
+EC2 = cast(Type[EC2NodeDriver], ec2_cls)
+Rackspace = cast(Type[RackspaceNodeDriver], rackspace_cls)
 
 drivers = [EC2('access key id', 'secret key', region='us-east-1'),
            Rackspace('username', 'api key', region='iad')]
 
-nodes = [driver.list_nodes() for driver in drivers]
+nodes = []
+for driver in drivers:
+    nodes.extend(driver.list_nodes())
 
 print(nodes)
 # [ <Node: provider=Amazon, status=RUNNING, name=bob, ip=1.2.3.4.5>,

diff --git a/libcloud/common/aws.py b/libcloud/common/aws.py
@@ -13,6 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Dict
+from typing import Type
+
 import base64
 from datetime import datetime
 import hashlib
@@ -23,7 +26,7 @@
 try:
     import simplejson as json
 except ImportError:
-    import json
+    import json  # type: ignore
 
 from libcloud.utils.py3 import ET
 from libcloud.utils.py3 import _real_unicode
@@ -96,7 +99,7 @@ class AWSGenericResponse(AWSBaseResponse):
     # exception class that is raised immediately.
     # If a custom exception class is not defined, errors are accumulated and
     # returned from the parse_error method.
-    exceptions = {}
+    exceptions = {}  # type: Dict[str, Type[Exception]]
 
     def success(self):
         return self.status in [httplib.OK, httplib.CREATED, httplib.ACCEPTED]

diff --git a/libcloud/common/azure.py b/libcloud/common/azure.py
@@ -30,6 +30,7 @@
 from libcloud.common.base import ConnectionUserAndKey, RawResponse
 from libcloud.common.base import CertificateConnection
 from libcloud.common.base import XmlResponse
+from libcloud.common.base import BaseDriver
 
 # The time format for headers in Azure requests
 AZURE_TIME_FORMAT = '%a, %d %b %Y %H:%M:%S GMT'
@@ -241,7 +242,7 @@ def _format_special_header_values(self, headers, method):
         return special_header_values
 
 
-class AzureBaseDriver(object):
+class AzureBaseDriver(BaseDriver):
     name = "Microsoft Azure Service Management API"
 
 

diff --git a/libcloud/common/azure_arm.py b/libcloud/common/azure_arm.py
@@ -16,19 +16,20 @@
 try:
     import simplejson as json
 except ImportError:
-    import json
+    import json  # type: ignore
 
 import time
 from libcloud.utils.py3 import urlparse
 
 from libcloud.common.base import (ConnectionUserAndKey,
                                   JsonResponse,
                                   RawResponse)
+from libcloud.common.base import BaseDriver
 from libcloud.http import LibcloudConnection
 from libcloud.utils.py3 import basestring, urlencode
 
 
-class AzureBaseDriver(object):
+class AzureBaseDriver(BaseDriver):
     name = "Microsoft Azure Resource Management API"
 
 

diff --git a/libcloud/common/base.py b/libcloud/common/base.py
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Union
+from typing import Type
+from typing import Optional
+
 import json
 import os
 import ssl
@@ -115,10 +119,16 @@ class Response(object):
     A base Response class to derive from.
     """
 
-    status = httplib.OK  # Response status code
-    headers = {}  # Response headers
-    body = None  # Raw response body
-    object = None  # Parsed response body
+    # Response status code
+    status = httplib.OK  # type: int
+    # Response headers
+    headers = {}  # type: dict
+
+    # Raw response body
+    body = None
+
+    # Parsed response body
+    object = None
 
     error = None  # Reason returned by the server.
     connection = None  # Parent connection class
@@ -298,11 +308,11 @@ class Connection(object):
     responseCls = Response
     rawResponseCls = RawResponse
     connection = None
-    host = '127.0.0.1'
+    host = '127.0.0.1'  # type: str
     port = 443
-    timeout = None
+    timeout = None  # type: Optional[Union[int, float]]
     secure = 1
-    driver = None
+    driver = None  # type:  Type[BaseDriver]
     action = None
     cache_busting = False
     backoff = None
@@ -898,7 +908,7 @@ class ConnectionUserAndKey(ConnectionKey):
     Base connection class which accepts a ``user_id`` and ``key`` argument.
     """
 
-    user_id = None
+    user_id = None  # type: int
 
     def __init__(self, user_id, key, secure=True, host=None, port=None,
                  url=None, timeout=None, proxy_url=None,
@@ -917,7 +927,7 @@ class BaseDriver(object):
     Base driver class from which other classes can inherit from.
     """
 
-    connectionCls = ConnectionKey
+    connectionCls = ConnectionKey  # type: Type[Connection]
 
     def __init__(self, key, secret=None, secure=True, host=None, port=None,
                  api_version=None, region=None, **kwargs):

diff --git a/libcloud/common/brightbox.py b/libcloud/common/brightbox.py
@@ -23,7 +23,7 @@
 try:
     import simplejson as json
 except ImportError:
-    import json
+    import json  # type: ignore
 
 
 class BrightboxResponse(JsonResponse):

diff --git a/libcloud/common/buddyns.py b/libcloud/common/buddyns.py
@@ -13,6 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import List
+from typing import Dict
+
 from libcloud.common.base import ConnectionKey, JsonResponse
 
 
@@ -28,8 +31,8 @@
 
 
 class BuddyNSResponse(JsonResponse):
-    errors = []
-    objects = []
+    errors = []  # type: List[Dict]
+    objects = []  # type: List[Dict]
 
     def __init__(self, response, connection):
         super(BuddyNSResponse, self).__init__(response=response,

diff --git a/libcloud/common/dimensiondata.py b/libcloud/common/dimensiondata.py
@@ -600,8 +600,9 @@ def wait_for_state(self, state, func, poll_interval=2, timeout=60, *args,
             else:
                 object_state = result.status
 
-            if object_state is state or object_state in state:
+            if object_state is state or str(object_state) in state:
                 return result
+
             sleep(poll_interval)
             cnt += 1
 

diff --git a/libcloud/common/dnspod.py b/libcloud/common/dnspod.py
@@ -13,6 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import List
+from typing import Dict
+
 from libcloud.common.base import ConnectionKey, JsonResponse
 
 
@@ -28,8 +31,8 @@
 
 
 class DNSPodResponse(JsonResponse):
-    errors = []
-    objects = []
+    errors = []  # type: List[Dict]
+    objects = []  # type: List[Dict]
 
     def __init__(self, response, connection):
         super(DNSPodResponse, self).__init__(response=response,

diff --git a/libcloud/common/durabledns.py b/libcloud/common/durabledns.py
@@ -13,6 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import List
+from typing import Dict
+
 import re
 from xml.etree import ElementTree as ET   # noqa
 
@@ -126,8 +129,8 @@ def __repr__(self):
 
 class DurableResponse(XmlResponse):
 
-    errors = []
-    objects = []
+    errors = []  # type: List[Dict]
+    objects = []  # type: List[Dict]
 
     def __init__(self, response, connection):
         super(DurableResponse, self).__init__(response=response,

diff --git a/libcloud/common/google.py b/libcloud/common/google.py
@@ -70,7 +70,7 @@
 try:
     import simplejson as json
 except ImportError:
-    import json
+    import json  # type: ignore
 
 import logging
 import base64
@@ -85,6 +85,7 @@
 from libcloud.utils.py3 import b, httplib, urlencode, urlparse, PY3
 from libcloud.common.base import (ConnectionUserAndKey, JsonResponse,
                                   PollingConnection)
+from libcloud.common.base import BaseDriver
 from libcloud.common.types import (ProviderError,
                                    LibcloudError)
 
@@ -293,7 +294,7 @@ def parse_body(self):
             raise GoogleBaseError(message, self.status, code)
 
 
-class GoogleBaseDriver(object):
+class GoogleBaseDriver(BaseDriver):
     name = "Google API"
 
 
@@ -730,6 +731,7 @@ def _write_token_to_file(self):
 
 class GoogleBaseConnection(ConnectionUserAndKey, PollingConnection):
     """Base connection class for interacting with Google APIs."""
+
     driver = GoogleBaseDriver
     responseCls = GoogleResponse
     host = 'www.googleapis.com'

diff --git a/libcloud/common/gridscale.py b/libcloud/common/gridscale.py
@@ -20,7 +20,7 @@
 try:
     import simplejson as json
 except Exception:
-    import json
+    import json  # type: ignore
 
 from libcloud.common.base import BaseDriver, PollingConnection
 from libcloud.common.base import ConnectionUserAndKey

diff --git a/libcloud/common/hostvirtual.py b/libcloud/common/hostvirtual.py
@@ -15,7 +15,7 @@
 try:
     import simplejson as json
 except ImportError:
-    import json
+    import json  # type: ignore
 
 from libcloud.utils.py3 import httplib
 from libcloud.common.base import ConnectionKey, JsonResponse

diff --git a/libcloud/common/liquidweb.py b/libcloud/common/liquidweb.py
@@ -161,7 +161,6 @@ def __repr__(self):
 class LiquidWebResponse(JsonResponse):
     objects = None
     errors = None
-    error_dict = {}
 
     def __init__(self, response, connection):
         self.errors = []

diff --git a/libcloud/common/luadns.py b/libcloud/common/luadns.py
@@ -13,8 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import base64
+from typing import List
+from typing import Dict
 
+import base64
 
 from libcloud.common.base import ConnectionUserAndKey, JsonResponse
 from libcloud.utils.py3 import b
@@ -31,8 +33,8 @@
 
 
 class LuadnsResponse(JsonResponse):
-    errors = []
-    objects = []
+    errors = []  # type: List[Dict]
+    objects = []  # type: List[Dict]
 
     def __init__(self, response, connection):
         super(LuadnsResponse, self).__init__(response=response,

diff --git a/libcloud/common/nsone.py b/libcloud/common/nsone.py
@@ -13,6 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import List
+from typing import Dict
+
 from libcloud.common.base import ConnectionKey, JsonResponse
 
 
@@ -28,8 +31,8 @@
 
 
 class NsOneResponse(JsonResponse):
-    errors = []
-    objects = []
+    errors = []  # type: List[Dict]
+    objects = []  # type: List[Dict]
 
     def __init__(self, response, connection):
         super(NsOneResponse, self).__init__(response=response,

diff --git a/libcloud/common/nttcis.py b/libcloud/common/nttcis.py
@@ -15,6 +15,9 @@
 """
 NTTCIS Common Components
 """
+
+from typing import Dict
+
 import xml.etree.ElementTree as etree
 import re
 from functools import wraps
@@ -1956,7 +1959,7 @@ class ClassFactory(object):
     pass
 
 
-attrs = {}
+attrs = {}  # type: Dict[str, str]
 
 
 def processor(mapping, name=None):