Skip to content

Commit

Permalink
Permit urllib3.Timeout instances for defining timeout values.
Browse files Browse the repository at this point in the history
Using that, you can configure both the socket `connect` and `read`
timeout settings, in seconds.
  • Loading branch information
amotl committed Jan 16, 2024
1 parent 7411233 commit af27cb1
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 4 deletions.
4 changes: 4 additions & 0 deletions CHANGES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ Changes for crate
Unreleased
==========

- Permit ``urllib3.Timeout`` instances for defining timeout values.
This way, both ``connect`` and ``read`` socket timeout settings can be
configured. The unit is seconds.


2023/09/29 0.34.0
=================
Expand Down
15 changes: 14 additions & 1 deletion docs/by-example/client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,25 @@ traceback if a server error occurs:
>>> connection = client.connect([crate_host], error_trace=True)
>>> connection.close()

Network Timeouts
----------------

It's possible to define a default timeout value in seconds for all servers
using the optional parameter ``timeout``:
using the optional parameter ``timeout``. In this case, it will serve as a
total timeout (connect and read):

>>> connection = client.connect([crate_host, invalid_host], timeout=5)
>>> connection.close()

If you want to adjust the connect- vs. read-timeout values individually,
please use the ``urllib3.Timeout`` object like:

>>> import urllib3
>>> connection = client.connect(
... [crate_host, invalid_host],
... timeout=urllib3.Timeout(connect=5, read=None))
>>> connection.close()

Authentication
--------------

Expand Down
15 changes: 13 additions & 2 deletions docs/by-example/http.rst
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,8 @@ timeout exception:
{...}
>>> http_client.close()

It's possible to define a HTTP timeout in seconds on client instantiation, so
an exception is raised when the timeout is reached:
It is possible to define a HTTP timeout in seconds when creating a client
object, so an exception is raised when the timeout expires:

>>> http_client = HttpClient(crate_host, timeout=0.01)
>>> http_client.sql('select fib(32)')
Expand All @@ -209,6 +209,17 @@ an exception is raised when the timeout is reached:
crate.client.exceptions.ConnectionError: No more Servers available, exception from last server: ...
>>> http_client.close()

In order to adjust the connect- vs. read-timeout values individually,
please use the ``urllib3.Timeout`` object like:

>>> import urllib3
>>> http_client = HttpClient(crate_host, timeout=urllib3.Timeout(connect=1.11, read=0.01))
>>> http_client.sql('select fib(32)')
Traceback (most recent call last):
...
crate.client.exceptions.ConnectionError: No more Servers available, exception from last server: ...
>>> http_client.close()

When connecting to non-CrateDB servers, the HttpClient will raise a ConnectionError like this:

>>> http_client = HttpClient(["https://example.org/"])
Expand Down
4 changes: 3 additions & 1 deletion src/crate/client/http.py
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,9 @@ def _pool_kw_args(verify_ssl_cert, ca_cert, client_cert, client_key,
'key_file': client_key,
}
if timeout is not None:
kw['timeout'] = float(timeout)
if isinstance(timeout, str):
timeout = float(timeout)
kw['timeout'] = timeout
if pool_size is not None:
kw['maxsize'] = int(pool_size)
return kw
Expand Down
24 changes: 24 additions & 0 deletions src/crate/client/test_connection.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import datetime

from urllib3 import Timeout

from .connection import Connection
from .http import Client
from crate.client import connect
Expand Down Expand Up @@ -72,3 +74,25 @@ def test_with_timezone(self):
cursor = connection.cursor()
self.assertEqual(cursor.time_zone.tzname(None), "UTC")
self.assertEqual(cursor.time_zone.utcoffset(None), datetime.timedelta(0))

def test_timeout_float(self):
"""
Verify setting the timeout value as a scalar (float) works.
"""
with connect('localhost:4200', timeout=2.42) as conn:
self.assertEqual(conn.client._pool_kw["timeout"], 2.42)

def test_timeout_string(self):
"""
Verify setting the timeout value as a scalar (string) works.
"""
with connect('localhost:4200', timeout="2.42") as conn:
self.assertEqual(conn.client._pool_kw["timeout"], 2.42)

def test_timeout_object(self):
"""
Verify setting the timeout value as a Timeout object works.
"""
timeout = Timeout(connect=2.42, read=0.01)
with connect('localhost:4200', timeout=timeout) as conn:
self.assertEqual(conn.client._pool_kw["timeout"], timeout)

0 comments on commit af27cb1

Please sign in to comment.