o ˷e; @sXdZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZmZmZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZmZm Z m!Z!ddl"m#Z#Gdddej$e Z%GdddeZ&de e%gefde&fddZ'de#de(de)dej*fddZ+eefde,de,de,de,fdd Z-dS)!zEHelpers for applying Google Cloud Firestore changes in a transaction.N)gapic_v1)retry) _BaseTransactionalBaseTransaction MAX_ATTEMPTS _CANT_BEGIN_CANT_ROLLBACK _CANT_COMMIT_WRITE_READ_ONLY_INITIAL_SLEEP _MAX_SLEEP _MULTIPLIER_EXCEED_ATTEMPTS_TEMPLATE) exceptions) async_batch)_helpers)types)AsyncDocumentReference)DocumentSnapshot) AsyncQuery)AnyAsyncGeneratorCallable Coroutine)Clientc seZdZdZedfdfdd Zdeddffdd Zdd eddfd d Z dd dZ defddZ e j jdfdedejdedeeeffddZe j jdfdejdedeeeffddZZS)AsyncTransactionaDAccumulate read-and-write operations to be sent in a transaction. Args: client (:class:`~google.cloud.firestore_v1.client.Client`): The client that created this transaction. max_attempts (Optional[int]): The maximum number of attempts for the transaction (i.e. allowing retries). Defaults to :attr:`~google.cloud.firestore_v1.transaction.MAX_ATTEMPTS`. read_only (Optional[bool]): Flag indicating if the transaction should be read-only or should allow writes. Defaults to :data:`False`. FreturnNcs"tt||t|||dSN)superr__init__r)selfclient max_attempts read_only __class__b/var/www/ideatree/venv/lib/python3.10/site-packages/google/cloud/firestore_v1/async_transaction.pyrBszAsyncTransaction.__init__ write_pbscs"|jrtttt||dS)aAdd `Write`` protobufs to this transaction. Args: write_pbs (List[google.cloud.proto.firestore.v1. write.Write]): A list of write protobufs to be added. Raises: ValueError: If this transaction is read-only. N) _read_only ValueErrorr rr_add_write_pbs)r r(r$r&r'r+Fs zAsyncTransaction._add_write_pbsretry_idcsT|jrt|j}t||jjj|jj| |d|jj dIdH}|j |_dS)zBegin the transaction. Args: retry_id (Optional[bytes]): Transaction ID of a transaction to be retried. Raises: ValueError: If the current transaction has already begun. )databaseoptionsrequestmetadataN) in_progressrformat_idr*_client_firestore_apibegin_transaction_database_string_options_protobuf _rpc_metadata transaction)r r,msgtransaction_responser&r&r'_beginUs  zAsyncTransaction._begincsR|jsttz|jjj|jj|jd|jjdIdHW| dS| w)znRoll back the transaction. Raises: ValueError: If no transaction is in progress. )r-r;r/N) r2r*rr5r6rollbackr8r4r: _clean_up)r r&r&r' _rollbacklszAsyncTransaction._rollbackcs:|jsttt|j|j|jIdH}|t|j S)aTransactionally commit the changes accumulated. Returns: List[:class:`google.cloud.proto.firestore.v1.write.WriteResult`, ...]: The write results corresponding to the changes committed, returned in the same order as the changes were applied to this transaction. A write result contains an ``update_time`` field. Raises: ValueError: If no transaction is in progress. N) r2r*r _commit_with_retryr5 _write_pbsr4r@list write_results)r commit_responser&r&r'_commits    zAsyncTransaction._commit referencesrtimeoutcs,t||}|jj|fd|i|IdHS)atRetrieves multiple documents from Firestore. Args: references (List[.AsyncDocumentReference, ...]): Iterable of document references to be retrieved. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. Defaults to a system-specified policy. timeout (float): The timeout for this request. Defaults to a system-specified value. Yields: .DocumentSnapshot: The next document snapshot that fulfills the query, or :data:`None` if the document does not exist. r;N)rmake_retry_timeout_kwargsr5get_all)r rHrrIkwargsr&r&r'rKs zAsyncTransaction.get_allcsdt||}t|tr|jj|gfd|i|IdHSt|tr.|jdd|i|IdHStd)aW Retrieve a document or a query result from the database. Args: ref_or_query The document references or query object to return. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. Defaults to a system-specified policy. timeout (float): The timeout for this request. Defaults to a system-specified value. Yields: .DocumentSnapshot: The next document snapshot that fulfills the query, or :data:`None` if the document does not exist. r;NzSValue for argument "ref_or_query" must be a AsyncDocumentReference or a AsyncQuery.r&) rrJ isinstancerr5rKrstreamr*)r ref_or_queryrrIrLr&r&r'gets   zAsyncTransaction.getrNr)__name__ __module__ __qualname____doc__rrrDr+bytesr>rArGrmethodDEFAULTretriesRetryfloatrrrrKrP __classcell__r&r&r$r'r4s6     rcsNeZdZdZd fdd ZdedefddZdedefd d Z d d Z Z S)_AsyncTransactionalalProvide a callable object to use as a transactional decorater. This is surfaced via :func:`~google.cloud.firestore_v1.async_transaction.transactional`. Args: to_wrap (Coroutine[[:class:`~google.cloud.firestore_v1.async_transaction.AsyncTransaction`, ...], Any]): A coroutine that should be run (and retried) in a transaction. rNcstt||dSr)rr]r)r to_wrapr$r&r'rsz_AsyncTransactional.__init__r;csp||j|jdIdH|j|_|jdur|j|_z|j|g|Ri|IdHWS|IdH)a;Begin transaction and call the wrapped coroutine. If the coroutine raises an exception, the transaction will be rolled back. If not, the transaction will be "ready" for ``Commit`` (i.e. it will have staged writes). Args: transaction (:class:`~google.cloud.firestore_v1.async_transaction.AsyncTransaction`): A transaction to execute the coroutine within. args (Tuple[Any, ...]): The extra positional arguments to pass along to the wrapped coroutine. kwargs (Dict[str, Any]): The extra keyword arguments to pass along to the wrapped coroutine. Returns: Any: result of the wrapped coroutine. Raises: Exception: Any failure caused by ``to_wrap``. )r,N)r@r>r,r4 current_idr^rA)r r;argsrLr&r&r' _pre_commits  z_AsyncTransactional._pre_commitc sVz |IdHWdStjy*}z|jrt|tjr%WYd}~dSd}~ww)aTry to commit the transaction. If the transaction is read-write and the ``Commit`` fails with the ``ABORTED`` status code, it will be retried. Any other failure will not be caught. Args: transaction (:class:`~google.cloud.firestore_v1.transaction.Transaction`): The transaction to be ``Commit``-ed. Returns: bool: Indicating if the commit succeeded. NTF)rGrGoogleAPICallErrorr)rMAborted)r r;excr&r&r' _maybe_commits z!_AsyncTransactional._maybe_commitcsv|t|jD]}|j|g|Ri|IdH}||IdH}|r)|Sq |IdHt|j}t|)aExecute the wrapped callable within a transaction. Args: transaction (:class:`~google.cloud.firestore_v1.transaction.Transaction`): A transaction to execute the callable within. args (Tuple[Any, ...]): The extra positional arguments to pass along to the wrapped callable. kwargs (Dict[str, Any]): The extra keyword arguments to pass along to the wrapped callable. Returns: Any: The result of the wrapped callable. Raises: ValueError: If the transaction does not succeed in ``max_attempts``. N) _resetrange _max_attemptsrarerArr3r*)r r;r`rLattemptresult succeededr<r&r&r'__call__!s z_AsyncTransactional.__call__rQ) rRrSrTrUrrrraboolrerlr\r&r&r$r'r]s  (r]r^rcCst|S)aDecorate a callable so that it runs in a transaction. Args: to_wrap (Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]): A callable that should be run (and retried) in a transaction. Returns: Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]: the wrapped callable. )r])r^r&r&r'async_transactionalGsrnr!r(transaction_idcsRt} z|jj|j||d|jdIdHWStjy Ynwt|IdH}q)a.Call ``Commit`` on the GAPIC client with retry / sleep. Retries the ``Commit`` RPC on Unavailable. Usually this RPC-level retry is handled by the underlying GAPICd client, but in this case it doesn't because ``Commit`` is not always idempotent. But here we know it is "idempotent"-like because it has a transaction ID. We also need to do our own retry to special-case the ``INVALID_ARGUMENT`` error. Args: client (:class:`~google.cloud.firestore_v1.client.Client`): A client with GAPIC client and configuration details. write_pbs (List[:class:`google.cloud.proto.firestore.v1.write.Write`, ...]): A ``Write`` protobuf instance to be committed. transaction_id (bytes): ID of an existing transaction that this commit will run in. Returns: :class:`google.cloud.firestore_v1.types.CommitResponse`: The protobuf response from ``Commit``. Raises: ~google.api_core.exceptions.GoogleAPICallError: If a non-retryable exception is encountered. T)r-writesr;r/N)r r6commitr8r:rServiceUnavailable_sleep)r!r(ro current_sleepr&r&r'rBYs rBrt max_sleep multipliercs,td|}t|IdHt|||S)aSleep and produce a new sleep time. .. _Exponential Backoff And Jitter: https://www.awsarchitectureblog.com/ 2015/03/backoff.html Select a duration between zero and ``current_sleep``. It might seem counterintuitive to have so much jitter, but `Exponential Backoff And Jitter`_ argues that "full jitter" is the best strategy. Args: current_sleep (float): The current "max" for sleep interval. max_sleep (Optional[float]): Eventual "max" sleep time multiplier (Optional[float]): Multiplier for exponential backoff. Returns: float: Newly doubled ``current_sleep`` or ``max_sleep`` (whichever is smaller) gN)randomuniformasynciosleepmin)rtrurv actual_sleepr&r&r'rss rs).rUryrwgoogle.api_corerrrY*google.cloud.firestore_v1.base_transactionrrrrrr r r r r rrgoogle.cloud.firestore_v1rrr(google.cloud.firestore_v1.async_documentrr%google.cloud.firestore_v1.async_queryrtypingrrrr google.cloud.firestore_v1.clientrAsyncWriteBatchrr]rnrDrVCommitResponserBr[rsr&r&r&r'sT  4        x   .