HOME

Mini Shell 1.0
DIR:/usr/lib/python2.7/site-packages/urllib3/util/
Current File : //usr/lib/python2.7/site-packages/urllib3/util/timeout.pyc
�
v�Sc@sXddlmZddlZddlmZe�Zd�Zdefd��YZdS(i����(t_GLOBAL_DEFAULT_TIMEOUTNi(tTimeoutStateErrorcCs
tj�S(sQ
    Retrieve the current time. This function is mocked out in unit testing.
    (ttime(((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pytcurrent_timestTimeoutcBs�eZdZeZd
eed�Zd�Ze	d��Z
e	d��Zd�Zd�Z
d�Zed��Zed	��ZRS(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
        <http://hg.python.org/cpython/file/603b4d593758/Lib/socket.py#l535>`_.
        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
        <http://hg.python.org/cpython/file/603b4d593758/Lib/socket.py#l535>`_.
        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.
    cCsL|j|d�|_|j|d�|_|j|d�|_d|_dS(Ntconnecttreadttotal(t_validate_timeoutt_connectt_readRtNonet_start_connect(tselfRRR((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pyt__init__^scCs&dt|�j|j|j|jfS(Ns!%s(connect=%r, read=%r, total=%r)(ttypet__name__R	R
R(R
((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pyt__str__dscCs�|tkr|jS|dks.||jkr2|Syt|�Wn-ttfk
rotd||f��nXy)|dkr�td||f��nWn'tk
r�td||f��nX|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 the type is not an integer or a float, or if it
            is a numeric value less than zero.
        s8Timeout value %s was %s, but it must be an int or float.isXAttempted to set %s timeout to %s, but the timeout cannot be set to a value less than 0.N(t_DefaulttDEFAULT_TIMEOUTRtfloatt	TypeErrort
ValueError(tclstvaluetname((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pyRhs"
cCstd|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`
        RR(R(Rttimeout((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pyt
from_float�scCs"td|jd|jd|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`
        RRR(RR	R
R(R
((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pytclone�scCs1|jdk	rtd��nt�|_|jS(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(RRRR(R
((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pyt
start_connect�scCs,|jdkrtd��nt�|jS(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(RRRR(R
((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pytget_connect_duration�scCsQ|jdkr|jS|jdks7|j|jkr>|jSt|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(RRR	Rtmin(R
((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pytconnect_timeout�s

!cCs�|jdk	r~|j|jk	r~|jdk	r~|j|jk	r~|jdkrX|jStdt|j|j�|j��S|jdk	r�|j|jk	r�td|j|j��S|jSdS(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.
        iN(RRRR
RtmaxRR(R
((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pytread_timeout�s
!N(Rt
__module__t__doc__RRRRRRtclassmethodRRRRRtpropertyR R"(((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pyRsF	"			
(	tsocketRRt
exceptionsRtobjectRRR(((s8/usr/lib/python2.7/site-packages/urllib3/util/timeout.pyt<module>s