abc @@ st d d l m Z d d l m Z d d l Z d d l m Z e Z e e d e j Z
d e f d YZ d S( i ( t absolute_import( t _GLOBAL_DEFAULT_TIMEOUTNi ( t TimeoutStateErrort monotonict Timeoutc B@ s e Z d Z e Z d
e e d Z d Z e d Z
e d Z d Z d Z
d Z e d Z e d Z RS( s Timeout configuration.
Timeouts can be defined as a default for a pool::
timeout = Timeout(connect=2.0, read=7.0)
http = PoolManager(timeout=timeout)
response = http.request('GET', 'http://example.com/')
Or per-request (which overrides the default for the pool)::
response = http.request('GET', 'http://example.com/', timeout=Timeout(10))
Timeouts can be disabled by setting all the parameters to ``None``::
no_timeout = Timeout(connect=None, read=None)
response = http.request('GET', 'http://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: integer, float, or None
:param connect:
The maximum amount of time 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
`_.
None will set an infinite timeout for connection attempts.
:type connect: integer, float, or None
:param read:
The maximum amount of time 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
`_.
None will set an infinite timeout.
:type read: integer, 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.
c C@ sL | j | d | _ | j | d | _ | j | d | _ d | _ d S( Nt connectt readt total( t _validate_timeoutt _connectt _readR t Nonet _start_connect( t selfR R R ( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyt __init__] s c C@ s& d t | j | j | j | j f S( Ns! %s(connect=%r, read=%r, total=%r)( t typet __name__R R
R ( R
( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyt __str__c s c C@ s | t k r | j S| d k s. | | j k r2 | St | t rP t d n y t | Wn- t t f k
r t d | | f n Xy) | d k r t d | | f n Wn' t k
r t d | | f n X| S( s 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.
sD Timeout cannot be a boolean value. It must be an int, float or None.s> Timeout value %s was %s, but it must be an int, float or None.i sd Attempted to set %s timeout to %s, but the timeout cannot be set to a value less than or equal to 0.N( t _Defaultt DEFAULT_TIMEOUTR t
isinstancet boolt
ValueErrort floatt TypeError( t clst valuet name( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyR g s&
c C@ s t d | d | S( s 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, sentinel default object, or None
:return: Timeout object
:rtype: :class:`Timeout`
R R ( R ( R t timeout( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyt
from_float s c C@ s" t d | j d | j d | j S( s 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
( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyt clone s c C@ s1 | j d k r t d n t | _ | j S( s 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.
s' Timeout timer has already been started.N( R R R t current_time( R
( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyt
start_connect s c C@ s, | j d k r t d n t | j S( s Gets the time elapsed since the call to :meth:`start_connect`.
:return: Elapsed time.
:rtype: float
:raises urllib3.exceptions.TimeoutStateError: if you attempt
to get duration for a timer that hasn't been started.
s: Can't get connect duration for timer that has not started.N( R R R R ( R
( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyt get_connect_duration s c C@ sQ | j d k r | j S| j d k s7 | j | j k r> | j St | j | j S( s" 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 R t min( R
( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyt connect_timeout s
!c C@ s | j d k r~ | j | j k r~ | j d k r~ | j | j k r~ | j d k rX | j St d t | j | j | j S| j d k r | j | j k r t d | j | j S| j Sd S( s 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, :attr:`Timeout.DEFAULT_TIMEOUT` or None
:raises urllib3.exceptions.TimeoutStateError: If :meth:`start_connect`
has not yet been called on this object.
i N( R R R R
R t maxR" R! ( R
( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyt read_timeout s
!N( R t
__module__t __doc__R R R R R R t classmethodR R R R R! t propertyR# R% ( ( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyR s F %
( t
__future__R t socketR t timet
exceptionsR t objectR t getattrR R ( ( ( sD /usr/lib/python2.7/site-packages/pip/_vendor/urllib3/util/timeout.pyt s