U ~fhB3@sdZddlmZddlmZmZmZmZmZddl m Z GdddZ Gddde Z Gd d d e Z Gd d d e ZGd dde ZGddde ZGdddeZGdddeZdS)z{Result class definitions. .. seealso:: This module is compatible with both the synchronous and asynchronous PyMongo APIs. ) annotations)AnyMappingMutableMappingOptionalcast)InvalidOperationc@sTeZdZdZdZdddddZdd d d Zddd d dZedd ddZ dS) _WriteResultz$Base class for write result classes.)Z__acknowledgedboolNone) acknowledgedreturncCs ||_dSN_WriteResult__acknowledged)selfr r3/tmp/pip-unpacked-wheel-36gvocj8/pymongo/results.py__init__sz_WriteResult.__init__strr cCs|jjd|jdS)N()) __class____name__rrrrr__repr__"sz_WriteResult.__repr__ property_namer cCs|jstd|ddS)z8Raise an exception on property access if unacknowledged. A value for zi is not available when the write is unacknowledged. Check the acknowledged attribute to avoid this error.N)rrrrrrr_raise_if_unacknowledged%s z%_WriteResult._raise_if_unacknowledgedcCs|jS)aCIs this the result of an acknowledged write operation? The :attr:`acknowledged` attribute will be ``False`` when using ``WriteConcern(w=0)``, otherwise ``True``. .. note:: If the :attr:`acknowledged` attribute is ``False`` all other attributes of this class will raise :class:`~pymongo.errors.InvalidOperation` when accessed. Values for other attributes cannot be determined if the write operation was unacknowledged. .. seealso:: :class:`~pymongo.write_concern.WriteConcern` rrrrrr /sz_WriteResult.acknowledgedN) r __module__ __qualname____doc__ __slots__rrr!propertyr rrrrr s r csNeZdZdZdZddddfdd Zd d d d Zedd d dZZ S)InsertOneResultzThe return type for :meth:`~pymongo.collection.Collection.insert_one` and as part of :meth:`~pymongo.mongo_client.MongoClient.bulk_write`. )Z __inserted_idrr r ) inserted_idr r cs||_t|dSr)_InsertOneResult__inserted_idsuperr)rr(r rrrrJszInsertOneResult.__init__rrcCs|jjd|jd|jdSNrz, acknowledged=r)rrr)r rrrrrNszInsertOneResult.__repr__cCs|jS)zThe inserted document's _id.)r)rrrrr(SszInsertOneResult.inserted_id) rr"r#r$r%rrr&r( __classcell__rrr+rr'Cs r'csNeZdZdZdZddddfdd Zd d d d Zedd d dZZ S)InsertManyResultzGThe return type for :meth:`~pymongo.collection.Collection.insert_many`.)Z__inserted_idsz list[Any]r r ) inserted_idsr r cs||_t|dSr)_InsertManyResult__inserted_idsr*r)rr/r r+rrr^szInsertManyResult.__init__rrcCs|jjd|jd|jdSr,)rrr0r rrrrrbszInsertManyResult.__repr__cCs|jS)a@A list of _ids of the inserted documents, in the order provided. .. note:: If ``False`` is passed for the `ordered` parameter to :meth:`~pymongo.collection.Collection.insert_many` the server may have inserted the documents in a different order than what is presented here. )r0rrrrr/gs zInsertManyResult.inserted_ids) rr"r#r$r%rrr&r/r-rrr+rr.Ys r.cseZdZdZdZdddddfdd Zd d d d Zedd d dZedd ddZ edd ddZ edd ddZ edd ddZ Z S) UpdateResultaThe return type for :meth:`~pymongo.collection.Collection.update_one`, :meth:`~pymongo.collection.Collection.update_many`, and :meth:`~pymongo.collection.Collection.replace_one`, and as part of :meth:`~pymongo.mongo_client.MongoClient.bulk_write`. ) __raw_resultZ__in_client_bulkFzOptional[Mapping[str, Any]]r ) raw_resultr in_client_bulkcs||_||_t|dSr)_UpdateResult__raw_result_UpdateResult__in_client_bulkr*r)rr3r r4r+rrrszUpdateResult.__init__rrcCs|jjd|jd|jdSr,)rrr5r rrrrrszUpdateResult.__repr__cCs|jSz/The raw result document returned by the server.)r5rrrrr3szUpdateResult.raw_resultintcCs:|d|jdk st|js,|jdk r,dS|jddS)z0The number of documents matched for this update. matched_countNrn)r!r5AssertionErrorr6 upserted_idgetrrrrr9s  zUpdateResult.matched_countcCs*|d|jdk sttt|jdS)!The number of documents modified.modified_countN nModified)r!r5r;rr8r=rrrrr?s zUpdateResult.modified_countrcCsF|d|jdk st|jr8|jdr8|jddS|jddS)z^The _id of the inserted document if an upsert took place. Otherwise ``None``. r<Nupserted_id)r!r5r;r6r=rrrrr<s  zUpdateResult.upserted_idcCs|jdk std|jkS)zEWhether an upsert took place. .. versionadded:: 4.9 NrA)r5r;rrrr did_upsertszUpdateResult.did_upsert)F)rr"r#r$r%rrr&r3r9r?r<rCr-rrr+rr1ss   r1cs`eZdZdZdZddddfdd Zd d d d Zedd d dZedd ddZ Z S) DeleteResultzThe return type for :meth:`~pymongo.collection.Collection.delete_one` and :meth:`~pymongo.collection.Collection.delete_many` and as part of :meth:`~pymongo.mongo_client.MongoClient.bulk_write`. )r2zMapping[str, Any]r r )r3r r cs||_t|dSr)_DeleteResult__raw_resultr*r)rr3r r+rrrszDeleteResult.__init__rrcCs|jjd|jd|jdSr,)rrrEr rrrrrszDeleteResult.__repr__cCs|jSr7)rErrrrr3szDeleteResult.raw_resultr8cCs|d|jddS) The number of documents deleted. deleted_countr:r)r!rEr=rrrrrGs zDeleteResult.deleted_count) rr"r#r$r%rrr&r3rGr-rrr+rrDsrDcseZdZdZdZddddfdd Zd d d d Zedd d dZedd ddZ edd ddZ edd ddZ edd ddZ edd ddZ ZS)_BulkWriteResultBasez.Private base class for bulk write API results.)Z__bulk_api_resultdict[str, Any]r r bulk_api_resultr r cs||_t|dSr)%_BulkWriteResultBase__bulk_api_resultr*rrrKr r+rrrsz_BulkWriteResultBase.__init__rrcCs|jjd|jd|jdSr,)rrrLr rrrrrsz_BulkWriteResultBase.__repr__cCs|jS)zThe raw bulk write API result.)rLrrrrrKsz$_BulkWriteResultBase.bulk_api_resultr8cCs|dtt|jdS)z!The number of documents inserted.inserted_countZ nInsertedr!rr8rLr=rrrrrNs z#_BulkWriteResultBase.inserted_countcCs|dtt|jdS)z.The number of documents matched for an update.r9ZnMatchedrOrrrrr9s z"_BulkWriteResultBase.matched_countcCs|dtt|jdS)r>r?r@rOrrrrr?s z#_BulkWriteResultBase.modified_countcCs<|dd|jkr&tt|jdStt|jdSdS)rFrGZnRemovedZnDeletedN)r!rLrr8r=rrrrrGs  z"_BulkWriteResultBase.deleted_countcCs|dtt|jdS)z!The number of documents upserted.upserted_countZ nUpsertedrOrrrrrPs z#_BulkWriteResultBase.upserted_count)rr"r#r$r%rrr&rKrNr9r?rGrPr-rrr+rrHs rHcsNeZdZdZdZddddfdd Zd d d d Zed d ddZZ S)BulkWriteResultz>An object wrapper for collection-level bulk write API results.rrIr r rJcst||dS)a@Create a BulkWriteResult instance. :param bulk_api_result: A result dict from the collection-level bulk write API :param acknowledged: Was this write result acknowledged? If ``False`` then all properties of this object will raise :exc:`~pymongo.errors.InvalidOperation`. N)r*rrMr+rrr szBulkWriteResult.__init__rrcCs|jjd|jd|jdSr,)rrrKr rrrrrszBulkWriteResult.__repr__zOptional[dict[int, Any]]cCs(|d|jr$dd|jdDSdS)z=A map of operation index to the _id of the upserted document. upserted_idscSsi|]}|d|dqS)indexrBr).0Zupsertrrr sz0BulkWriteResult.upserted_ids..rAN)r!rKrrrrrRs zBulkWriteResult.upserted_ids) rr"r#r$r%rrr&rRr-rrr+rrQs  rQcseZdZdZdZdddddfdd Zd d d d Zd dd ddZedd ddZ edd ddZ edd ddZ edd ddZ Z S)ClientBulkWriteResultz:An object wrapper for client-level bulk write API results.)Z__has_verbose_resultszMutableMapping[str, Any]r r )rKr has_verbose_resultsr cs||_t||dS)aUCreate a ClientBulkWriteResult instance. :param bulk_api_result: A result dict from the client-level bulk write API :param acknowledged: Was this write result acknowledged? If ``False`` then all properties of this object will raise :exc:`~pymongo.errors.InvalidOperation`. :param has_verbose_results: Should the returned result be verbose? If ``False``, then the ``insert_results``, ``update_results``, and ``delete_results`` properties of this object will raise :exc:`~pymongo.errors.InvalidOperation`. N)+_ClientBulkWriteResult__has_verbose_resultsr*r)rrKr rWr+rrr&s zClientBulkWriteResult.__init__rrcCsd|jj|j|j|jS)Nz%{}({!r}, acknowledged={}, verbose={}))formatrrrKr rWrrrrr=s zClientBulkWriteResult.__repr__rcCs|jstd|ddS)zARaise an exception on property access if verbose results are off.rzv is not available when the results are not set to be verbose. Check the verbose_results attribute to avoid this error.N)rXrr rrr_raise_if_not_verboseEs z+ClientBulkWriteResult._raise_if_not_verbosecCs|jS)z/Whether the returned results should be verbose.)rXrrrrrWNsz)ClientBulkWriteResult.has_verbose_resultszMapping[int, InsertOneResult]cCs.|d|dttttf|jdS)z:A map of successful insertion operations to their results.insert_resultsZ insertResults)r!rZrrr8r'rKr=rrrrr[Ss     z$ClientBulkWriteResult.insert_resultszMapping[int, UpdateResult]cCs.|d|dttttf|jdS)z7A map of successful update operations to their results.update_resultsZ updateResults)r!rZrrr8r1rKr=rrrrr\]s     z$ClientBulkWriteResult.update_resultszMapping[int, DeleteResult]cCs.|d|dttttf|jdS)z7A map of successful delete operations to their results.delete_resultsZ deleteResults)r!rZrrr8rDrKr=rrrrr]gs     z$ClientBulkWriteResult.delete_results)rr"r#r$r%rrrZr&rWr[r\r]r-rrr+rrV!s   rVN)r$ __future__rtypingrrrrrZpymongo.errorsrr r'r.r1rDrHrQrVrrrrs  )C3