From c190374af4e3f48c57eae2a63cc7867674716ad0 Mon Sep 17 00:00:00 2001 From: Peter Amstutz Date: Tue, 17 Mar 2015 10:27:03 -0400 Subject: [PATCH] 5476: Describe timeout behavior if KeepClient.__init__ docstring. --- sdk/python/arvados/keep.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/sdk/python/arvados/keep.py b/sdk/python/arvados/keep.py index 7e2c1e6fb2..6196b50202 100644 --- a/sdk/python/arvados/keep.py +++ b/sdk/python/arvados/keep.py @@ -449,16 +449,21 @@ class KeepClient(object): KeepClient does not use a proxy, pass in an empty string. :timeout: - The timeout (in seconds) for HTTP requests to Keep + The initial timeout (in seconds) for HTTP requests to Keep non-proxy servers. A tuple of two floats is interpreted as (connection_timeout, read_timeout): see http://docs.python-requests.org/en/latest/user/advanced/#timeouts. + Because timeouts are often a result of transient server load, the + actual connection timeout will be increased by a factor of two on + each retry. Default: (2, 300). :proxy_timeout: - The timeout (in seconds) for HTTP requests to + The initial timeout (in seconds) for HTTP requests to Keep proxies. A tuple of two floats is interpreted as - (connection_timeout, read_timeout). Default: (20, 300). + (connection_timeout, read_timeout). The behavior described + above for adjusting connection timeouts on retry also applies. + Default: (20, 300). :api_token: If you're not using an API client, but only talking -- 2.30.2