a !f9@s0dZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZmZmZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lm Z m!Z!m"Z"m#Z#Gdddej$e Z%GdddeZ&e!e&dddZ'e(e)edddZ*eefe+e+e+e+dddZ,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)batch)DocumentReference)_helpers)Query)DocumentSnapshot)CommitResponse)AnyCallable GeneratorOptionalcseZdZdZedfddfdd Zeddfdd Zdedd d d Z ddd dZ edddZ e j jdfeejeeeedfdddZe j jdfejeeeedfdddZZS) TransactionaDAccumulate 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`. FNreturncs"tt||t|||dSN)superr__init__r)selfclientZ max_attemptsZ read_only __class__f/var/www/html/python-backend/venv/lib/python3.9/site-packages/google/cloud/firestore_v1/transaction.pyr@szTransaction.__init__) write_pbsrcs"|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)Ds zTransaction._add_write_pbs)retry_idrcCsL|jrt|j}t||jjj|jj| |d|jj d}|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_apiZbegin_transaction_database_stringZ_options_protobuf _rpc_metadata transaction)r r*msgZtransaction_responser$r$r%_beginSs  zTransaction._begincCsL|jsttz.|jjj|jj|jd|jjdW| n | 0dS)znRoll back the transaction. Raises: ValueError: If no transaction is in progress. )r+r7r-N) r0r(rr3r4rollbackr5r2r6 _clean_up)r r$r$r% _rollbackjszTransaction._rollbackcCs2|jsttt|j|j|j}|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. ) r0r(r _commit_with_retryr3Z _write_pbsr2r;listZ write_results)r Zcommit_responser$r$r%_commits zTransaction._commit) referencesrtimeoutrcCs$t||}|jj|fd|i|S)aoRetrieves multiple documents from Firestore. Args: references (List[.DocumentReference, ...]): 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. r7)rmake_retry_timeout_kwargsr3get_all)r r@rrAkwargsr$r$r%rCs zTransaction.get_all)rrArcCsZt||}t|tr0|jj|gfd|i|St|trN|jfd|i|StddS)aORetrieve 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. r7zIValue for argument "ref_or_query" must be a DocumentReference or a Query.N) rrB isinstancerr3rCrstreamr()r Z ref_or_queryrrArDr$r$r%gets   zTransaction.get)N)__name__ __module__ __qualname____doc__rrr>r)bytesr9r<r?rmethodDEFAULTretriesRetryfloatrrrrCrG __classcell__r$r$r"r%r2s*   rcsXeZdZdZddfdd ZeedddZeee dd d Z ed d d Z Z S)_TransactionalaYProvide a callable object to use as a transactional decorater. This is surfaced via :func:`~google.cloud.firestore_v1.transaction.transactional`. Args: to_wrap (Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]): A callable that should be run (and retried) in a transaction. Nrcstt||dSr)rrSr)r to_wrapr"r$r%rsz_Transactional.__init__)r7rcOsf||j|jd|j|_|jdur0|j|_z|j|g|Ri|WS|Yn0dS)a*Begin transaction and call the wrapped callable. If the callable 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.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: result of the wrapped callable. Raises: Exception: Any failure caused by ``to_wrap``. )r*N)r;r9r*r2Z current_idrTr<)r r7argsrDr$r$r% _pre_commits z_Transactional._pre_commitc Cs^z|WdStjyX}z0|jr(t|tjrBWYd}~dSWYd}~n d}~00dS)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. TNF)r?rZGoogleAPICallErrorr'rEZAborted)r r7excr$r$r% _maybe_commits z_Transactional._maybe_commit)r7cOsf|t|jD]2}|j|g|Ri|}||}|r|Sq|t|j}t|dS)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) _resetrangeZ _max_attemptsrVrXr<rr1r()r r7rUrDattemptresultZ succeededr8r$r$r%__call__s   z_Transactional.__call__) rHrIrJrKrrrrVrboolrXr]rRr$r$r"r%rSs  &rS)rTrcCst|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. )rS)rTr$r$r% transactional>s r_)r&transaction_idrcCsFt}z|jj|j||d|jdWStjy6Yn0t|}qdS)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. )r+Zwritesr7r-N)r r4commitr5r6rZServiceUnavailable_sleep)r!r&r` current_sleepr$r$r%r=Msr=)rc max_sleep multiplierrcCs$td|}t|t|||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) g)randomuniformtimesleepmin)rcrdreZ actual_sleepr$r$r%rbzs  rb)-rKrfrhZgoogle.api_corerrrOZ*google.cloud.firestore_v1.base_transactionrrrrrr r r r r rrZgoogle.cloud.firestore_v1rZ"google.cloud.firestore_v1.documentrrZgoogle.cloud.firestore_v1.queryrZ'google.cloud.firestore_v1.base_documentrZgoogle.cloud.firestore_v1.typesrtypingrrrrZ WriteBatchrrSr_r>rLr=rQrbr$r$r$r%s2  4       v .