o )@s&dZddlmZddlmZddlmZddlZddlZddlmZddl m Z ddl m Z dd l mZddlZd ZGd d d e jZGd dde jZGddde jZGdddeejeZGdddeZGdddeZ          d"ddZ       d#ddZd d!ZdS)$z-Utilities to support long running operations.)absolute_import)division)unicode_literalsN)encoding) exceptions)progress_tracker)retryzThe operations may still be underway remotely and may still succeed; use gcloud list and describe commands or https://console.developers.google.com/ to check resource state.c@ eZdZdS) TimeoutErrorN__name__ __module__ __qualname__rr?/tmp/google-cloud-sdk/lib/googlecloudsdk/api_lib/util/waiter.pyr &r c@r )AbortWaitErrorNr rrrrr*rrc@r )OperationErrorNr rrrrr.rrc@s:eZdZdZejddZejddZejddZdS) OperationPolleraInterface for defining operation which can be polled and waited on. This construct manages operation_ref, operation and result abstract objects. Operation_ref is an identifier for operation which is a proxy for result object. OperationPoller has three responsibilities: 1. Given operation object determine if it is done. 2. Given operation_ref fetch operation object 3. Given operation object fetch result object cCdS)zGiven result of Poll determines if result is done. Args: operation: object representing operation returned by Poll method. Returns: Trself operationrrrIsDone= zOperationPoller.IsDonecCr)zRetrieves operation given its reference. Args: operation_ref: str, some id for operation. Returns: object which represents operation. Nr)r operation_refrrrPollIrzOperationPoller.PollcCr)zGiven operation message retrieves result it represents. Args: operation: object, representing operation returned by Poll method. Returns: some object created by given operation. Nrrrrr GetResultUs zOperationPoller.GetResultN) r r r__doc__abcabstractmethodrrrrrrrr2s   rc@s0eZdZdZddZddZddZdd Zd S) CloudOperationPollerzlManages a longrunning Operations. See https://cloud.google.com/speech/reference/rpc/google.longrunning cCs||_||_dS)aSets up poller for cloud operations. Args: result_service: apitools.base.py.base_api.BaseApiService, api service for retrieving created result of initiated operation. operation_service: apitools.base.py.base_api.BaseApiService, api service for retrieving information about ongoing operation. Note that result_service and operation_service Get request must have single attribute called 'name'. N)result_serviceoperation_service)rr"r#rrr__init__gs zCloudOperationPoller.__init__cC |jr|jr t|jjdSdSz Overrides.TFdoneerrorrmessagerrrrrv  zCloudOperationPoller.IsDonecCs"|jd}|j||dSzOverrides. Args: operation_ref: googlecloudsdk.core.resources.Resource. Returns: fetched operation message. Getname)r#GetRequestTyper- RelativeNamerr request_typerrrr~s  zCloudOperationPoller.PollcCs.|jd}t|j}|j||ddS)zOverrides. Args: operation: api_name_messages.Operation. Returns: result of result_service.Get request. r-r/r.)r"r0rMessageToPyValueresponser-)rrr3 response_dictrrrrs zCloudOperationPoller.GetResultNr r rrr$rrrrrrrr!as  r!c@s2eZdZdZd ddZddZddZd d ZdS) CloudOperationPollerNoResourceszManages longrunning Operations for Cloud API that creates no resources. See https://cloud.google.com/speech/reference/rpc/google.longrunning NcCs||_|pdd|_dS)a3Sets up poller for cloud operations. Args: operation_service: apitools.base.py.base_api.BaseApiService, api service for retrieving information about ongoing operation. Note that the operation_service Get request must have a single attribute called 'name'. get_name_func: the function to use to get the name from the operation_ref. This is to allow polling with non-traditional operation resource names. If the resource name is compatible with gcloud parsing, use `lambda x: x.RelativeName()`. cSs|SN)r1)xrrrsz:CloudOperationPollerNoResources.__init__..N)r#get_name)rr# get_name_funcrrrr$sz(CloudOperationPollerNoResources.__init__cCr%r&r'rrrrrr+z&CloudOperationPollerNoResources.IsDonecCs$|jd}|j|||dSr,)r#r0r-r<r2rrrrs z$CloudOperationPollerNoResources.PollcCs|jS)zOverrides to get the response from the completed operation. Args: operation: api_name_messages.Operation. Returns: the 'response' field of the Operation. )r5rrrrrs z)CloudOperationPollerNoResources.GetResultr9r7rrrrr8s   r8@wffffff? c  sd|} z6|stj|| dn|!|rt|fdd} t|||||| | | | }Wdn1s5wYWn/tjyNtd||dttj yj}ztd||j j d|j j td}~ww| |S) aAWaits for poller.Poll and displays pending operation spinner. Args: poller: OperationPoller, poller to use during retrials. operation_ref: object, passed to operation poller poll method. message: str, string to display for default progress_tracker. custom_tracker: ProgressTracker, progress_tracker to use for display. tracker_update_func: func(tracker, result, status), tracker update function. pre_start_sleep_ms: int, Time to wait before making first poll request. max_retrials: int, max number of retrials before raising RetryException. max_wait_ms: int, number of ms to wait before raising WaitException. exponential_sleep_multiplier: float, factor to use on subsequent retries. jitter_ms: int, random (up to the value) additional sleep between retries. wait_ceiling_ms: int, Maximum wait between retries. sleep_ms: int or iterable: for how long to wait between trials. Returns: poller.GetResult(operation). Raises: AbortWaitError: if ctrl-c was pressed. TimeoutError: if retryer has finished without being done. z!Aborting wait for operation {0}. )aborted_messagecs r ||dSdSr9)Tick)resultstatustrackertracker_update_funcrr _StatusUpdates zWaitFor.._StatusUpdateNz2Operation {0} has not finished in {1} seconds. {2}r>zIOperation {0} has not finished in {1} seconds after max {2} retrials. {3})formatrProgressTracker_SleepMs PollUntilDoner WaitExceptionr _TIMEOUT_MESSAGEMaxRetrialsExceptionstatetime_passed_msretrialr)pollerrr*custom_trackerrIpre_start_sleep_ms max_retrials max_wait_msexponential_sleep_multiplier jitter_mswait_ceiling_mssleep_msrCrJrerrGrWaitForsH #  r_c s<tj||||||d} fdd} | jj|f| |d} | S)aWaits for poller.Poll to complete. Note that this *does not* print nice messages to stderr for the user; most callers should use WaitFor instead for the best UX unless there's a good reason not to print. Args: poller: OperationPoller, poller to use during retrials. operation_ref: object, passed to operation poller poll method. max_retrials: int, max number of retrials before raising RetryException. max_wait_ms: int, number of ms to wait before raising WaitException. exponential_sleep_multiplier: float, factor to use on subsequent retries. jitter_ms: int, random (up to the value) additional sleep between retries. wait_ceiling_ms: int, Maximum wait between retries. sleep_ms: int or iterable: for how long to wait between trials. status_update: func(result, state) called right after each trial. Returns: The return value from poller.Poll. )rXrYrZr[r\status_update_funccs | Sr9)r)r unused_staterUrr _IsNotDone?s z!PollUntilDone.._IsNotDone)funcargsshould_retry_ifr])rRetryer RetryOnResultr) rUrrXrYrZr[r\r] status_updateretryerrcrrrbrrNs  rNcCst|ddS)Nr>)timesleep) milisecondsrrrrMKsrM) NNNr>Nr?r@r>rArB)Nr?r@r>rArBN)r __future__rrrrrkapitools.base.pyrgooglecloudsdk.corergooglecloudsdk.core.consolergooglecloudsdk.core.utilrsixrPErrorr rrwith_metaclassABCMetaobjectrr!r8r_rNrMrrrrsN       /8< H 1