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

Jump to bottom

feat(backoff): implement backoff when ApiError is called ? #69

Closed
wants to merge 1 commit into from
Closed

feat(backoff): implement backoff when ApiError is called ? #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 18 additions & 5 deletions ovh/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
import urllib
import keyword
import time
import backoff
import json

try:
Expand Down Expand Up @@ -120,7 +121,7 @@ class Client(object):

def __init__(self, endpoint=None, application_key=None,
application_secret=None, consumer_key=None, timeout=TIMEOUT,
config_file=None):
config_file=None, auto_retry=None):
"""
Creates a new Client. No credential check is done at this point.

Expand Down Expand Up @@ -148,6 +149,7 @@ def __init__(self, endpoint=None, application_key=None,
:param str consumer_key: uniquely identifies
:param tuple timeout: Connection and read timeout for each request
:param float timeout: Same timeout for both connection and read
:param init auto_retry: Number of times backoff will retry if a call fail
:raises InvalidRegion: if ``endpoint`` can't be found in ``ENDPOINTS``.
"""
# Load a custom config file if requested
Expand Down Expand Up @@ -186,8 +188,18 @@ def __init__(self, endpoint=None, application_key=None,
# Override default timeout
self._timeout = timeout

# Set default auto_retry
self._auto_retry = auto_retry

## high level API

def retry_call(self, *args, **kwargs):
if self._auto_retry is None:
return self.call(*args, **kwargs)
else:
return backoff.on_exception(backoff.expo, APIError, max_tries=self._auto_retry)(self.call)(*args, **kwargs)


@property
def time_delta(self):
"""
Expand Down Expand Up @@ -344,7 +356,7 @@ def get(self, _target, _need_auth=True, **kwargs):
else:
_target = '%s?%s' % (_target, query_string)

return self.call('GET', _target, None, _need_auth)
return self.retry_call('GET', _target, None, _need_auth)

def put(self, _target, _need_auth=True, **kwargs):
"""
Expand All @@ -359,7 +371,7 @@ def put(self, _target, _need_auth=True, **kwargs):
the default
"""
kwargs = self._canonicalize_kwargs(kwargs)
return self.call('PUT', _target, kwargs, _need_auth)
return self.retry_call('PUT', _target, kwargs, _need_auth)

def post(self, _target, _need_auth=True, **kwargs):
"""
Expand All @@ -374,7 +386,7 @@ def post(self, _target, _need_auth=True, **kwargs):
the default
"""
kwargs = self._canonicalize_kwargs(kwargs)
return self.call('POST', _target, kwargs, _need_auth)
return self.retry_call('POST', _target, kwargs, _need_auth)

def delete(self, _target, _need_auth=True):
"""
Expand All @@ -384,10 +396,11 @@ def delete(self, _target, _need_auth=True):
:param string _need_auth: If True, send authentication headers. This is
the default
"""
return self.call('DELETE', _target, None, _need_auth)
return self.retry_call('DELETE', _target, None, _need_auth)

## low level helpers


def call(self, method, path, data=None, need_auth=True):
"""
Low level call helper. If ``consumer_key`` is not ``None``, inject
Expand Down