3 ]]*@sldZddlmZddlmZddlmZmZmZm Z ddl m Z m Z m Z GdddeZGdd d eZd S) z4CommandCursor class to iterate over command results.)deque) integer_types)ConnectionFailureInvalidOperationNotMasterErrorOperationFailure)_CursorAddress_GetMore_RawBatchGetMorec@seZdZdZeZd-ddZddZd.d d Zd d Z d dZ ddZ ddZ e ddZddZd/ddZddZe ddZe ddZe dd Ze d!d"Zd#d$Zd%d&ZeZd'd(Zd)d*Zd+d,ZdS)0 CommandCursorz)A cursor / iterator over command cursors.rNFc Cs||_|d|_t|d|_|jd|_||_||_||_||_ ||_ |jdk|_ |j rd|j dd|krx|d|_ n|j|_ |j|t|t r|dk rtddS) zSCreate a new command cursor. The parameter 'retrieved' is unused. id firstBatchpostBatchResumeTokenrTnsNz,max_await_time_ms must be an integer or None)_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__ns full_name batch_size isinstancer TypeError) self collection cursor_infoaddress retrievedrmax_await_time_mssessionexplicit_sessionr)9/tmp/pip-build-20mum3z4/pymongo/pymongo/command_cursor.py__init__!s&       zCommandCursor.__init__cCs|jr|j r|jdS)N)rr_CommandCursor__die)r!r)r)r*__del__@szCommandCursor.__del__cCsj|j}d|_|jr\| r\t|j|jj}|rH|jjjj|j||j dn|jjjj |j||j |dS)zCloses this cursor. T)r'N) rrrrrrdatabaseclientZ_close_cursor_nowrZ _close_cursorr)r! synchronousZalready_killedr$r)r)r*Z__dieDs    zCommandCursor.__diecCs&|jr"|j r"|jj|dd|_dS)N)lock)rrZ _end_session)r!r0r)r)r*Z __end_sessionUszCommandCursor.__end_sessioncCs|jddS)z-Explicitly close / kill this cursor. TN)r,)r!r)r)r*closeZszCommandCursor.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)rrr ValueErrorr)r!rr)r)r*r_s  zCommandCursor.batch_sizecCst|jdkS)zUReturns `True` if the cursor has documents remaining from the previous batch.r)lenr)r!r)r)r* _has_nextwszCommandCursor._has_nextcCs|jS)zcRetrieve the postBatchResumeToken from the response to a changeStream aggregate or getMore.)r)r!r)r)r*_post_batch_resume_token|sz&CommandCursor._post_batch_resume_tokenc sfdd}jjj}y|j|jjd}Wnltk rJ|YnRtk rd|Yn8tk r~|Ynt k rj YnX|j }|j }|j }|r|dd}|d} |jd_|d_n |} |j_jdkr|t| _d S) z8Send a getmore message and handle the response. csd_jddS)NT)rrr))r!r)r*killsz*CommandCursor.__send_message..kill)r$rcursorZ nextBatchrr N)rr.r/Z_run_operation_with_response_unpack_responserrrr Exceptionr, from_commanddatadocsrrr cursor_idrr) r!Z operationr9r/responser=Zreplyr?r:Z documentsr))r!r*Z__send_messages<      zCommandCursor.__send_messagecCs|j||||S)N)Zunpack_response)r!rAr@ codec_options user_fieldslegacy_responser)r)r*r;s zCommandCursor._unpack_responsec Cst|js|jrt|jS|jrv|jjdd\}}|jj|j}|j |j |||j |j|jj ||j |jjj|jd nd|_|jdt|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. .r3FT)r6rrrrsplitrZ_read_preference_forr'_CommandCursor__send_message_getmore_classrrBrr.r/rr)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. )boolr6rr)r!r)r)r*aliveszCommandCursor.alivecCs|jS)zReturns the id of the cursor.)r)r!r)r)r*r@szCommandCursor.cursor_idcCs|jS)zUThe (host, port) of the server used, or None. .. versionadded:: 3.0 )r)r!r)r)r*r$szCommandCursor.addresscCs|jr |jSdS)zmThe cursor's :class:`~pymongo.client_session.ClientSession`, or None. .. versionadded:: 3.6 N)rr)r!r)r)r*r'szCommandCursor.sessioncCs|S)Nr))r!r)r)r*__iter__szCommandCursor.__iter__cCs*x |jr |jd}|dk r|SqWtdS)zAdvance the cursor.TN)rK _try_next StopIteration)r!docr)r)r*nexts  zCommandCursor.nextcCsLt|j r |j r |r |jt|jrD|j}|jj|jj|SdSdS)zs