U @f;/@sdZddlmZddlmZddlmZddlmZm Z ddl m Z m Z m Z ddlmZmZmZddlmZGd d d eZGd d d eZd S)z4CommandCursor class to iterate over command results.)deque)&_convert_raw_document_lists_to_streams) integer_types)_SocketManager_CURSOR_CLOSED_ERRORS)ConnectionFailureInvalidOperationOperationFailure)_CursorAddress_GetMore_RawBatchGetMore)PinnedResponsec@seZdZdZeZd/ddZddZd0d d Zd d Z d dZ ddZ ddZ e ddZddZddZd1ddZddZe ddZe dd Ze d!d"Ze d#d$Zd%d&Zd'd(ZeZd)d*Zd+d,Zd-d.ZdS)2 CommandCursorz)A cursor / iterator over command cursors.rNFc Csd|_||_|d|_t|d|_|d|_||_||_||_ ||_ ||_ |jdk|_ |j rj| dd|kr~|d|_n|j|_||t|ts|dk rtddS) zSCreate a new command cursor. The parameter 'retrieved' is unused. 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__end_session_CommandCursor__nsZ full_name batch_size isinstancer TypeError selfZ collectionZ cursor_infoaddressZ retrievedr!Zmax_await_time_mssessionZexplicit_sessionr(:/tmp/pip-unpacked-wheel-gs_301nf/pymongo/command_cursor.py__init__#s*       zCommandCursor.__init__cCs |dSN_CommandCursor__dier%r(r(r)__del__CszCommandCursor.__del__cCsj|j}d|_|jr,|s,|j}t|j|j}nd}d}|jjj||||j |j |j |j s`d|_ d|_ dS)zCloses this cursor. TrN) rrr rr rdatabaseclientZ_cleanup_cursorrrr)r% synchronousZalready_killed cursor_idr&r(r(r)Z__dieFs*  zCommandCursor.__diecCs$|jr |js |jj|dd|_dS)N)lock)rrZ _end_session)r%r2r(r(r)Z __end_session^s zCommandCursor.__end_sessioncCs|ddS)z-Explicitly close / kill this cursor. TNr,r.r(r(r)closecszCommandCursor.closecCs8t|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)r"rr# ValueErrorr)r%r!r(r(r)r!hs  zCommandCursor.batch_sizecCst|jdkS)zUReturns `True` if the cursor has documents remaining from the previous batch.r)lenrr.r(r(r) _has_nextszCommandCursor._has_nextcCs|jS)zcRetrieve the postBatchResumeToken from the response to a changeStream aggregate or getMore.)rr.r(r(r)_post_batch_resume_tokensz&CommandCursor._post_batch_resume_tokencCsP|jjj}||jsdS|jsL|t|d}|jdkrF| n||_dS)NFr) rr0r1Z_should_pin_cursorrrZ pin_cursorrrr5)r%Z sock_infor1Zsock_mgrr(r(r)_maybe_pin_connections     z#CommandCursor._maybe_pin_connectionc Cs$|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}|jj|_|jdkr| t||_dS) z8Send a getmore message and handle the response. )r&TNrcursorZ nextBatchrr)rr0r1Z_run_operation_unpack_responserr coderrr5r Exceptionr"r rrZ socket_infoZ more_to_comeZ from_commandZdocsrrrdatar3rr)r%Z operationr1responseexcr=Z documentsr(r(r)Z__send_messagesD        zCommandCursor.__send_messagecCs|||||Sr+)Zunpack_response)r%rBr3 codec_options user_fieldslegacy_responser(r(r)r>s zCommandCursor._unpack_responsecCst|js|jrt|jS|jrz|jdd\}}|j|j}| | |||j |j|jj ||j |jjj|j|jd 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. .r6FT)r9rrrr splitrZ_read_preference_forr'_CommandCursor__send_message_getmore_classrrDrr0r1rrr-)r%ZdbnameZcollnameZ read_prefr(r(r)_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. )boolr9rrr.r(r(r)aliveszCommandCursor.alivecCs|jS)zReturns the id of the cursor.)rr.r(r(r)r3szCommandCursor.cursor_idcCs|jS)zUThe (host, port) of the server used, or None. .. versionadded:: 3.0 )rr.r(r(r)r&szCommandCursor.addresscCs|jr |jSdS)zmThe cursor's :class:`~pymongo.client_session.ClientSession`, or None. .. versionadded:: 3.6 N)rrr.r(r(r)r'szCommandCursor.sessioncCs|Sr+r(r.r(r(r)__iter__ szCommandCursor.__iter__cCs&|jr|d}|dk r|SqtdS)zAdvance the cursor.TN)rM _try_next StopIteration)r%docr(r(r)nexts  zCommandCursor.nextcCsHt|js|js|r|t|jr@|j}|j|j|SdSdS)zrKrMr3r&r'rNrR__next__rOrTrXr(r(r(r)rsH   *       rcs4eZdZeZd fdd Zd ddZdd ZZS) RawBatchCommandCursorrNFc s0|drttt|||||||||dS)aLCreate a new cursor / iterator over raw batches of BSON data. Should not be called directly by application developers - see :meth:`~pymongo.collection.Collection.aggregate_raw_batches` instead. .. seealso:: The MongoDB documentation on `cursors `_. rN)rAssertionErrorsuperr_r*r$ __class__r(r)r*.s  zRawBatchCommandCursor.__init__cCs"|j||d}|st|d|S)N)rEr) raw_responser)r%rBr3rDrErFrdr(r(r)r>>s z&RawBatchCommandCursor._unpack_responsecCs tddS)Nz)Cannot call __getitem__ on RawBatchCursor)r)r%indexr(r(r) __getitem__Hsz!RawBatchCommandCursor.__getitem__)rrNNF)NF) rYrZr[r rJr*r>rf __classcell__r(r(rbr)r_+s r_N)r\ collectionsrZbsonrZbson.py3compatrZpymongo.cursorrrZpymongo.errorsrrr Zpymongo.messager r r Zpymongo.responser objectrr_r(r(r(r)s