U ~fh)@sUdZddlmZddlZddlZddlZddlmZddl m Z m Z m Z m Z mZmZmZmZmZddlZddlmZmZmZddlmZddlmZmZmZmZdd lmZdd l m!Z!zdd l"m#Z#d Z$Wne%k rd Z$YnXddl&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.ddl/m0Z0m1Z1e rbddl2m3Z3m4Z4m5Z5ddl6m7Z7ddl8m9Z9m:Z:m;Z;mdZ?dZ@dZAdZBdZCdZDdZEdZFdZGdZHdZIdZJeAdeBd eCd!iZKd"d#d$d%d&ZLed'd(ZMd)eNd*<d+d,d-d.ZOd/d0d/d1d2d3ZPd4d5d6d7d8ZQd4d5d6d9d:ZRd;dd?ZSdd@dAdBdCdDZTdEdFdGdHdIdJdKdLdMdNdNdOdP ZUdd;d`_ to be sent to MongoDB. .. note:: This module is for internal use and is generally not needed by application developers. ) annotationsN)BytesIO) TYPE_CHECKINGAnyCallableIterableMappingMutableMappingNoReturnOptionalUnion) CodecOptions _dict_to_bson_make_c_string)Int64)_RAW_ARRAY_BSON_OPTIONSDEFAULT_RAW_BSON_OPTIONSRawBSONDocument _inflate_bson) HelloCompat)_EventListeners) _cmessageTF)ConfigurationErrorCursorNotFoundDocumentTooLargeExecutionTimeoutInvalidOperationNotPrimaryErrorOperationFailure ProtocolError)ReadPreference _ServerMode) SnappyContext ZlibContext ZstdContext) ReadConcern)_Address_AgnosticClientSession_AgnosticConnection_AgnosticMongoClient _DocumentOutiii?ssssdocumentss updatess deletes documentsupdatesZdeletes bulkWrite)insertupdatedeleter3replace)Zunicode_decode_error_handlerzCodecOptions[Mapping[str, Any]]_UNICODE_REPLACE_CODEC_OPTIONSintreturncCs tttS)z(Generate a pseudo random 32 bit integer.)randomrandint MIN_INT32 MAX_INT32r@r@3/tmp/pip-unpacked-wheel-36gvocj8/pymongo/message.py_randinttsrBMutableMapping[str, Any]r!)specread_preferencer;cCsD|j}|j}|r@|tjjks(t|dkr@d|kr8d|i}||d<|S)z-Add $readPreference to spec when appropriate.r+$query$readPreference)modedocumentr ZSECONDARY_PREFERREDlen)rDrErHrIr@r@rA_maybe_add_read_preferenceysrK Exceptiondict[str, Any]) exceptionr;cCst||jjdS)zsz%_gen_find_command..$explainrGrnrzr{r|rTZ singleBatch batchSizeZ readConcernrNZ allowDiskUsecs g|]\}}|@r|dfqS)Tr@)roptrr~r@rArs)r5itemspopabslevelin_transactionrI_OPTIONS) ryrDrzr{r|r}r~rrrrcmdr@rrA_gen_find_commands>    rz Optional[Any]r() cursor_idryr}max_await_time_msrqconnr;cCsD||d}|r||d<|dk r&||d<|dk r@|jdkr@||d<|S)z$Generate a getMore command document.)getMoreZ collectionrNrr rq)max_wire_version)rryr}rrqrrr@r@rA_gen_get_more_command s rz||}t}ttt||dd|t||j}|||fS)zDTakes message data, compresses it, and adds an OP_COMPRESSED header.ri)compressrB_pack_compression_header_COMPRESSION_HEADER_SIZErJZ compressor_id)rYrr compressed request_idheaderr@r@rA _compress"s   rz.css|]}t|VqdSNrJrr@r@rA ]sz$_op_msg_no_header..css|]}t|VqdSrrrr@r@rAr`sr-) r_pack_op_msg_flags_typerJ _pack_bytersum _pack_intrsjoin)rrZrrrencodedZ flags_type total_sizeZ max_doc_sizeZtype_oneZcstringZ encoded_docssizeZ encoded_sizerr@rrA_op_msg_no_headerGs   rztuple[int, bytes, int, int])rrZrrrrr;c Cs2t|||||\}}}td||\} }| |||fS)zInternal OP_MSG message helper.)rr) rrZrrrrmsgr max_bson_sizerr@r@rA_op_msg_compressedgs rc Cs0t|||||\}}}td|\}} || ||fS)z*Internal compressed OP_MSG message helper.r)rr) rrZrrrrrrrZ op_messager@r@rA_op_msg_uncompressedusrzOptional[_ServerMode]z4Union[SnappyContext, ZlibContext, ZstdContext, None])rrZdbnamerErrr;c Cs||d<|dk r(d|kr(|jr(|j|d<tt|}zt|}||}Wntk rfd}d}YnXz.|rt||||||WSt|||||WS|r|||<XdS)zGet a OP_MSG message.$dbNrGr_) rHrInextiter _FIELD_MAPrKeyErrorrr) rrZrrErrnamerrr@r@rA_op_msgs"    rztuple[bytes, int])r~collection_name num_to_skip num_to_returnqueryfield_selectorrr;c Cs`t|d|}|rt|d|}nd}tt|t|} dt|t|t|t|||g| fS)zGet an OP_QUERY message.Fr-)rrsrJrrbsonr) r~rrrrrrrZefsrr@r@rA _query_impls  rtuple[int, bytes, int]) r~rrrrrrrr;c Cs2t|||||||\}} td||\} } | | | fS)z)Internal compressed query message helper.)rr) r~rrrrrrrop_queryrrrr@r@rA_query_compresseds rc Cs0t|||||||\}}td|\} } | | |fS)zInternal query message helper.r)rr) r~rrrrrrrrrrr@r@rA_query_uncompresseds rc Cs.|rt||||||||St|||||||S)zGet a **query** message.)rr)r~rrrrrrrr@r@rA_querys( rz._check_doc_size_limitsFr3Z errorsOnlyZorderedZbypassDocumentValidationrqZletcsi|]}||qSr@r@)rrrZr@rA 2sz/_client_batched_op_msg_impl..rr4rIr7r5Z updateModsNnsr+) rrrrrJ_COMMAND_OVERHEADrgr._OP_MSG_OVERHEADzipr"rS)%rZrGrHr$rrr%rTrrrrPZ abridged_keysZcommand_abridgedZcommand_len_abridgedZmax_doc_sequences_bytesZns_inforJrKrQrRZtotal_ops_lengthZtotal_ns_lengthr1Z real_op_typeZop_docrrr Zns_docZ ns_lengthZ new_ns_indexZop_doc_encodedZ op_lengthZns_doc_encodedr3r6r@rUrA_client_batched_op_msg_impl s                        r[z>tuple[bytes, list[Mapping[str, Any]], list[Mapping[str, Any]]])rZrGrHr$rrr;c Cs.t}t|||||||\}}} |||fS)zLEncode the next batched client-level bulkWrite operation as OP_MSG. )r#r[r8) rZrGrHr$rrr%rJrKr9r@r@rA_client_encode_batched_op_msgs  r\zCtuple[int, bytes, list[Mapping[str, Any]], list[Mapping[str, Any]]]c CsHt||||||\}}}|jjdk s(ttd||jj\} } | | ||fS)zZCreate the next batched client-level bulkWrite operation with OP_MSG, compressed. Nr)r\rrr;r) rZrGrHr$rrrrJrKrrr@r@rA!_client_batched_op_msg_compresseds  r]c Cszt}|t|dt|||||||\}}} |dt} |t| |d|t| | |||fS)z=OP_MSG implementation entry point for client-level bulkWrite.r=rr)r#r)r>r[r/rBrr8) rZrGrHr$rrr%rJrKr6rr@r@rA_client_batched_op_msgs$      r^)rZrGrHrrr;cCsVd|d<d|kr&t|ddd}nd}|jjrDt||||||St||||||S)zOCreate the next batched client-level bulkWrite operation using OP_MSG. ZadminrrArBr+T)rrgrrr]r^)rZrGrHrrr$r@r@rArIs rIc Cs*t}t|||||||\}}||fS)z:Encode the next batched insert, update, or delete command.)r#_batched_write_command_implr8) rrYrZrrrr%rr9r@r@rArs r)rrYrZrrrr%r;cCs|j}|j}|t} |j} |t||d|t|t| } |t || dd| z|t |Wntk rtddYnX| d} g} d}|D]}t|d}t|d|}t|| k}|rtt|}t|t|||d ko2| t|t|| k}||k}|sH|rNq|t|||t||| ||d 7}q|t| }| | |t|| d | | |t|| | |fS) z(Create a batched OP_QUERY write command.utf8rr,r(NrrFr+)rrrXrr)rencode_ZERO_8_SKIPLIMr*rr/truncate_OP_MAPrrrQrrJr,rr-r"_BSONOBJr._ZERO_16r)rrYrZrrrr%rrZ max_cmd_sizerZ command_startZ list_startrr1rrr2r4r5Z enough_dataZenough_documentsr6r@r@rAr_sV        &          r_c@seZdZdZdZedjZdZ dddddddZ d$d d d d ddZ d e d dfd dd dddddZ dddddZddddZedddd Zeddd!d"d#Zd S)%_OpReplyz$A MongoDB OP_REPLY response message.)rrnumber_returnedr1z|dkrtdd|f}d|dd}t|d|n|jd@rt|j}|d d|d t j rt |d |n,| d d krd }t | d || d |td| d | d ||jr|jgSgS)aCheck the response header from the database, without decoding BSON. Check the response for errors and unpack. Can raise CursorNotFound, NotPrimaryError, ExecutionTimeout, or OperationFailure. :param cursor_id: cursor_id we sent to get this response - used for raising an informative exception when we get cursor id not valid at server response. r+Nz"No cursor id for getMore operationzCursor not found, cursor id: %dr+)r]rOrVr,r]z$errrV2zoperation exceeded time limitzdatabase error: %s)rrrrZBSONr1decode setdefault startswithrZ LEGACY_ERRORrrgrr)rrrkrZerrobjZ error_objectZ default_msgr@r@rA raw_responseMs4       z_OpReply.raw_responseFr rlist[dict[str, Any]]r codec_optionsrklegacy_responser;cCs,|||rt|j|St|j||S)aUnpack a response from the database and decode the BSON document(s). Check the response for errors and unpack, returning a dictionary containing the response data. Can raise CursorNotFound, NotPrimaryError, ExecutionTimeout, or OperationFailure. :param cursor_id: cursor_id we sent to get this response - used for raising an informative exception when we get cursor id not valid at server response :param codec_options: an instance of :class:`~bson.codec_options.CodecOptions` :param user_fields: Response fields that should be decoded using the TypeDecoders from codec_options, passed to bson._decode_all_selective. )rqrZ decode_allr1_decode_all_selectiverrrtrkrur@r@rAunpack_responseys z_OpReply.unpack_responserMrtr;cCs"|j|d}|jdkst|dS)Unpack a command response.rtr+r)rxrir;)rrtrr@r@rAcommand_responses z_OpReply.command_responser r:cCstdS))Return the bytes of the command response.N)NotImplementedErrorrr@r@rAraw_command_responsesz_OpReply.raw_command_responsecCsdS)+Is the moreToCome bit set on this response?Fr@rr@r@rA more_to_comesz_OpReply.more_to_comerr;cCs,||\}}}}|dd}|||||S)z%Construct an _OpReply from raw bytes.N) UNPACK_FROM)clsrrrr9rir1r@r@rAunpacks z_OpReply.unpack)NN)rSrrrrstructStruct unpack_fromrOP_CODErrqr8rxr|rrr classmethodrr@r@r@rArh?s& .rhc@seZdZdZdZedjZdZ dZ dZ dZ dd d d d Z d ifddddddZd ed dfddddddddZdddddZd dd d!Zeddd"d#Zed dd$d%d&Zd S)'_OpMsgz"A MongoDB OP_MSG response message.)rrripayload_documentz1 sectionN)rCHECKSUM_PRESENTrrrJ)rrrZfirst_payload_typeZfirst_payload_sizerr@r@rArs   z _OpMsg.unpack)rSrrrrrrrrrrrEXHAUST_ALLOWEDrrqr8rxr|rrrrrr@r@r@rArs, rz5dict[int, Callable[[bytes], Union[_OpReply, _OpMsg]]] _UNPACK_REPLYc@seZdZdZdZdZdZdddddddd ddd dd d d ddddZddddZddddZ dddddZ dddddZ d)ddd!d"d#d$Z d*d ddd%d&d'd(Z dS)+_QueryzA query operation.)rdbryntoskiprDfieldsrtrEr|r}rrrrclientr _as_commandexhaustNr9rQrXrvr r!r%rwr)rxr)rrryrrDrrtrEr|r}rrrrrrcCsp||_||_||_||_||_||_||_||_| |_| |_ | |_ | |_ | |_ ||_ ||_d|_d|_||_dS)Nr)rrryrrDrrtrErr|r}rrrrrrr)rrrryrrDrrtrEr|r}rrrrrrr@r@rAr&s$z_Query.__init__rr:cCs d|_dSrrrr@r@rAresetLsz _Query.resetcCs|jd|jSNr@rryrr@r@rArOsz_Query.namespacer(rr;cCsRd}|jsd}n.|jdkr d}n|jjs>td|jj|jf||j|j|S)NFTrbzDread concern level of %s is not valid with a max wire version of %d.) rrrZ ok_for_legacyrrvalidate_sessionrr)rrZ use_find_cmdr@r@rA use_commandRs  z_Query.use_commandrMrr;cCs||jf|_dSrrrrrr@r@rAupdate_commandbsz_Query.update_commandFtuple[dict[str, Any], str]r apply_timeoutr;c Cs|jdk r|jSd|jk}t|j|j|j|j|j|j|j|j |j |j |j }|r^d|_ d|i}|||j r|j |d|j||s|j js|j |||||j |j|r|j|j|d||jf|_|jS)z.Return a find command document for this query.NrexplainFr)rrDrryrrr|r}rrrrrradd_server_api _apply_torErZ_update_read_concernsend_cluster_timerrr)rrrrrr@r@rA as_commandes:      z_Query.as_commandr)rEruse_cmdr;c Cs||_|jr|jdB}n|j}|}|j}|rj||d}td||j||j|j d\}}} } ||| fS|j dkrxdp||j } |j r| rt |j | } n|j } |j rt|tstt||}t|||j| ||rdn|j|j|j dS)z:Get a query message, possibly setting the secondaryOk bit.rrrr+r,N)rErHrrrDrrrrtrr}r|rtZ is_mongos isinstancer r;rKrrr) rrErrrrWrDrrrr9 ntoreturnr@r@rA get_messagesF    z_Query.get_message)F)F)rSrrrrconn_mgrrrrrrrrrr@r@r@rAr s,&(rc @seZdZdZdZdZdddddddd d d d d d ddZddddZddddZdd dddZ dddddZ d(dd dd d!d"Z d)d dd d#d$d%d&Z d'S)*_GetMorezA getmore operation.) rryrrrrtrErrrrrrqrrQr9r r!rwr)rurr) rryrrrtrErrrrrrqc CsR||_||_||_||_||_||_||_||_| |_| |_ d|_ | |_ | |_ dSr) rryrrrtrErrrrrrrq) rrryrrrtrErrrrrrqr@r@rArsz_GetMore.__init__rr:cCs d|_dSrrrr@r@rArsz_GetMore.resetcCs|jd|jSrrrr@r@rArsz_GetMore.namespacer(rcCs2d}|jsd}n|jdkrd}||j|j|S)NFTrb)rrrrr)rrrr@r@rArs z_GetMore.use_commandrMrcCs||jf|_dSrrrr@r@rArsz_GetMore.update_commandFrrcCs|jdk r|jSt|j|j|j|j|j|}|jrF|j|d|j || || ||j|j |rv|j |j dd||jf|_|jS)z1Return a getMore command document for this query.NFr)rrrryrrrqrrrErrrrr)rrrrr@r@rArs$   z_GetMore.as_commandz0Union[tuple[int, bytes, int], tuple[int, bytes]])dummy0rrr;c Csv|}|j}|rd||d}|jr4|jr4tj}nd}t|||jd|j |jd\}} } } || | fSt ||j |j |S)zGet a getmore message.rNr) rrrrrrrrrrtrrr) rrrrrWrrDrrrrr9r@r@rAr!s"  z_GetMore.get_messageN)F)F) rSrrrrrrrrrrrrr@r@r@rArs$ rcs$eZdZdddfdd ZZS)_RawBatchQueryr(rrcs(t||jdkrdS|js$dSdSNrbTFr rrrrrr r@rAr7s   z_RawBatchQuery.use_commandrSrrrrr@r@r rAr6srcs$eZdZdddfdd ZZS)_RawBatchGetMorer(rrcs(t||jdkrdS|js$dSdSrrrr r@rArCs   z_RawBatchGetMore.use_commandrr@r@r rArBsrc@sleZdZUdZded<ddddddZedd d d Zd d d dZdddddZ dddddZ dS)_CursorAddresszEThe server address (host, port) of a cursor, with namespace property.r_CursorAddress__namespacer&rQ)rrr;cCst||}||_|Sr)tuple__new__r)rrrrr@r@rArSs z_CursorAddress.__new__r:cCs|jS)zThe namespace this cursor.)rrr@r@rArXsz_CursorAddress.namespacer9cCs||jfSr)r__hash__rr@r@rAr]sz_CursorAddress.__hash__objectr)otherr;cCs*t|tr&t|t|ko$|j|jkStSr)rrrrNotImplementedrrr@r@rA__eq__bs z_CursorAddress.__eq__cCs ||k Srr@rr@r@rA__ne__gsz_CursorAddress.__ne__N) rSrrr__annotations__rrrrrrr@r@r@rArNs r)NNN)N)N)N)r __future__rrr<riorr#typingrrrrrr r r r rr rrZ bson.int64rZ bson.raw_bsonrrrrZ pymongo.hellorZpymongo.monitoringrZpymongorZ_use_c ImportErrorZpymongo.errorsrrrrrrrrZpymongo.read_preferencesr r!Zpymongo.compression_supportr"r#r$Zpymongo.read_concernr%Zpymongo.typingsr&r'r(r)r*r?r>rXZ_INSERTZ_UPDATEZ_DELETEZ_EMPTYrfrbrgrr>rcrerr8rrBrKrUrWrjrrrrrpackrrrrrrrrrrrrrrrZ_query_messagerrrrrZ_get_more_messagerr+rr rr"rr7r:r<r?rrDrYrSr[r\r]r^rIrr_rhrrrrrrrrrrr@r@r@rAs8  ,      (    % &3             ^7D=0vMqU 8u