B uf%@sxdZddlmZddlZddlZddlmZdZdZdZ dZ Gdd d e Z Gd d d e Z d d ZGddde ZdS)aDecorators for applying timeout arguments to functions. These decorators are used to wrap API methods to apply either a Deadline-dependent (recommended), constant (DEPRECATED) or exponential (DEPRECATED) timeout argument. For example, imagine an API method that can take a while to return results, such as one that might block until a resource is ready: .. code-block:: python def is_thing_ready(timeout=None): response = requests.get('https://example.com/is_thing_ready') response.raise_for_status() return response.json() This module allows a function like this to be wrapped so that timeouts are automatically determined, for example: .. code-block:: python timeout_ = timeout.ExponentialTimeout() is_thing_ready_with_timeout = timeout_(is_thing_ready) for n in range(10): try: is_thing_ready_with_timeout({'example': 'data'}) except: pass In this example the first call to ``is_thing_ready`` will have a relatively small timeout (like 1 second). If the resource is available and the request completes quickly, the loop exits. But, if the resource isn't yet available and the request times out, it'll be retried - this time with a larger timeout. In the broader context these decorators are typically combined with :mod:`google.api_core.retry` to implement API methods with a signature that matches ``api_method(request, timeout=None, retry=None)``. )unicode_literalsN)datetime_helpersg@g>@g@c@s0eZdZdZdejfddZddZddZdS) TimeToDeadlineTimeouta&A decorator that decreases timeout set for an RPC based on how much time has left till its deadline. The deadline is calculated as ``now + initial_timeout`` when this decorator is first called for an rpc. In other words this decorator implements deadline semantics in terms of a sequence of decreasing timeouts t0 > t1 > t2 ... tn >= 0. Args: timeout (Optional[float]): the timeout (in seconds) to applied to the wrapped function. If `None`, the target function is expected to never timeout. NcCs||_||_dS)N)_timeout_clock)selftimeoutclockr Y/home/ankuromar296_gmail_com/myenv/lib/python3.7/site-packages/google/api_core/timeout.py__init__TszTimeToDeadlineTimeout.__init__cs*tfdd}|S)aApply the timeout decorator. Args: func (Callable): The function to apply the timeout argument to. This function must accept a timeout keyword argument. Returns: Callable: The wrapped function. csPj}|dk rF}|dkr*}|}tdj||d<||S)z#Wrapped function that adds timeout.NgMbP?rr)rr timestampmax)argskwargsZremaining_timeoutZ now_timestampZtime_since_first_attempt)first_attempt_timestampfuncrr r func_with_timeoutes  z9TimeToDeadlineTimeout.__call__..func_with_timeout)rr functoolswraps)rrrr )rrrr __call__Xs zTimeToDeadlineTimeout.__call__cCs d|jS)Nz&)formatr)rr r r __str__|szTimeToDeadlineTimeout.__str__) __name__ __module__ __qualname____doc__rutcnowr rrr r r r rFs $rc@s*eZdZdZd ddZddZddZdS) ConstantTimeoutaA decorator that adds a constant timeout argument. DEPRECATED: use ``TimeToDeadlineTimeout`` instead. This is effectively equivalent to ``functools.partial(func, timeout=timeout)``. Args: timeout (Optional[float]): the timeout (in seconds) to applied to the wrapped function. If `None`, the target function is expected to never timeout. NcCs ||_dS)N)r)rrr r r r szConstantTimeout.__init__cstfdd}|S)aApply the timeout decorator. Args: func (Callable): The function to apply the timeout argument to. This function must accept a timeout keyword argument. Returns: Callable: The wrapped function. csj|d<||S)z#Wrapped function that adds timeout.r)r)rr)rrr r rs z3ConstantTimeout.__call__..func_with_timeout)rr)rrrr )rrr rs zConstantTimeout.__call__cCs d|jS)Nz )rr)rr r r rszConstantTimeout.__str__)N)rrrrr rrr r r r rs  rccs\|dk rttj|d}ntjj}|}x,t}t||t||jV||}q,WdS)aVA generator that yields exponential timeout values. Args: initial (float): The initial timeout. maximum (float): The maximum timeout. multiplier (float): The multiplier applied to the timeout. deadline (float): The overall deadline across all invocations. Yields: float: A timeout value. N)seconds)rrdatetime timedeltarminfloatr)initialmaximum multiplierdeadlineZdeadline_datetimernowr r r _exponential_timeout_generators   r)c@s:eZdZdZeeeefddZddZ ddZ dd Z d S) ExponentialTimeoutaTA decorator that adds an exponentially increasing timeout argument. DEPRECATED: the concept of incrementing timeout exponentially has been deprecated. Use ``TimeToDeadlineTimeout`` instead. This is useful if a function is called multiple times. Each time the function is called this decorator will calculate a new timeout parameter based on the the number of times the function has been called. For example .. code-block:: python Args: initial (float): The initial timeout to pass. maximum (float): The maximum timeout for any one call. multiplier (float): The multiplier applied to the timeout for each invocation. deadline (Optional[float]): The overall deadline across all invocations. This is used to prevent a very large calculated timeout from pushing the overall execution time over the deadline. This is especially useful in conjunction with :mod:`google.api_core.retry`. If ``None``, the timeouts will not be adjusted to accommodate an overall deadline. cCs||_||_||_||_dS)N)_initial_maximum _multiplier _deadline)rr$r%r&r'r r r r szExponentialTimeout.__init__cCst|j|j|j|dS)zReturn a copy of this timeout with the given deadline. Args: deadline (float): The overall deadline across all invocations. Returns: ExponentialTimeout: A new instance with the given deadline. )r$r%r&r')r*r+r,r-)rr'r r r with_deadlines z ExponentialTimeout.with_deadlinecs2t|j|j|j|jtfdd}|S)aApply the timeout decorator. Args: func (Callable): The function to apply the timeout argument to. This function must accept a timeout keyword argument. Returns: Callable: The wrapped function. cst|d<||S)z#Wrapped function that adds timeout.r)next)rr)rtimeoutsr r rs z6ExponentialTimeout.__call__..func_with_timeout)r)r+r,r-r.rr)rrrr )rr1r rs zExponentialTimeout.__call__cCsd|j|j|j|jS)NzW)rr+r,r-r.)rr r r rszExponentialTimeout.__str__N) rrrr_DEFAULT_INITIAL_TIMEOUT_DEFAULT_MAXIMUM_TIMEOUT_DEFAULT_TIMEOUT_MULTIPLIER_DEFAULT_DEADLINEr r/rrr r r r r*s r*)r __future__rr rZgoogle.api_corerr2r3r4r5objectrrr)r*r r r r 5s  :(!