o
    ABi<                     @  s  d Z ddlmZ ddlmZmZmZmZmZm	Z	m
Z
 ddlmZ ddlmZ ddlmZmZmZmZ ddlmZ ddlmZ dd	lmZ dd
lmZ ddlmZ ddlmZ ddl m!Z! ddl"m#Z$ ddl%m&Z' ddl(m)Z) erzddl*m+Z+ ddl,Z,G dd deZ-dS )a  Client for interacting with the Google Cloud Firestore API.

This is the base from which all interactions with the API occur.

In the hierarchy of API concepts

* a :class:`~google.cloud.firestore_v1.client.Client` owns a
  :class:`~google.cloud.firestore_v1.collection.CollectionReference`
* a :class:`~google.cloud.firestore_v1.client.Client` owns a
  :class:`~google.cloud.firestore_v1.document.DocumentReference`
    )annotations)TYPE_CHECKINGAny	GeneratorIterableListOptionalUnion)gapic_v1)retry)_CLIENT_INFO
BaseClient_parse_batch_get_path_helper)DocumentSnapshot)MAX_ATTEMPTS
WriteBatch)CollectionReference)DocumentReference)	FieldPath)CollectionGroup)client)grpcTransaction)
BulkWriterNc                      s   e Zd ZdZdddedfdC fddZedd ZdDddZdEddZ	dFddZ
ddejjdfdddGd$d%ZejjdfdddHd'd(Zdd)d*dId1d2Zd)d3d4dJd7d8ZdKd:d;Zed<fdLdAdBZ  ZS )MClienta  Client for interacting with Google Cloud Firestore API.

    .. note::

        Since the Cloud Firestore API requires the gRPC transport, no
        ``_http`` argument is accepted by this class.

    Args:
        project (Optional[str]): The project which the client acts on behalf
            of. If not passed, falls back to the default inferred
            from the environment.
        credentials (Optional[~google.auth.credentials.Credentials]): The
            OAuth2 Credentials to use for this client. If not passed, falls
            back to the default inferred from the environment.
        database (Optional[str]): The database name that the client targets.
            If not passed, falls back to :attr:`DEFAULT_DATABASE`.
        client_info (Optional[google.api_core.gapic_v1.client_info.ClientInfo]):
            The client info used to send a user-agent string along with API
            requests. If ``None``, then default info will be used. Generally,
            you only need to set this if you're developing your own library
            or partner tool.
        client_options (Union[dict, google.api_core.client_options.ClientOptions]):
            Client options used to set user options on the client. API Endpoint
            should be set through client_options.
    NreturnNonec                   s   t t| j|||||d d S )N)projectcredentialsdatabaseclient_infoclient_options)superr   __init__)selfr    r!   r"   r#   r$   	__class__ `/var/www/html/Trade-python/venv/lib/python3.10/site-packages/google/cloud/firestore_v1/client.pyr&   V   s   

zClient.__init__c                 C  s   |  tjtjtS )zLazy-loading getter GAPIC Firestore API.
        Returns:
            :class:`~google.cloud.gapic.firestore.v1`.firestore_client.FirestoreClient:
            The GAPIC client with the credentials of the current client.
        )_firestore_api_helperfirestore_grpc_transportFirestoreGrpcTransportfirestore_clientFirestoreClientr'   r*   r*   r+   _firestore_apif   s
   zClient._firestore_apicollection_pathstrr   c                 G  s   t t|d| iS )a  Get a reference to a collection.

        For a top-level collection:

        .. code-block:: python

            >>> client.collection('top')

        For a sub-collection:

        .. code-block:: python

            >>> client.collection('mydocs/doc/subcol')
            >>> # is the same as
            >>> client.collection('mydocs', 'doc', 'subcol')

        Sub-collections can be nested deeper in a similar fashion.

        Args:
            collection_path: Can either be

                * A single ``/``-delimited path to a collection
                * A tuple of collection path segments

        Returns:
            :class:`~google.cloud.firestore_v1.collection.CollectionReference`:
            A reference to a collection in the Firestore database.
        r   )r   r   )r'   r3   r*   r*   r+   
collections   s   zClient.collectioncollection_idr   c                 C  s   t | |S )a  
        Creates and returns a new Query that includes all documents in the
        database that are contained in a collection or subcollection with the
        given collection_id.

        .. code-block:: python

            >>> query = client.collection_group('mygroup')

        Args:
            collection_id (str) Identifies the collections to query over.

                Every collection or subcollection with this ID as the last segment of its
                path will be included. Cannot contain a slash.

        Returns:
            :class:`~google.cloud.firestore_v1.query.CollectionGroup`:
            The created Query.
        )r   _get_collection_reference)r'   r6   r*   r*   r+   collection_group   s   zClient.collection_groupdocument_pathr   c                 G  s   t | j| d| iS )a}  Get a reference to a document in a collection.

        For a top-level document:

        .. code-block:: python

            >>> client.document('collek/shun')
            >>> # is the same as
            >>> client.document('collek', 'shun')

        For a document in a sub-collection:

        .. code-block:: python

            >>> client.document('mydocs/doc/subcol/child')
            >>> # is the same as
            >>> client.document('mydocs', 'doc', 'subcol', 'child')

        Documents in sub-collections can be nested deeper in a similar fashion.

        Args:
            document_path): Can either be

                * A single ``/``-delimited path to a document
                * A tuple of document path segments

        Returns:
            :class:`~google.cloud.firestore_v1.document.DocumentReference`:
            A reference to a document in a collection.
        r   )r   _document_path_helper)r'   r9   r*   r*   r+   document   s
   zClient.document)	read_time
referenceslistfield_pathsIterable[str] | NonetransactionTransaction | Noner   retries.Retry | object | Nonetimeoutfloat | Noner<   datetime.datetime | None&Generator[DocumentSnapshot, Any, None]c                c  sR    |  ||||||\}}}	| jjd|| jd|	}
|
D ]	}t||| V  qdS )a7  Retrieve a batch of documents.

        .. note::

           Documents returned by this method are not guaranteed to be
           returned in the same order that they are given in ``references``.

        .. note::

           If multiple ``references`` refer to the same document, the server
           will only return one result.

        See :meth:`~google.cloud.firestore_v1.client.Client.field_path` for
        more information on **field paths**.

        If a ``transaction`` is used and it already has write operations
        added, this method cannot be used (i.e. read-after-write is not
        allowed).

        Args:
            references (List[.DocumentReference, ...]): Iterable of document
                references to be retrieved.
            field_paths (Optional[Iterable[str, ...]]): An iterable of field
                paths (``.``-delimited list of field names) to use as a
                projection of document fields in the returned results. If
                no value is provided, all fields will be returned.
            transaction (Optional[:class:`~google.cloud.firestore_v1.transaction.Transaction`]):
                An existing transaction that these ``references`` will be
                retrieved in.
            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.
        requestmetadataNr*   )_prep_get_allr2   batch_get_documents_rpc_metadatar   )r'   r=   r?   rA   r   rD   r<   rI   reference_mapkwargsresponse_iteratorget_doc_responser*   r*   r+   get_all   s   4
zClient.get_allGenerator[Any, Any, None]c                c  sH    |  |||\}}| jjd|| jd|}|D ]}| |V  qdS )a  List top-level collections of the client's database.

        Args:
            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.

        Returns:
            Sequence[:class:`~google.cloud.firestore_v1.collection.CollectionReference`]:
                iterator of subcollections of the current document.
        rH   Nr*   )_prep_collectionsr2   list_collection_idsrM   r5   )r'   r   rD   r<   rI   rO   iteratorr6   r*   r*   r+   collections  s   zClient.collectionsi  )bulk_writer
chunk_size	reference-Union[CollectionReference, DocumentReference]rX   Optional['BulkWriter']rY   intc                C  s    |du r|   }| j|||dS )aU  Deletes documents and their subcollections, regardless of collection
        name.

        Passing a CollectionReference leads to each document in the collection
        getting deleted, as well as all of their descendents.

        Passing a DocumentReference deletes that one document and all of its
        descendents.

        Args:
            reference (Union[
                :class:`@google.cloud.firestore_v1.collection.CollectionReference`,
                :class:`@google.cloud.firestore_v1.document.DocumentReference`,
            ])
                The reference to be deleted.

            bulk_writer (Optional[:class:`@google.cloud.firestore_v1.bulk_writer.BulkWriter`])
                The BulkWriter used to delete all matching documents. Supply this
                if you want to override the default throttling behavior.

        N)rY   )rX   _recursive_delete)r'   rZ   rX   rY   r*   r*   r+   recursive_delete.  s   zClient.recursive_deleter   rY   depth'BulkWriter'ra   c          	      C  s   d}t |tr'| t g|D ]}|D ]}|d7 }||j qqn,t |t	rJ|
 D ]}|| j||||d d7 }q0|d7 }|| n	td|jj |dkr[|  |S )z'Recursion helper for `recursive_delete.r      r`   zUnexpected type for reference: )
isinstancer   	recursiveselectr   document_id	_chunkifydeleterZ   r   rW   r^   	TypeErrorr)   __name__close)	r'   rZ   rX   rY   ra   num_deletedchunkdoc_snapcol_refr*   r*   r+   r^   S  s6   




zClient._recursive_deleter   c                 C  s   t | S )zGet a batch instance from this client.

        Returns:
            :class:`~google.cloud.firestore_v1.batch.WriteBatch`:
            A "write" batch to be used for accumulating document changes and
            sending the changes all at once.
        r   r1   r*   r*   r+   batch  s   zClient.batchFmax_attempts	read_onlyboolr   c                 C  s   t | ||dS )aD  Get a transaction that uses this client.

        See :class:`~google.cloud.firestore_v1.transaction.Transaction` for
        more information on transactions and the constructor arguments.

        Args:
            kwargs (Dict[str, Any]): The keyword arguments (other than
                ``client``) to pass along to the
                :class:`~google.cloud.firestore_v1.transaction.Transaction`
                constructor.

        Returns:
            :class:`~google.cloud.firestore_v1.transaction.Transaction`:
            A transaction attached to this client.
        )rr   rs   r   )r'   rr   rs   r*   r*   r+   rA     s   zClient.transaction)r   r   )r3   r4   r   r   )r6   r4   r   r   )r9   r4   r   r   )r=   r>   r?   r@   rA   rB   r   rC   rD   rE   r<   rF   r   rG   )r   rC   rD   rE   r<   rF   r   rS   )rZ   r[   rX   r\   rY   r]   r   r]   )
rZ   r[   rX   rb   rY   r]   ra   r]   r   r]   )r   r   )rr   r]   rs   rt   r   r   )rk   
__module____qualname____doc__r   r&   propertyr2   r5   r8   r;   r
   methodDEFAULTrR   rW   r_   r^   rq   r   rA   __classcell__r*   r*   r(   r+   r   ;   sD    



&C&*
.r   ).rw   
__future__r   typingr   r   r   r   r   r   r	   google.api_corer
   r   retries%google.cloud.firestore_v1.base_clientr   r   r   r   'google.cloud.firestore_v1.base_documentr   *google.cloud.firestore_v1.base_transactionr   google.cloud.firestore_v1.batchr   $google.cloud.firestore_v1.collectionr   "google.cloud.firestore_v1.documentr   $google.cloud.firestore_v1.field_pathr   google.cloud.firestore_v1.queryr   ,google.cloud.firestore_v1.services.firestorer   r/   7google.cloud.firestore_v1.services.firestore.transportsr   r-   %google.cloud.firestore_v1.transactionr   %google.cloud.firestore_v1.bulk_writerr   datetimer   r*   r*   r*   r+   <module>   s(   $