Skip to content

feat: add request timeout with 30-second default #60

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

Merged
fguillot merged 1 commit into from
Mar 25, 2026
Merged

feat: add request timeout with 30-second default #60

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
5 changes: 4 additions & 1 deletion kanboard.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ def __init__(
insecure: bool = False,
ignore_hostname_verification: bool = False,
user_agent: str = "Kanboard Python API Client",
timeout: Optional[int] = 30,
loop: Optional[asyncio.AbstractEventLoop] = None,
) -> None:
"""
Expand All @@ -81,6 +82,7 @@ def __init__(
Defaults to False.
user_agent (str, optional): Custom User-Agent string for HTTP requests. Defaults to
'Kanboard Python API Client'.
timeout (Optional[int], optional): Request timeout in seconds. Defaults to 30. Set to None to disable.
loop (Optional[asyncio.AbstractEventLoop], optional): Asyncio event loop to use. If None, uses the
current event loop or creates a new one.
"""
Expand All @@ -91,6 +93,7 @@ def __init__(
self._cafile = cafile
self._insecure = insecure
self._user_agent = user_agent
self._timeout = timeout
self._ignore_hostname_verification = ignore_hostname_verification

if not loop:
Expand Down Expand Up @@ -160,7 +163,7 @@ def _do_request(self, headers: Dict[str, str], body: Dict[str, Any]) -> Any:
if self._ignore_hostname_verification:
ssl_context.check_hostname = False

response = http.urlopen(request, context=ssl_context).read()
response = http.urlopen(request, context=ssl_context, timeout=self._timeout).read()
except Exception as e:
raise ClientError(str(e))
return self._parse_response(response)
Expand Down