U
|
ý°d!) ã @ s U d dl mZ d dlZd dlZd dlmZ d dlmZ ddlm Z ej
|
rTd dl m Z G dd d eZ e jZd
|
ed < ejejee f ZG d d d ZdS )é )Ú annotationsN)ÚEnum)Úgetdefaulttimeouté )ÚTimeoutStateError)ÚFinalc @ s e Zd ZdZdS )Ú _TYPE_DEFAULTéÿÿÿÿN)Ú__name__Ú
|
__module__Ú __qualname__Útoken© r r úKd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\urllib3/util/timeout.pyr s r zFinal[_TYPE_DEFAULT]Ú_DEFAULT_TIMEOUTc @ sØ e Zd ZU dZeZded< deefdddddddZd d
|
d d ZeZ e
|
dd dddZ e dd ddddZ e dd dddZd d
|
ddZdd
|
ddZdd
|
dd Zedd
|
d d Zed d
|
d d ZdS )!ÚTimeouta Timeout configuration.
|
|
Timeouts can be defined as a default for a pool:
|
|
.. code-block:: python
|
|
import urllib3
|
|
timeout = urllib3.util.Timeout(connect=2.0, read=7.0)
|
|
http = urllib3.PoolManager(timeout=timeout)
|
|
resp = http.request("GET", "https://example.com/")
|
|
print(resp.status)
|
|
Or per-request (which overrides the default for the pool):
|
|
.. code-block:: python
|
|
response = http.request("GET", "https://example.com/", timeout=Timeout(10))
|
|
Timeouts can be disabled by setting all the parameters to ``None``:
|
|
.. code-block:: python
|
|
no_timeout = Timeout(connect=None, read=None)
|
response = http.request("GET", "https://example.com/", timeout=no_timeout)
|
|
|
:param total:
|
This combines the connect and read timeouts into one; the read timeout
|
will be set to the time leftover from the connect attempt. In the
|
event that both a connect timeout and a total are specified, or a read
|
timeout and a total are specified, the shorter timeout will be applied.
|
|
Defaults to None.
|
|
:type total: int, float, or None
|
|
:param connect:
|
The maximum amount of time (in seconds) to wait for a connection
|
attempt to a server to succeed. Omitting the parameter will default the
|
connect timeout to the system default, probably `the global default
|
timeout in socket.py
|
<http://hg.python.org/cpython/file/603b4d593758/Lib/socket.py#l535>`_.
|
None will set an infinite timeout for connection attempts.
|
|
:type connect: int, float, or None
|
|
:param read:
|
The maximum amount of time (in seconds) to wait between consecutive
|
read operations for a response from the server. Omitting the parameter
|
will default the read timeout to the system default, probably `the
|
global default timeout in socket.py
|
<http://hg.python.org/cpython/file/603b4d593758/Lib/socket.py#l535>`_.
|
None will set an infinite timeout.
|
|
:type read: int, float, or None
|
|
.. note::
|
|
Many factors can affect the total amount of time for urllib3 to return
|
an HTTP response.
|
|
For example, Python's DNS resolver does not obey the timeout specified
|
on the socket. Other factors that can affect total request time include
|
high CPU load, high swap, the program running at a low priority level,
|
or other behaviors.
|
|
In addition, the read and total timeouts only measure the time between
|
read operations on the socket connecting the client and the server,
|
not the total amount of time for the request to return a complete
|
response. For most requests, the timeout is raised because the server
|
has not sent the first byte in the specified time. This is not always
|
the case; if a server streams one byte every fifteen seconds, a timeout
|
of 20 seconds will not trigger, even though the request will take
|
several minutes to complete.
|
|
If your goal is to cut off any request after a set amount of wall clock
|
time, consider having a second "watcher" thread to cut off a slow
|
request.
|
Ú _TYPE_TIMEOUTÚDEFAULT_TIMEOUTNÚNone)ÚtotalÚconnectÚreadÚreturnc C s4 | |d¡| _| |d¡| _| |d¡| _d | _d S )Nr r r )Ú_validate_timeoutÚ_connectÚ_readr Ú_start_connect)Úselfr r r r r r Ú__init__q s zTimeout.__init__Ústr)r c C s( t | j d| jd| jd| jdS )Nz (connect=z, read=z, total=ú))Útyper
|
r r r ©r r r r Ú__repr__| s zTimeout.__repr__z float | None)Útimeoutr c C s | t krt S | S )N)r r )r$ r r r Úresolve_default_timeout s z Timeout.resolve_default_timeout)ÚvalueÚnamer c C s¦ |dks|t kr|S t|tr&tdz t| W n* ttfk
|
r\ td||f dY nX z |dkrxtd||f W n& tk
|
r td||f dY nX |S )a³ Check that a timeout attribute is valid.
|
|
:param value: The timeout value to validate
|
:param name: The name of the timeout attribute to validate. This is
|
used to specify in error messages.
|
:return: The validated and casted version of the given value.
|
:raises ValueError: If it is a numeric value less than or equal to
|
zero, or the type is not an integer, float, or None.
|
NzDTimeout cannot be a boolean value. It must be an int, float or None.z>Timeout value %s was %s, but it must be an int, float or None.r zdAttempted to set %s timeout to %s, but the timeout cannot be set to a value less than or equal to 0.)r Ú
|
isinstanceÚboolÚ
|
ValueErrorÚfloatÚ TypeError)Úclsr& r' r r r r s@
|
ÿ ÿÿýþÿÿÿýzTimeout._validate_timeoutc C s t ||dS )a Create a new Timeout from a legacy timeout value.
|
|
The timeout value used by httplib.py sets the same timeout on the
|
connect(), and recv() socket requests. This creates a :class:`Timeout`
|
object that sets the individual timeouts to the ``timeout`` value
|
passed to this function.
|
|
:param timeout: The legacy timeout value.
|
:type timeout: integer, float, :attr:`urllib3.util.Timeout.DEFAULT_TIMEOUT`, or None
|
:return: Timeout object
|
:rtype: :class:`Timeout`
|
)r r )r )r- r$ r r r Ú
|
from_float° s zTimeout.from_floatc C s t | j| j| jdS )a Create a copy of the timeout object
|
|
Timeout properties are stored per-pool but each request needs a fresh
|
Timeout object to ensure each one has its own start/stop configured.
|
|
:return: a copy of the timeout object
|
:rtype: :class:`Timeout`
|
)r r r )r r r r r" r r r ÚcloneÀ s z Timeout.cloner+ c C s" | j dk rtdt ¡ | _ | j S )zÃStart the timeout clock, used during a connect() attempt
|
|
:raises urllib3.exceptions.TimeoutStateError: if you attempt
|
to start a timer that has been started already.
|
Nz'Timeout timer has already been started.©r r ÚtimeÚ monotonicr" r r r Ú start_connectÎ s
|
|
zTimeout.start_connectc C s | j dkrtdt ¡ | j S )a Gets the time elapsed since the call to :meth:`start_connect`.
|
|
:return: Elapsed time in seconds.
|
:rtype: float
|
:raises urllib3.exceptions.TimeoutStateError: if you attempt
|
to get duration for a timer that hasn't been started.
|
Nz:Can't get connect duration for timer that has not started.r0 r" r r r Úget_connect_durationÙ s
|
|
ÿz Timeout.get_connect_durationc C s8 | j dkr| jS | jdks$| jtkr*| j S t| j| j S )a! Get the value to use when setting a connection timeout.
|
|
This will be a positive float or integer, the value None
|
(never timeout), or the default system timeout.
|
|
:return: Connect timeout.
|
:rtype: int, float, :attr:`Timeout.DEFAULT_TIMEOUT` or None
|
N)r r r Úminr" r r r Úconnect_timeoutç s
|
|
|
zTimeout.connect_timeoutc C s | j dk rT| j tk rT| jdk rT| jtk rT| jdkr8| jS tdt| j | ¡ | jS | j dk r|| j tk r|td| j | ¡ S | | j¡S dS )a{ Get the value for the read timeout.
|
|
This assumes some time has elapsed in the connection timeout and
|
computes the read timeout appropriately.
|
|
If self.total is set, the read timeout is dependent on the amount of
|
time taken by the connect timeout. If the connection time has not been
|
established, a :exc:`~urllib3.exceptions.TimeoutStateError` will be
|
raised.
|
|
:return: Value to use for the read timeout.
|
:rtype: int, float or None
|
:raises urllib3.exceptions.TimeoutStateError: If :meth:`start_connect`
|
has not yet been called on this object.
|
Nr )r r r r Úmaxr5 r4 r% r" r r r Ú read_timeoutù s ÿþýü
|
zTimeout.read_timeout)r
|
r r Ú__doc__r r Ú__annotations__r r# Ú__str__Ú staticmethodr% Ú classmethodr r. r/ r3 r4 Úpropertyr6 r8 r r r r r s*
|
U ü ) r )Ú
|
__future__r r1 ÚtypingÚenumr Úsocketr Ú
|
exceptionsr Ú TYPE_CHECKINGZtyping_extensionsr r r r r: ÚOptionalÚUnionr+ r r r r r r Ú<module> s
|
