Skip to content

Add configurable client-level request timeout #69

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

Open
Samuel19012002 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add configurable client-level request timeout #69

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ import finnhub
# Setup client
finnhub_client = finnhub.Client(api_key="YOUR API KEY")

# Optionally configure a timeout (in seconds) for all API requests
finnhub_client = finnhub.Client(api_key="YOUR API KEY", timeout=8)

# Stock candles
res = finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249)
print(res)
Expand Down
6 changes: 4 additions & 2 deletions finnhub/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ class Client:
API_URL = "https://api.finnhub.io/api/v1"
DEFAULT_TIMEOUT = 10

def __init__(self, api_key, proxies=None):
def __init__(self, api_key, proxies=None, timeout=None):
self._timeout = timeout
self._session = self._init_session(api_key, proxies)

@staticmethod
Expand All @@ -34,7 +35,8 @@ def __exit__(self, *exc):

def _request(self, method, path, **kwargs):
uri = "{}/{}".format(self.API_URL, path)
kwargs["timeout"] = kwargs.get("timeout", self.DEFAULT_TIMEOUT)
timeout = self.DEFAULT_TIMEOUT if self._timeout is None else self._timeout
kwargs["timeout"] = kwargs.get("timeout", timeout)
kwargs["params"] = self._format_params(kwargs.get("params", {}))

response = getattr(self._session, method)(uri, **kwargs)
Expand Down