Skip to content
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

Jump to bottom

Fix issue #4190 #4197

Merged
merged 2 commits into from
Oct 19, 2019
Merged

Fix issue #4190 #4197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7bb2d7
Fix issue #4190
polcak Oct 16, 2019
f5a6e4c
Merge branch 'master' into master
asvetlov Oct 18, 2019
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
16 changes: 8 additions & 8 deletions docs/client_quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,10 +393,10 @@ Timeouts

Timeout settings are stored in :class:`ClientTimeout` data structure.

By default *aiohttp* uses a *total* 5min timeout, it means that the
By default *aiohttp* uses a *total* 300 seconds (5min) timeout, it means that the
whole operation should finish in 5 minutes.

The value could be overridden by *timeout* parameter for the session::
The value could be overridden by *timeout* parameter for the session (specified in seconds)::

timeout = aiohttp.ClientTimeout(total=60)
async with aiohttp.ClientSession(timeout=timeout) as session:
Expand All @@ -411,24 +411,24 @@ Supported :class:`ClientTimeout` fields are:

``total``

The whole operation time including connection
The maximal number of seconds for the whole operation including connection
establishment, request sending and response reading.

``connect``

The time
consists connection establishment for a new connection or
waiting for a free connection from a pool if pool connection
The maximal number of seconds for
connection establishment of a new connection or
for waiting for a free connection from a pool if pool connection
limits are exceeded.

``sock_connect``

A timeout for connecting to a peer for a new connection, not
The maximal number of seconds for connecting to a peer for a new connection, not
given from a pool.

``sock_read``

The maximum allowed timeout for period between reading a new
The maximal number of seconds allowed for period between reading a new
data portion from a peer.

All fields are floats, ``None`` or ``0`` disables a particular timeout check, see the
Expand Down
12 changes: 6 additions & 6 deletions docs/client_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ The client session supports the context manager protocol for self closing.

Async callback support is added.

:param timeout: a :class:`ClientTimeout` settings structure, 5min
:param timeout: a :class:`ClientTimeout` settings structure, 300 seconds (5min)
total timeout by default.

.. versionadded:: 3.3
Expand Down Expand Up @@ -354,7 +354,7 @@ The client session supports the context manager protocol for self closing.
:class:`float` is still supported for sake of backward
compatibility.

If :class:`float` is passed it is a *total* timeout.
If :class:`float` is passed it is a *total* timeout (in seconds).

:param ssl: SSL validation mode. ``None`` for default SSL check
(:func:`ssl.create_default_context` is used),
Expand Down Expand Up @@ -690,7 +690,7 @@ certification chaining.
does not have Content-Length header.
``True`` by default (optional).

:param timeout: a :class:`ClientTimeout` settings structure, 5min
:param timeout: a :class:`ClientTimeout` settings structure, 300 seconds (5min)
total timeout by default.


Expand Down Expand Up @@ -1435,7 +1435,7 @@ ClientTimeout

.. attribute:: connect

Total timeout for acquiring a connection from pool. The time
Maximal number of seconds for acquiring a connection from pool. The time
consists connection establishment for a new connection or
waiting for a free connection from a pool if pool connection
limits are exceeded.
Expand All @@ -1447,14 +1447,14 @@ ClientTimeout

.. attribute:: sock_connect

A timeout for connecting to a peer for a new connection, not
Maximal number of seconds for connecting to a peer for a new connection, not
given from a pool. See also :attr:`connect`.

:class:`float`, ``None`` by default.

.. attribute:: sock_read

A timeout for reading a portion of data from a peer.
Maximal number of seconds for reading a portion of data from a peer.

:class:`float`, ``None`` by default.

Expand Down