U d7@sdZddlmZddlmZddlmZmZmZm Z m Z m Z m Z m Z mZmZddlmZmZddlmZmZddlmZmZmZddlmZmZmZmZmZdd l m!Z!dd l"m#Z#m$Z$m%Z%erdd l&m'Z'dd l(m)Z)dd l*m+Z+Gdddee%Z,Gddde,ee%Z-dS)z4CommandCursor class to iterate over command results.) annotations)deque) TYPE_CHECKINGAnyGenericIteratorListMappingNoReturnOptionalSequenceUnion) CodecOptions&_convert_raw_document_lists_to_streams)_CURSOR_CLOSED_ERRORS_ConnectionManager)ConnectionFailureInvalidOperationOperationFailure)_CursorAddress_GetMore_OpMsg_OpReply_RawBatchGetMore)PinnedResponse)_Address _DocumentOut _DocumentType) ClientSession) Collection) Connectionc @seZdZdZeZdMddddd d d d d d ddZd dddZdNd d dddZd d dddZ d dddZ dddddZ d ddd Z e d!dd"d#Zd$d d%d&d'Zd(d d)d*d+ZdOd,d d-d!d d.d/d0d1Zddd2d3Ze d dd4d5Ze ddd6d7Ze ddd8d9Ze d dd:d;ZdZd?dd@dAZeZd dBdCdDdEZdBddFdGZdddHdIZd d d d dJdKdLZdS)P CommandCursorz)A cursor / iterator over command cursors.rNFCollection[_DocumentType]Mapping[str, Any]Optional[_Address]int Optional[int]Optional[ClientSession]boolrNone collection cursor_infoaddress batch_sizemax_await_time_mssessionexplicit_sessioncommentreturnc Csd|_||_|d|_t|d|_|d|_||_||_||_ ||_ ||_ |jdk|_ ||_ |j rp|dd|kr|d|_n|j|_||t|ts|dk rtddS) zCreate a new command cursor.Nid firstBatchpostBatchResumeTokenrTnsz,max_await_time_ms must be an integer or None)_CommandCursor__sock_mgr_CommandCursor__collection_CommandCursor__idr_CommandCursor__dataget$_CommandCursor__postbatchresumetoken_CommandCursor__address_CommandCursor__batch_size!_CommandCursor__max_await_time_ms_CommandCursor__session _CommandCursor__explicit_session_CommandCursor__killed_CommandCursor__comment_CommandCursor__end_session_CommandCursor__nsZ full_namer. isinstancer% TypeError selfr+r,r-r.r/r0r1r2rK:/tmp/pip-unpacked-wheel-oblwsawz/pymongo/command_cursor.py__init__2s,      zCommandCursor.__init__)r3cCs |dSN_CommandCursor__dierJrKrKrL__del__YszCommandCursor.__del__) synchronousr3cCsx|j}d|_|jr:|s:|j}|jdk s*tt|j|j}nd}d}|jjj ||||j |j |j |j snd|_ d|_ dS)zCloses this cursor.TNr) rCr:r>AssertionErrorrrFr9databaseclientZ_cleanup_cursorr8rArB)rJrSZalready_killed cursor_idr-rKrKrLZ__die\s&  zCommandCursor.__diecCs$|jr |js |jj|dd|_dS)N)lock)rArBZ _end_session)rJrSrKrKrLZ __end_sessionts zCommandCursor.__end_sessioncCs|ddS)z$Explicitly close / kill this cursor.TNrOrQrKrKrLcloseyszCommandCursor.closez'CommandCursor[_DocumentType]')r.r3cCs8t|tstd|dkr"td|dkr.dp0||_|S)aLimits the number of documents returned in one batch. Each batch requires a round trip to the server. It can be adjusted to optimize performance and limit data transfer. .. note:: batch_size can not override MongoDB's internal limits on the amount of data it will return to the client in a single batch (i.e if you set batch size to 1,000,000,000, MongoDB will currently only return 4-16MB of results per batch). Raises :exc:`TypeError` if `batch_size` is not an integer. Raises :exc:`ValueError` if `batch_size` is less than ``0``. :Parameters: - `batch_size`: The size of each batch of results requested. zbatch_size must be an integerrzbatch_size must be >= 0)rGr%rH ValueErrorr?)rJr.rKrKrLr.}s  zCommandCursor.batch_sizecCst|jdkS)z^Returns `True` if the cursor has documents remaining from the previous batch. r)lenr;rQrKrKrL _has_nextszCommandCursor._has_nextOptional[Mapping[str, Any]]cCs|jS)zlRetrieve the postBatchResumeToken from the response to a changeStream aggregate or getMore. )r=rQrKrKrL_post_batch_resume_tokensz&CommandCursor._post_batch_resume_tokenr )connr3cCsP|jjj}||jsdS|jsL|t|d}|jdkrF| n||_dS)NFr) r9rUrVZ_should_pin_cursorrAr8Z pin_cursorrr:rY)rJrarVZconn_mgrrKrKrL_maybe_pin_connections     z#CommandCursor._maybe_pin_connectionr) operationr3c Cs6|jjj}z|j||j|jd}Wnztk r^}z|jtkrDd|_ | W5d}~XYn@t k rd|_ | Ynt k r| YnXt |tr|jst|j|j|_|jr|jdd}|d}|d|_|d|_n"|j}t |jts t|jj|_|jdkr(| t||_dS) z/Send a getmore message and handle the response.)r-TNrcursorZ nextBatchr6r4)r9rUrVZ_run_operation_unpack_responser>rcoderrCrYr ExceptionrGrr8rraZ more_to_comeZ from_commandZdocsr<r=r:datarrTrWrr;)rJrcrVresponseexcrdZ documentsrKrKrLZ__send_messagesB        zCommandCursor.__send_messageUnion[_OpReply, _OpMsg]zCodecOptions[Mapping[str, Any]]zSequence[_DocumentOut]rirW codec_options user_fieldslegacy_responser3cCs|||||SrN)Zunpack_response)rJrirWrmrnrorKrKrLreszCommandCursor._unpack_responsecCst|js|jrt|jS|jr~|jdd\}}|j|j}| | |||j |j|jj ||j |jjj|j|jd|j n |dt|jS)aRefreshes the cursor with more data from the server. Returns the length of self.__data after refresh. Will exit early if self.__data is already non-empty. Raises OperationFailure when the cursor cannot be refreshed due to an error on the query. .rZFT)r]r;rCr:rFsplitr9Z_read_preference_forr0_CommandCursor__send_message_getmore_classr?rmrArUrVr@r8rDrP)rJZdbnameZcollnameZ read_prefrKrKrL_refreshs.  zCommandCursor._refreshcCstt|jp|j S)aDoes this cursor have the potential to return more data? Even if :attr:`alive` is ``True``, :meth:`next` can raise :exc:`StopIteration`. Best to use a for loop:: for doc in collection.aggregate(pipeline): print(doc) .. note:: :attr:`alive` can be True while iterating a cursor from a failed server. In this case :attr:`alive` will return False after :meth:`next` fails to retrieve the next batch of results from the server. )r(r]r;rCrQrKrKrLaliveszCommandCursor.alivecCs|jS)zReturns the id of the cursor.)r:rQrKrKrLrWszCommandCursor.cursor_idcCs|jS)zUThe (host, port) of the server used, or None. .. versionadded:: 3.0 )r>rQrKrKrLr-szCommandCursor.addresscCs|jr |jSdS)zmThe cursor's :class:`~pymongo.client_session.ClientSession`, or None. .. versionadded:: 3.6 N)rBrArQrKrKrLr0#szCommandCursor.sessionzIterator[_DocumentType]cCs|SrNrKrQrKrKrL__iter__-szCommandCursor.__iter__rcCs&|jr|d}|dk r|SqtdS)zAdvance the cursor.TN)ru _try_next StopIteration)rJdocrKrKrLnext0s  zCommandCursor.nextzOptional[_DocumentType])get_more_allowedr3cCs8t|js|js|r|t|jr0|jSdSdS)z`_. r5N)r<rTsuperrMrI __class__rKrLrMbszRawBatchCommandCursor.__init__rkrr_zList[Mapping[str, Any]]rlcCs"|j||d}|st|d|S)N)rnr) raw_responser)rJrirWrmrnrorrKrKrLres z&RawBatchCommandCursor._unpack_responser )indexr3cCs tddS)Nz)Cannot call __getitem__ on RawBatchCursor)r)rJrrKrKrL __getitem__sz!RawBatchCommandCursor.__getitem__)rNNFN)NF) rrrrrsrMrer __classcell__rKrKrrLr_s$$rN).r __future__r collectionsrtypingrrrrrr r r r r ZbsonrrZpymongo.cursorrrZpymongo.errorsrrrZpymongo.messagerrrrrZpymongo.responserZpymongo.typingsrrrZpymongo.client_sessionrZpymongo.collectionrZ pymongo.poolr r!rrKrKrKrLs"  0     4