o ˷e~@shdZddlmZddlZddlZddlmZdZdZdZ dZ Gdd d e Z d d Z Gd d d e ZdS)agDecorators for applying timeout arguments to functions. These decorators are used to wrap API methods to apply either a constant or exponential 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@s*eZdZdZd ddZddZddZdS) ConstantTimeoutaPA decorator that adds a constant timeout argument. 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 ||_dSN_timeout)selftimeoutr N/var/www/ideatree/venv/lib/python3.10/site-packages/google/api_core/timeout.py__init__Qs zConstantTimeout.__init__cstfdd}|S)Apply 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<|i|Sz#Wrapped function that adds timeout.r rargskwargsfuncrr r func_with_timeout_s z3ConstantTimeout.__call__..func_with_timeout) functoolswrapsrrrr rr __call__Ts zConstantTimeout.__call__cCs d|jS)Nz )formatrrr r r __str__gs zConstantTimeout.__str__r)__name__ __module__ __qualname____doc__r rrr r r r rEs   rccsX|durttj|d}ntjj}|} t}t||t||jV||}q)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)rutcnowdatetime timedeltamaxminfloatr )initialmaximum multiplierdeadlinedeadline_datetimer nowr r r _exponential_timeout_generatorks    r-c@s:eZdZdZeeeefddZddZ ddZ dd Z d S) ExponentialTimeoutaA decorator that adds an exponentially increasing timeout argument. 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 conjuction with :mod:`google.api_core.retry`. If ``None``, the timeouts will not be adjusted to accomodate an overall deadline. cCs||_||_||_||_dSr)_initial_maximum _multiplier _deadline)rr'r(r)r*r r r r s zExponentialTimeout.__init__cCst|j|j|j|dS)zReturn a copy of this teimout 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/r0r1)rr*r r r with_deadlines  z ExponentialTimeout.with_deadlinecs2t|j|j|j|jtfdd}|S)r cst|d<|i|Sr)nextrrtimeoutsr r rs z6ExponentialTimeout.__call__..func_with_timeout)r-r/r0r1r2rrrr r5r rs  zExponentialTimeout.__call__cCsd|j|j|j|jS)NzW)rr/r0r1r2rr r r rs zExponentialTimeout.__str__N) rrrr_DEFAULT_INITIAL_TIMEOUT_DEFAULT_MAXIMUM_TIMEOUT_DEFAULT_TIMEOUT_MULTIPLIER_DEFAULT_DEADLINEr r3rrr r r r r.s   r.)r __future__rr"rgoogle.api_corerr7r8r9r:objectrr-r.r r r r s ' &!