Increase default read timeout to 10 seconds

tobiashenkel · tobiashenkel · commit c2bdf551f83c · 2019-01-17T16:52:38.000+01:00
The read timeout is the time until Github starts the response to an http request. The current default of one second can be too short for a local maybe slower Github Enterprise. Instead change it to 10s as github suggests also in its best practices for request from Github to integrations [1]. [1] https://developer.github.com/v3/guides/best-practices-for-integrators/#favor-asynchronous-work-over-synchronous
diff --git a/src/github3/session.py b/src/github3/session.py
@@ -93,7 +93,7 @@ class GitHubSession(requests.Session):
         "two_factor_auth_cb",
     ]
 
-    def __init__(self, default_connect_timeout=4, default_read_timeout=1):
+    def __init__(self, default_connect_timeout=4, default_read_timeout=10):
         """Slightly modify how we initialize our session."""
         super(GitHubSession, self).__init__()
         self.default_connect_timeout = default_connect_timeout
diff --git a/tests/unit/test_github_session.py b/tests/unit/test_github_session.py
@@ -41,7 +41,7 @@ def test_default_timeout(self, request_mock):
         assert r is response
         request_mock.assert_called_once_with(
             "GET", "http://example.com", allow_redirects=True,
-            timeout=(4, 1)
+            timeout=(4, 10)
         )
 
     @mock.patch.object(requests.Session, 'request')
@@ -149,7 +149,7 @@ def test_request_ignores_responses_that_do_not_require_2fa(
         assert r is response
         request_mock.assert_called_once_with(
             "GET", "http://example.com", allow_redirects=True,
-            timeout=(4, 1)
+            timeout=(4, 10)
         )
 
     @mock.patch.object(requests.Session, "request")

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ class GitHubSession(requests.Session):`
`93`	`93`	`"two_factor_auth_cb",`
`94`	`94`	`]`
`95`	`95`
`96`		`- def __init__(self, default_connect_timeout=4, default_read_timeout=1):`
	`96`	`+ def __init__(self, default_connect_timeout=4, default_read_timeout=10):`
`97`	`97`	`"""Slightly modify how we initialize our session."""`
`98`	`98`	`super(GitHubSession, self).__init__()`
`99`	`99`	`self.default_connect_timeout = default_connect_timeout`