o ,= j]7@sdZddlmZddlmZmZmZmZmZddl m Z m Z ddl m Z ddlmZmZddlmZmZmZmZmZmZmZmZddlmZdd lmZerddd lZdd lm Z dd l!m"Z"dd l#m$Z$Gdddej%eZ&GdddeZ'dddZ(d S)zEHelpers for applying Google Cloud Firestore changes in a transaction.) annotations) TYPE_CHECKINGAnyCallable GeneratorOptional) exceptionsgapic_v1)retry)_helpersbatch) _CANT_BEGIN _CANT_COMMIT_CANT_ROLLBACK_EXCEED_ATTEMPTS_TEMPLATE_WRITE_READ_ONLY MAX_ATTEMPTSBaseTransaction_BaseTransactional)DocumentReference)QueryN)DocumentSnapshot)ExplainOptions)StreamGeneratorcseZdZdZedfd)fdd Zd*fd d Zd+d,ddZd)ddZd-ddZ e j j d fd dd.ddZ e j j d fd d dd/d'd(ZZS)0 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`. FreturnNonecs"tt||t|||dSN)superr__init__r)selfclientZ max_attemptsZ read_only __class__oC:\Users\psant\Downloads\Anu Raj Backend\school\venv\Lib\site-packages\google/cloud/firestore_v1/transaction.pyr=szTransaction.__init__ write_pbslistcs"|jrtttt||dS)a Add `Write`` protobufs to this transaction. Args: write_pbs (List[google.cloud.firestore_v1. write.Write]): A list of write protobufs to be added. Raises: ValueError: If this transaction is read-only. N) _read_only ValueErrorrrr_add_write_pbs)r r&r"r$r%r*As zTransaction._add_write_pbsNretry_id bytes | NonecCsL|jr t|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_progressr format_idr)_client_firestore_apiZbegin_transaction_database_stringZ_options_protobuf _rpc_metadata transaction)r r+msgZtransaction_responser$r$r%_beginPs  zTransaction._begincCsJ|jsttz|jjj|jj|jd|jjdW| dS| w)zRoll back the transaction. Raises: ValueError: If no transaction is in progress. google.api_core.exceptions.GoogleAPICallError: If the rollback fails. )r-r9r/N) r2r)rr5r6rollbackr7r4r8 _clean_up)r r$r$r% _rollbackgs zTransaction._rollbackcCsV|jstt|jjj|jj|j|jd|jj d}| t |j |_ |j |_ |j S)aTransactionally commit the changes accumulated. Returns: List[:class:`google.cloud.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. )r-Zwritesr9r/N)r2r)rr5r6commitr7Z _write_pbsr4r8r=r'Z write_resultsZ commit_time)r Zcommit_responser$r$r%_commit~s  zTransaction._commit) read_time referencesr retries.Retry | object | Nonetimeout float | NonerAdatetime.datetime | None&Generator[DocumentSnapshot, Any, None]cCs4t||}|dur||d<|jj|fd|i|S)a Retrieves 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. read_time (Optional[datetime.datetime]): If set, reads documents as they were at the given time. This must be a timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. If no timezone is specified in the :class:`datetime.datetime` object, it is assumed to be UTC. Yields: .DocumentSnapshot: The next document snapshot that fulfills the query, or :data:`None` if the document does not exist. NrAr9)r make_retry_timeout_kwargsr5get_all)r rBr rDrAkwargsr$r$r%rIs zTransaction.get_all)explain_optionsrA ref_or_queryDocumentReference | QueryOptional[float]rKOptional[ExplainOptions]Optional[datetime.datetime]JStreamGenerator[DocumentSnapshot] | Generator[DocumentSnapshot, Any, None]cCst||}|dur||d<t|tr(|durtd|jj|gfd|i|St|tr?|dur5||d<|jdd|i|Std)a>Retrieve a document or a query result from the database. Args: ref_or_query (DocumentReference | 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. explain_options (Optional[:class:`~google.cloud.firestore_v1.query_profile.ExplainOptions`]): Options to enable query profiling for this query. When set, explain_metrics will be available on the returned generator. Can only be used when running a query, not a document reference. read_time (Optional[datetime.datetime]): If set, reads documents as they were at the given time. This must be a timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. If no timezone is specified in the :class:`datetime.datetime` object, it is assumed to be UTC. Yields: .DocumentSnapshot: The next document snapshot that fulfills the query, or :data:`None` if the document does not exist. Raises: ValueError: if `ref_or_query` is not one of the supported types, or explain_options is provided when `ref_or_query` is a document reference. NrAz^When type of `ref_or_query` is `AsyncDocumentReference`, `explain_options` cannot be provided.r9rKzIValue for argument "ref_or_query" must be a DocumentReference or a Query.r$) r rH isinstancerr)r5rIrstream)r rLr rDrKrArJr$r$r%gets %  zTransaction.getrr)r&r'rrr)r+r,rr)rr') rBr'r rCrDrErArFrrG) rLrMr rCrDrNrKrOrArPrrQ)__name__ __module__ __qualname____doc__rrr*r;r>r@r methodDEFAULTrIrT __classcell__r$r$r"r%r/s$     "rcs6eZdZdZd fdd Zdd d Zdd d ZZS)_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. rrcstt||dSr)rr]r)r to_wrapr"r$r%rsz_Transactional.__init__r9rrcOsH||j|jd|j|_|jdur|j|_|j|g|Ri|S)amBegin transaction and call the wrapped callable. 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=r;r+r4Z current_idr^)r r9argsrJr$r$r% _pre_commits  z_Transactional._pre_commitc Os||js tjnd}d}z=t|jD],}|j|g|Ri|}z ||WWS|y@}z|}WYd}~qd}~wwt |j} t | |t yW| w)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``. r$N) Z_resetr(rZAbortedrangeZ _max_attemptsr`r@rr3r) BaseExceptionr>) r r9r_rJZretryable_exceptionslast_excattemptresultexcr:r$r$r%__call__s(   z_Transactional.__call__rU)r9rrr)r9r)rVrWrXrYrr`rgr\r$r$r"r%r]s  r]r^rrcCst|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. N)r])r^r$r$r% transactionalOs rh)r^rrr]))rY __future__rtypingrrrrrZgoogle.api_corerr r retriesZgoogle.cloud.firestore_v1r r Z*google.cloud.firestore_v1.base_transactionr rrrrrrrZ"google.cloud.firestore_v1.documentrZgoogle.cloud.firestore_v1.queryrdatetimeZ'google.cloud.firestore_v1.base_documentrZ'google.cloud.firestore_v1.query_profilerZ*google.cloud.firestore_v1.stream_generatorrZ WriteBatchrr]rhr$r$r$r%s$  (    E\