Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Optional timeout #77

Merged
merged 3 commits into from
Dec 24, 2017
Merged

Optional timeout #77

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11ac129
Add timeout argument to _query method
moppymopperson Dec 24, 2017
f7be0f9
Add timeout argument to public_query method
moppymopperson Dec 24, 2017
c021d34
Add timeout argument to query_private method
moppymopperson Dec 24, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions krakenex/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def load_key(self, path):
self.secret = f.readline().strip()
return

def _query(self, urlpath, data, headers=None):
def _query(self, urlpath, data, headers=None, timeout=None):
""" Low-level query handling.

.. note::
Expand All @@ -105,6 +105,9 @@ def _query(self, urlpath, data, headers=None):
:type data: dict
:param headers: (optional) HTTPS headers
:type headers: dict
:param timeout: (optional) if not None, a `requests.HTTPError` will be
thrown after `timeout` seconds if a response has not been received
:type timeout: number
:returns: :py:meth:`requests.Response.json`-deserialised Python object
:raises: :py:exc:`requests.HTTPError`: if response status not successful

Expand All @@ -116,21 +119,25 @@ def _query(self, urlpath, data, headers=None):

url = self.uri + urlpath

self.response = self.session.post(url, data = data, headers = headers)
self.response = self.session.post(url, data = data, headers = headers,
timeout = timeout)

if self.response.status_code not in (200, 201, 202):
self.response.raise_for_status()

return self.response.json()


def query_public(self, method, data=None):
def query_public(self, method, data=None, timeout=None):
""" Performs an API query that does not require a valid key/secret pair.

:param method: API method name
:type method: str
:param data: (optional) API request parameters
:type data: dict
:param timeout: (optional) if not None, a `requests.HTTPError` will be
thrown after `timeout` seconds if a response has not been received
:type timeout: number
:returns: :py:meth:`requests.Response.json`-deserialised Python object

"""
Expand All @@ -139,15 +146,18 @@ def query_public(self, method, data=None):

urlpath = '/' + self.apiversion + '/public/' + method

return self._query(urlpath, data)
return self._query(urlpath, data, timeout = timeout)

def query_private(self, method, data=None):
def query_private(self, method, data=None, timeout=None):
""" Performs an API query that requires a valid key/secret pair.

:param method: API method name
:type method: str
:param data: (optional) API request parameters
:type data: dict
:param timeout: (optional) if not None, a `requests.HTTPError` will be
thrown after `timeout` seconds if a response has not been received
:type timeout: number
:returns: :py:meth:`requests.Response.json`-deserialised Python object

"""
Expand All @@ -166,7 +176,7 @@ def query_private(self, method, data=None):
'API-Sign': self._sign(data, urlpath)
}

return self._query(urlpath, data, headers)
return self._query(urlpath, data, headers, timeout = timeout)

def _nonce(self):
""" Nonce counter.
Expand Down