Merge pull request #301 from lzpap/async

Asynchronous API, Networking and Asyncio Support

.travis.yml

@@ -1,11 +1,9 @@
 language: python
 python:
-  - '2.7'
-  - '3.5'
   - '3.6'
   - '3.7'
 install:
-  - pip install .[docs-builder]
+  - pip install .[docs-builder,test-runner]
   - pip install docutils pygments  # Used to check package metadata.
 script:
   - python setup.py check --strict --metadata --restructuredtext

README.md

@@ -44,7 +44,7 @@ Please report any issues in our [issue tracker](https://github.com/iotaledger/io
 
 ## Prerequisites
 
-To install the IOTA Python client library and its dependencies, you need Python version 3.7, 3.6, 3.5, or 2.7 installed on your device.
+To install the IOTA Python client library and its dependencies, you need Python version 3.7 or 3.6 installed on your device.
 
 ## Installation
 

docs/README.rst

@@ -24,7 +24,7 @@ If you encounter any issues while using PyOTA, please report them using the
 ============
 Dependencies
 ============
-PyOTA is compatible with Python 3.7, 3.6, 3.5 and 2.7
+PyOTA is compatible with Python 3.7 and 3.6.
 
 =============
 Install PyOTA

docs/getting_started.rst

@@ -1,6 +1,6 @@
 Installation
 ============
-PyOTA is compatible with Python 3.7, 3.6, 3.5 and 2.7.
+PyOTA is compatible with Python 3.7 and 3.6.
 
 Install PyOTA using `pip`:
 

examples/hello_world.py

@@ -11,8 +11,7 @@
 from pprint import pprint
 from sys import argv
 from typing import Text
-
-from requests.exceptions import ConnectionError
+from httpx.exceptions import NetworkError
 from six import text_type
 
 from iota import BadApiResponse, StrictIota, __version__
@@ -24,7 +23,7 @@ def main(uri):
 
     try:
         node_info = api.get_node_info()
-    except ConnectionError as e:
+    except NetworkError as e:
         print(
             "Hm.  {uri} isn't responding; is the node running?".format(uri=uri)
         )

iota/__init__.py

@@ -35,6 +35,7 @@
 from .types import *
 from .transaction import *
 from .adapter import *
+from .api_async import *
 from .api import *
 from .trits import *
 

iota/adapter/__init__.py

@@ -9,8 +9,8 @@
 from logging import DEBUG, Logger
 from socket import getdefaulttimeout as get_default_timeout
 from typing import Container, Dict, List, Optional, Text, Tuple, Union
-
-from requests import Response, auth, codes, request
+from httpx import AsyncClient, Response, codes, auth
+import asyncio
 from six import PY2, binary_type, iteritems, moves as compat, text_type, \
     add_metaclass
 
@@ -59,6 +59,15 @@
     # noinspection PyCompatibility,PyUnresolvedReferences
     from urllib.parse import SplitResult
 
+def async_return(result):
+  """
+  Turns 'result' into a `Future` object with 'result' value.
+
+  Important for mocking, as we can await the mock's return value.
+  """
+  f = asyncio.Future()
+  f.set_result(result)
+  return f
 
 class BadApiResponse(ValueError):
     """
@@ -271,6 +280,7 @@ def __init__(self, uri, timeout=None, authentication=None):
         # type: (Union[Text, SplitResult], Optional[int]) -> None
         super(HttpAdapter, self).__init__()
 
+        self.client = AsyncClient()
         self.timeout = timeout
         self.authentication = authentication
 
@@ -331,13 +341,13 @@ def get_uri(self):
         # type: () -> Text
         return self.uri.geturl()
 
-    def send_request(self, payload, **kwargs):
+    async def send_request(self, payload, **kwargs):
         # type: (dict, dict) -> dict
         kwargs.setdefault('headers', {})
         for key, value in iteritems(self.DEFAULT_HEADERS):
             kwargs['headers'].setdefault(key, value)
 
-        response = self._send_http_request(
+        response = await self._send_http_request(
             # Use a custom JSON encoder that knows how to convert Tryte
             # values.
             payload=JsonEncoder().encode(payload),
@@ -346,9 +356,9 @@ def send_request(self, payload, **kwargs):
             **kwargs
         )
 
-        return self._interpret_response(response, payload, {codes['ok']})
+        return self._interpret_response(response, payload, {codes['OK']})
 
-    def _send_http_request(self, url, payload, method='post', **kwargs):
+    async def _send_http_request(self, url, payload, method='post', **kwargs):
         # type: (Text, Optional[Text], Text, dict) -> Response
         """
         Sends the actual HTTP request.
@@ -380,8 +390,7 @@ def _send_http_request(self, url, payload, method='post', **kwargs):
                 'request_url': url,
             },
         )
-
-        response = request(method=method, url=url, data=payload, **kwargs)
+        response = await self.client.request(method=method, url=url, data=payload, **kwargs)
 
         self._log(
             level=DEBUG,
@@ -474,9 +483,9 @@ def _interpret_response(self, response, payload, expected_status):
 
         error = None
         try:
-            if response.status_code == codes['bad_request']:
+            if response.status_code == codes['BAD_REQUEST']:
                 error = decoded['error']
-            elif response.status_code == codes['internal_server_error']:
+            elif response.status_code == codes['INTERNAL_SERVER_ERROR']:
                 error = decoded['exception']
         except KeyError:
             pass
@@ -585,7 +594,10 @@ def seed_response(self, command, response):
         self.responses[command].append(response)
         return self
 
-    def send_request(self, payload, **kwargs):
+    async def send_request(self, payload, **kwargs):
+        """
+        Mimic asynchronous behavior of `HttpAdapter.send_request`.
+        """
         # type: (dict, dict) -> dict
         # Store a snapshot so that we can inspect the request later.
         self.requests.append(dict(payload))
@@ -627,4 +639,4 @@ def send_request(self, payload, **kwargs):
             raise with_context(BadApiResponse(error),
                                context={'request': payload})
 
-        return response
+        return await async_return(response)

iota/adapter/wrappers.py

@@ -144,8 +144,8 @@ def get_adapter(self, command):
         """
         return self.routes.get(command, self.adapter)
 
-    def send_request(self, payload, **kwargs):
+    async def send_request(self, payload, **kwargs):
         # type: (dict, dict) -> dict
         command = payload.get('command')
 
-        return self.get_adapter(command).send_request(payload, **kwargs)
+        return await self.get_adapter(command).send_request(payload, **kwargs)