Add the ability to configure GitHub session timeouts #71
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mcdonnnj
force-pushed
the
improvement/configure_github_timeouts
branch
from
e25de78
to
05e0acc
Compare
Add the ability to modify the timeouts available for GitHub sessions in the github3.py package. When running the scraper against a GitHub org with a large number of repositories a read timeout was observed which would crash the run. With this implementation and modifying the read timeout the scraper was able to process the same GitHub org with no issues. Please see https://requests.readthedocs.io/en/latest/user/advanced/#timeouts for more information about these timeouts.
mcdonnnj
force-pushed
the
improvement/configure_github_timeouts
branch
from
05e0acc
to
f01f11e
Compare
IanLee1521
approved these changes
Mar 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request adds the ability to configure the connect and read timeouts in a github3.py GitHub session.
Motivation
I ran into an issue where partway through processing our org the scrape would fail due to a
github3.exceptions.ConnectionErrorexception caused by arequests.exceptions.ReadTimeoutexception. After implementing these changes I tried again after changing the read timeout to15(default is10) and it was able to run to completion.⚠ Testing Note
This pull request needs the changes in #72 to pass tests.