[jyDUdZddlmZddlZddlmZmZddlmZm Z m Z m Z m Z ddl mZddlmZmZddlmZdd lmZmZerdd lmZdd lmZdd lmZed dZegggggZGddZGddeZGddeZ GddeZ!GddeZ"GddeZ#drdZ$dsd$Z%dtd'Z&hd(Z'd)e(d*<dud/Z)Gd0d1Z*Gd2d3e*Z+Gd4d5e*Z,Gd6d7e*Z-Gd8d9Z.Gd:d;e.Z/Gd<d=e.Z0Gd>d?e.Z1Gd@dAe.Z2GdBdCZ3GdDdEZ4GdFdGZ5GdHdIe5Z6GdJdKe6Z7GdLdMe6Z8GdNdOe6Z9GdPdQe5Z:GdRdSe5Z;GdTdUe6Z<GdVdWe6Z=GdXdYZ>GdZd[e>Z?Gd\d]e>Z@Gd^d_e>ZAGd`daZBGdbdceBZCGdddeeBZDGdfdgeBZEGdhdiZFGdjdkeFZGGdldmeFZHGdndoeFZIGdpdqZJdS)vaTools to monitor driver events. .. versionadded:: 3.1 .. attention:: Starting in PyMongo 3.11, the monitoring classes outlined below are included in the PyMongo distribution under the :mod:`~pymongo.event_loggers` submodule. Use :func:`register` to register global listeners for specific events. Listeners must inherit from one of the abstract classes below and implement the correct functions for that class. For example, a simple command logger might be implemented like this:: import logging from pymongo import monitoring class CommandLogger(monitoring.CommandListener): def started(self, event): logging.info("Command {0.command_name} with request id " "{0.request_id} started on server " "{0.connection_id}".format(event)) def succeeded(self, event): logging.info("Command {0.command_name} with request id " "{0.request_id} on server {0.connection_id} " "succeeded in {0.duration_micros} " "microseconds".format(event)) def failed(self, event): logging.info("Command {0.command_name} with request id " "{0.request_id} on server {0.connection_id} " "failed in {0.duration_micros} " "microseconds".format(event)) monitoring.register(CommandLogger()) Server discovery and monitoring events are also available. For example:: class ServerLogger(monitoring.ServerListener): def opened(self, event): logging.info("Server {0.server_address} added to topology " "{0.topology_id}".format(event)) def description_changed(self, event): previous_server_type = event.previous_description.server_type new_server_type = event.new_description.server_type if new_server_type != previous_server_type: # server_type_name was added in PyMongo 3.4 logging.info( "Server {0.server_address} changed type from " "{0.previous_description.server_type_name} to " "{0.new_description.server_type_name}".format(event)) def closed(self, event): logging.warning("Server {0.server_address} removed from topology " "{0.topology_id}".format(event)) class HeartbeatLogger(monitoring.ServerHeartbeatListener): def started(self, event): logging.info("Heartbeat sent to server " "{0.connection_id}".format(event)) def succeeded(self, event): # The reply.document attribute was added in PyMongo 3.4. logging.info("Heartbeat to server {0.connection_id} " "succeeded with reply " "{0.reply.document}".format(event)) def failed(self, event): logging.warning("Heartbeat to server {0.connection_id} " "failed with error {0.reply}".format(event)) class TopologyLogger(monitoring.TopologyListener): def opened(self, event): logging.info("Topology with id {0.topology_id} " "opened".format(event)) def description_changed(self, event): logging.info("Topology description updated for " "topology id {0.topology_id}".format(event)) previous_topology_type = event.previous_description.topology_type new_topology_type = event.new_description.topology_type if new_topology_type != previous_topology_type: # topology_type_name was added in PyMongo 3.4 logging.info( "Topology {0.topology_id} changed type from " "{0.previous_description.topology_type_name} to " "{0.new_description.topology_type_name}".format(event)) # The has_writable_server and has_readable_server methods # were added in PyMongo 3.4. if not event.new_description.has_writable_server(): logging.warning("No writable servers available.") if not event.new_description.has_readable_server(): logging.warning("No readable servers available.") def closed(self, event): logging.info("Topology with id {0.topology_id} " "closed".format(event)) Connection monitoring and pooling events are also available. For example:: class ConnectionPoolLogger(ConnectionPoolListener): def pool_created(self, event): logging.info("[pool {0.address}] pool created".format(event)) def pool_ready(self, event): logging.info("[pool {0.address}] pool is ready".format(event)) def pool_cleared(self, event): logging.info("[pool {0.address}] pool cleared".format(event)) def pool_closed(self, event): logging.info("[pool {0.address}] pool closed".format(event)) def connection_created(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection created".format(event)) def connection_ready(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection setup succeeded".format(event)) def connection_closed(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection closed, reason: " "{0.reason}".format(event)) def connection_check_out_started(self, event): logging.info("[pool {0.address}] connection check out " "started".format(event)) def connection_check_out_failed(self, event): logging.info("[pool {0.address}] connection check out " "failed, reason: {0.reason}".format(event)) def connection_checked_out(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection checked out of pool".format(event)) def connection_checked_in(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection checked into pool".format(event)) Event listeners can also be registered per instance of :class:`~pymongo.mongo_client.MongoClient`:: client = MongoClient(event_listeners=[CommandLogger()]) Note that previously registered global listeners are automatically included when configuring per client event listeners. Registering a new global listener will not add that listener to existing client instances. .. note:: Events are delivered **synchronously**. Application threads block waiting for event handlers (e.g. :meth:`~CommandListener.started`) to return. Care must be taken to ensure that your event handlers are efficient enough to not adversely affect overall application performance. .. warning:: The command documents published through this API are *not* copies. If you intend to modify them in any way you must copy them in your event handler first. ) annotationsN)abc namedtuple) TYPE_CHECKINGAnyMappingOptionalSequence)ObjectId)Hello HelloCompat)_handle_exception)_Address _DocumentOut) timedelta)ServerDescription)TopologyDescription _Listeners)command_listenersserver_listenersserver_heartbeat_listenerstopology_listenerscmap_listenersceZdZdZdS)_EventListenerz,Abstract base class for all event listeners.N)__name__ __module__ __qualname____doc__V/var/www/app.qaans.com/backend/venv/lib/python3.11/site-packages/pymongo/monitoring.pyrrs6666r!rc*eZdZdZd dZd dZdd Zd S)CommandListenerzAbstract base class for command listeners. Handles `CommandStartedEvent`, `CommandSucceededEvent`, and `CommandFailedEvent`. eventCommandStartedEventreturnNonect)zAbstract method to handle a `CommandStartedEvent`. :Parameters: - `event`: An instance of :class:`CommandStartedEvent`. NotImplementedErrorselfr%s r"startedzCommandListener.started "!r!CommandSucceededEventct)zAbstract method to handle a `CommandSucceededEvent`. :Parameters: - `event`: An instance of :class:`CommandSucceededEvent`. r*r,s r" succeededzCommandListener.succeededr/r!CommandFailedEventct)zAbstract method to handle a `CommandFailedEvent`. :Parameters: - `event`: An instance of :class:`CommandFailedEvent`. r*r,s r"failedzCommandListener.failedr/r!N)r%r&r'r()r%r0r'r()r%r3r'r(rrrrr.r2r5r r!r"r$r$sZ """"""""""""""r!r$cjeZdZdZddZddZdd Zdd Zd dZd!dZ d"dZ d#dZ d$dZ d%dZ d&dZdS)'ConnectionPoolListenera-Abstract base class for connection pool listeners. Handles all of the connection pool events defined in the Connection Monitoring and Pooling Specification: :class:`PoolCreatedEvent`, :class:`PoolClearedEvent`, :class:`PoolClosedEvent`, :class:`ConnectionCreatedEvent`, :class:`ConnectionReadyEvent`, :class:`ConnectionClosedEvent`, :class:`ConnectionCheckOutStartedEvent`, :class:`ConnectionCheckOutFailedEvent`, :class:`ConnectionCheckedOutEvent`, and :class:`ConnectionCheckedInEvent`. .. versionadded:: 3.9 r%PoolCreatedEventr'r(ct)zAbstract method to handle a :class:`PoolCreatedEvent`. Emitted when a connection Pool is created. :Parameters: - `event`: An instance of :class:`PoolCreatedEvent`. r*r,s r" pool_createdz#ConnectionPoolListener.pool_created "!r!PoolReadyEventct)zAbstract method to handle a :class:`PoolReadyEvent`. Emitted when a connection Pool is marked ready. :Parameters: - `event`: An instance of :class:`PoolReadyEvent`. .. versionadded:: 4.0 r*r,s r" pool_readyz!ConnectionPoolListener.pool_readys "!r!PoolClearedEventct)zAbstract method to handle a `PoolClearedEvent`. Emitted when a connection Pool is cleared. :Parameters: - `event`: An instance of :class:`PoolClearedEvent`. r*r,s r" pool_clearedz#ConnectionPoolListener.pool_cleared$r<r!PoolClosedEventct)zAbstract method to handle a `PoolClosedEvent`. Emitted when a connection Pool is closed. :Parameters: - `event`: An instance of :class:`PoolClosedEvent`. r*r,s r" pool_closedz"ConnectionPoolListener.pool_closed.r<r!ConnectionCreatedEventct)zAbstract method to handle a :class:`ConnectionCreatedEvent`. Emitted when a connection Pool creates a Connection object. :Parameters: - `event`: An instance of :class:`ConnectionCreatedEvent`. r*r,s r"connection_createdz)ConnectionPoolListener.connection_created8r<r!ConnectionReadyEventct)zAbstract method to handle a :class:`ConnectionReadyEvent`. Emitted when a connection has finished its setup, and is now ready to use. :Parameters: - `event`: An instance of :class:`ConnectionReadyEvent`. r*r,s r"connection_readyz'ConnectionPoolListener.connection_readyB "!r!ConnectionClosedEventct)zAbstract method to handle a :class:`ConnectionClosedEvent`. Emitted when a connection Pool closes a connection. :Parameters: - `event`: An instance of :class:`ConnectionClosedEvent`. r*r,s r"connection_closedz(ConnectionPoolListener.connection_closedMr<r!ConnectionCheckOutStartedEventct)zAbstract method to handle a :class:`ConnectionCheckOutStartedEvent`. Emitted when the driver starts attempting to check out a connection. :Parameters: - `event`: An instance of :class:`ConnectionCheckOutStartedEvent`. r*r,s r"connection_check_out_startedz3ConnectionPoolListener.connection_check_out_startedWr<r!ConnectionCheckOutFailedEventct)zAbstract method to handle a :class:`ConnectionCheckOutFailedEvent`. Emitted when the driver's attempt to check out a connection fails. :Parameters: - `event`: An instance of :class:`ConnectionCheckOutFailedEvent`. r*r,s r"connection_check_out_failedz2ConnectionPoolListener.connection_check_out_failedar<r!ConnectionCheckedOutEventct)zAbstract method to handle a :class:`ConnectionCheckedOutEvent`. Emitted when the driver successfully checks out a connection. :Parameters: - `event`: An instance of :class:`ConnectionCheckedOutEvent`. r*r,s r"connection_checked_outz-ConnectionPoolListener.connection_checked_outkr<r!ConnectionCheckedInEventct)aAbstract method to handle a :class:`ConnectionCheckedInEvent`. Emitted when the driver checks in a connection back to the connection Pool. :Parameters: - `event`: An instance of :class:`ConnectionCheckedInEvent`. r*r,s r"connection_checked_inz,ConnectionPoolListener.connection_checked_inurLr!N)r%r9r'r()r%r=r'r()r%r@r'r()r%rCr'r()r%rFr'r()r%rIr'r()r%rMr'r()r%rPr'r()r%rSr'r()r%rVr'r()r%rYr'r()rrrrr;r?rBrErHrKrOrRrUrXr[r r!r"r8r8s  """" " " " """"""""""""" " " " """"""""""""""""" " " " " " "r!r8c*eZdZdZd dZd dZdd Zd S)ServerHeartbeatListenerzAbstract base class for server heartbeat listeners. Handles `ServerHeartbeatStartedEvent`, `ServerHeartbeatSucceededEvent`, and `ServerHeartbeatFailedEvent`. .. versionadded:: 3.3 r%ServerHeartbeatStartedEventr'r(ct)zAbstract method to handle a `ServerHeartbeatStartedEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatStartedEvent`. r*r,s r"r.zServerHeartbeatListener.startedr/r!ServerHeartbeatSucceededEventct)zAbstract method to handle a `ServerHeartbeatSucceededEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatSucceededEvent`. r*r,s r"r2z!ServerHeartbeatListener.succeededr/r!ServerHeartbeatFailedEventct)zAbstract method to handle a `ServerHeartbeatFailedEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatFailedEvent`. r*r,s r"r5zServerHeartbeatListener.failedr/r!N)r%r^r'r()r%r`r'r()r%rbr'r(r6r r!r"r]r]sZ""""""""""""""r!r]c*eZdZdZd dZd dZdd Zd S)TopologyListenerzAbstract base class for topology monitoring listeners. Handles `TopologyOpenedEvent`, `TopologyDescriptionChangedEvent`, and `TopologyClosedEvent`. .. versionadded:: 3.3 r%TopologyOpenedEventr'r(ct)zAbstract method to handle a `TopologyOpenedEvent`. :Parameters: - `event`: An instance of :class:`TopologyOpenedEvent`. r*r,s r"openedzTopologyListener.openedr/r!TopologyDescriptionChangedEventct)zAbstract method to handle a `TopologyDescriptionChangedEvent`. :Parameters: - `event`: An instance of :class:`TopologyDescriptionChangedEvent`. r*r,s r"description_changedz$TopologyListener.description_changedr/r!TopologyClosedEventct)zAbstract method to handle a `TopologyClosedEvent`. :Parameters: - `event`: An instance of :class:`TopologyClosedEvent`. r*r,s r"closedzTopologyListener.closedr/r!N)r%rfr'r()r%rir'r()r%rlr'r(rrrrrhrkrnr r!r"rereZ""""""""""""""r!rec*eZdZdZd dZd dZdd Zd S)ServerListenerzAbstract base class for server listeners. Handles `ServerOpeningEvent`, `ServerDescriptionChangedEvent`, and `ServerClosedEvent`. .. versionadded:: 3.3 r%ServerOpeningEventr'r(ct)zAbstract method to handle a `ServerOpeningEvent`. :Parameters: - `event`: An instance of :class:`ServerOpeningEvent`. r*r,s r"rhzServerListener.openedr/r!ServerDescriptionChangedEventct)zAbstract method to handle a `ServerDescriptionChangedEvent`. :Parameters: - `event`: An instance of :class:`ServerDescriptionChangedEvent`. r*r,s r"rkz"ServerListener.description_changedr/r!ServerClosedEventct)zAbstract method to handle a `ServerClosedEvent`. :Parameters: - `event`: An instance of :class:`ServerClosedEvent`. r*r,s r"rnzServerListener.closedr/r!N)r%rsr'r()r%rur'r()r%rwr'r(ror r!r"rrrrrpr!rrdurrr'intcJt|dzS)z'Convert duration 'dur' to microseconds.g.A)rz total_seconds)rys r" _to_microsr}s! s  ""T) * **r!optionstr listenersSequence[_EventListeners]ct|tjst|d|D]*}t|tstd|d+|S)zValidate event listenersz must be a list or tupleListeners for x must be either a CommandListener, ServerHeartbeatListener, ServerListener, TopologyListener, or ConnectionPoolListener.) isinstancerr TypeErrorr)r~rlisteners r"_validate_event_listenersrs i . .=6;;;<<<(N33 ****   r!rr(cbt|tstd|dt|trtj|t|trtj|t|trtj |t|trtj |t|tr!tj|dSdS)aRegister a global event listener. :Parameters: - `listener`: A subclasses of :class:`CommandListener`, :class:`ServerHeartbeatListener`, :class:`ServerListener`, :class:`TopologyListener`, or :class:`ConnectionPoolListener`. rrN)rrrr$ _LISTENERSrappendr]rrrrrerr8r)rs r"registerrs  h / /  &X & & &   (O,,6$++H555(344?-44X>>>(N++5#**8444(,--7%,,X666(2333!((2222233r!> copydbgetnonce saslstart createuser updateuser authenticate saslcontinuecopydbgetnoncecopydbsaslstartset_SENSITIVE_COMMANDS command_namedocMapping[str, Any]boolcV|dtjfvrd|vrdSdS)NhellospeculativeAuthenticateTF)lowerr LEGACY_CMD)rrs r"_is_speculative_authenticater(s6+*@ AAA % , ,t 5r!ceZdZdZdZ dddZeddZeddZeddZ eddZ eddZ eddZ dS) _CommandEventzBase class for command events.) __cmd_name __rqst_id __conn_id__op_id __service_id__dbNrr request_idrz connection_idr operation_id Optional[int] service_idOptional[ObjectId] database_namer'r(cZ||_||_||_||_||_||_dSN)_CommandEvent__cmd_name_CommandEvent__rqst_id_CommandEvent__conn_id_CommandEvent__op_id_CommandEvent__service_id_CommandEvent__db)r-rrrrrrs r"__init__z_CommandEvent.__init__6s3'#&# &! r!c|jS)zThe command name.)rr-s r"rz_CommandEvent.command_nameF r!c|jS)z"The request id for this operation.)rrs r"rz_CommandEvent.request_idK ~r!c|jS)z@The address (host, port) of the server this command was sent to.)rrs r"rz_CommandEvent.connection_idPrr!c|jS)z^The service_id this command was sent to, or ``None``. .. versionadded:: 3.12 )rrs r"rz_CommandEvent.service_idUs   r!c|jS)z(An id for this series of events or None.)rrs r"rz_CommandEvent.operation_id] |r!c|jS)z^The database_name this command was sent to, or ``""``. .. versionadded:: 4.6 )rrs r"rz_CommandEvent.database_namebs yr!Nr)rrrrzrrrrrrrrr'r(r'rr'rzr'rr'r)r'r) rrrr __slots__rpropertyrrrrrrr r!r"rr1s(([I*.""""" XXX!!!X!XXr!rcheZdZdZdZ ddfd ZeddZedfd ZddZ xZ S)r&aEvent published when a command starts. :Parameters: - `command`: The command document. - `database_name`: The name of the database this command was run against. - `request_id`: The request id for this operation. - `connection_id`: The address (host, port) of the server this command was sent to. - `operation_id`: An optional identifier for a series of related events. - `service_id`: The service_id this command was sent to, or ``None``. )__cmdNcommandrrrrrzrrrrrrr'r(c0|st|dtt|}t|||||||}|t vst||r i|_dS||_dS)Nz is not a valid commandrr) ValueErrornextitersuperrrrr_CommandStartedEvent__cmd) r-rrrrrrrcmd_name __class__s r"rzCommandStartedEvent.__init__zs DBBBCC CDMM**      !'     %%'' * * *.J8U\.].] *')DJJJ DJJJr!c|jS)zThe command document.)rrs r"rzCommandStartedEvent.commands zr!c*tjS)z6The name of the database this command was run against.)rrr-rs r"rz!CommandStartedEvent.database_namesww$$r!c|d|jj|j|j|j|j|jS)NzA<{} {} db: {!r}, command: {!r}, operation_id: {}, service_id: {}>)formatrrrrrrrrs r"__repr__zCommandStartedEvent.__repr__s?S[[ N #         O    r!r)rrrrrrzrrrrrrr'r(r'rr) rrrrrrrrrr __classcell__rs@r"r&r&ks  I*.!!!!!!!6X%%%%%X%        r!r&cfeZdZdZdZ ddfd ZeddZeddZddZ xZ S)r0aXEvent published when a command succeeds. :Parameters: - `duration`: The command duration as a datetime.timedelta. - `reply`: The server reply document. - `command_name`: The command name. - `request_id`: The request id for this operation. - `connection_id`: The address (host, port) of the server this command was sent to. - `operation_id`: An optional identifier for a series of related events. - `service_id`: The service_id this command was sent to, or ``None``. - `database_name`: The database this command was sent to, or ``""``. )__duration_micros__replyNrdurationdatetime.timedeltareplyrrrrrzrrrrrrrr'r(c t||||||t||_|} | t vst | |r i|_dS||_dSNr)rrr}'_CommandSucceededEvent__duration_microsrrr_CommandSucceededEvent__reply) r-rrrrrrrrrrs r"rzCommandSucceededEvent.__init__s     !'    ",H!5!5%%'' * * *.J8UZ.[.[ *)+DLLL DLLLr!c|jSz/The duration of this operation in microseconds.)rrs r"duration_microsz%CommandSucceededEvent.duration_micros %%r!c|jSz/The server failure document for this operation.)rrs r"rzCommandSucceededEvent.replyrr!c d|jj|j|j|j|j|j|jS)NzV<{} {} db: {!r}, command: {!r}, operation_id: {}, duration_micros: {}, service_id: {}>) rrrrrrrrrrs r"rzCommandSucceededEvent.__repr__sD d & N #          O   r!r)rrrrrrrrzrrrrrrrrr'r(rrr) rrrrrrrrrrrrs@r"r0r0s  1I*.!!!!!!!4&&&X&X         r!r0cfeZdZdZdZ ddfd ZeddZeddZddZ xZ S)r3aWEvent published when a command fails. :Parameters: - `duration`: The command duration as a datetime.timedelta. - `failure`: The server reply document. - `command_name`: The command name. - `request_id`: The request id for this operation. - `connection_id`: The address (host, port) of the server this command was sent to. - `operation_id`: An optional identifier for a series of related events. - `service_id`: The service_id this command was sent to, or ``None``. - `database_name`: The database this command was sent to, or ``""``. )r __failureNrrrfailurerrrrrzrrrrrrrr'r(c t||||||t||_||_dSr)rrr}$_CommandFailedEvent__duration_micros_CommandFailedEvent__failure) r-rrrrrrrrrs r"rzCommandFailedEvent.__init__sU     !'    ",H!5!5 r!c|jSr)rrs r"rz"CommandFailedEvent.duration_microsrr!c|jSr)rrs r"rzCommandFailedEvent.failurerr!c d|jj|j|j|j|j|j|j|j S)Nze<{} {} db: {!r}, command: {!r}, operation_id: {}, duration_micros: {}, failure: {!r}, service_id: {}>) rrrrrrrrrrrs r"rzCommandFailedEvent.__repr__sK - & N #          L O  r!r)rrrrrrrrzrrrrrrrrr'r(rrr) rrrrrrrrrrrrs@r"r3r3s  3I*.!!!!!!!,&&&X&X         r!r3c>eZdZdZdZd dZed dZdd Zd S) _PoolEventzBase class for pool events. __addressaddressrr'r(c||_dSr_PoolEvent__addressr-rs r"rz_PoolEvent.__init__3  r!c|jS)zbThe address (host, port) pair of the server the pool is attempting to connect to. rrs r"rz_PoolEvent.address6 ~r!rc0|jjd|jdSN())rrrrs r"rz_PoolEvent.__repr__= .)??DN????r!Nrrr'r(rr rrrrrrrrrr r!r"rr.sm%%I!!!!X @@@@@@r!rcHeZdZdZdZd fd Zedd Zdd ZxZ S)r9zPublished when a Connection Pool is created. :Parameters: - `address`: The address (host, port) pair of the server this Pool is attempting to connect to. .. versionadded:: 3.9 ) __optionsrroptionsdict[str, Any]r'r(cXt|||_dSr)rr_PoolCreatedEvent__options)r-rrrs r"rzPoolCreatedEvent.__init__Ms& !!! r!c|jS)zCAny non-default pool options that were set on this Connection Pool.)rrs r"rzPoolCreatedEvent.optionsQrr!rc@|jjd|jd|jdSNr z, r )rrrrrs r"rzPoolCreatedEvent.__repr__Vs*.)QQDLQQdnQQQQr!rrrrr'r()r'rr) rrrrrrrrrrrs@r"r9r9AsI!!!!!!XRRRRRRRRr!r9ceZdZdZdZdS)r=zPublished when a Connection Pool is marked ready. :Parameters: - `address`: The address (host, port) pair of the server this Pool is attempting to connect to. .. versionadded:: 4.0 r Nrrrrrr r!r"r=r=ZIIIr!r=cJeZdZdZdZddfd Zedd Zdd ZxZ S)r@aPublished when a Connection Pool is cleared. :Parameters: - `address`: The address (host, port) pair of the server this Pool is attempting to connect to. - `service_id`: The service_id this command was sent to, or ``None``. .. versionadded:: 3.9 )rNrrrrr'r(cXt|||_dSr)rr_PoolClearedEvent__service_id)r-rrrs r"rzPoolClearedEvent.__init__ts) !!!&r!c|jS)zConnections with this service_id are cleared. When service_id is ``None``, all connections in the pool are cleared. .. versionadded:: 3.12 )rrs r"rzPoolClearedEvent.service_idxs   r!rc@|jjd|jd|jdSr)rrrrrs r"rzPoolClearedEvent.__repr__s+.)TTDLTTd>OTTTTr!rrrrrr'r(rr) rrrrrrrrrrrs@r"r@r@gs"I'''''''!!!X!UUUUUUUUr!r@ceZdZdZdZdS)rCzPublished when a Connection Pool is closed. :Parameters: - `address`: The address (host, port) pair of the server this Pool is attempting to connect to. .. versionadded:: 3.9 r Nrr r!r"rCrCrr!rCc(eZdZdZdZ dZ dZ dZdS)ConnectionClosedReasonzqAn enum that defines values for `reason` on a :class:`ConnectionClosedEvent`. .. versionadded:: 3.9 staleidleerror poolClosedN)rrrrSTALEIDLEERROR POOL_CLOSEDr r!r"r#r#s= EF D EIKEEr!r#c"eZdZdZdZ dZ dZdS)ConnectionCheckOutFailedReasonzyAn enum that defines values for `reason` on a :class:`ConnectionCheckOutFailedEvent`. .. versionadded:: 3.9 timeoutr'connectionErrorN)rrrrTIMEOUTr+ CONN_ERRORr r!r"r-r-s5 GJKM"Jr!r-c>eZdZdZdZd dZed dZdd Zd S)_ConnectionEventz)Private base class for connection events.rrrr'r(c||_dSr_ConnectionEvent__addressrs r"rz_ConnectionEvent.__init__rr!c|jS)ziThe address (host, port) pair of the server this connection is attempting to connect to. r5rs r"rz_ConnectionEvent.addressrr!rc0|jjd|jdSr)rrr6rs r"rz_ConnectionEvent.__repr__r r!Nr rrr r r!r"r3r3sm33I!!!!X @@@@@@r!r3cHeZdZdZdZd fd Zedd Zdd ZxZ S)_ConnectionIdEventz4Private base class for connection events with an id.)__connection_idrrrrzr'r(cXt|||_dSr)rr!_ConnectionIdEvent__connection_id)r-rrrs r"rz_ConnectionIdEvent.__init__s) !!!,r!c|jS)zThe ID of the connection.)r=rs r"rz _ConnectionIdEvent.connection_ids ##r!rc@|jjd|jd|jdSr)rrrr=rs r"rz_ConnectionIdEvent.__repr__s+.)WWDLWWd>RWWWWr!rrrrzr'r(rr) rrrrrrrrrrrs@r"r:r:s>>$I------$$$X$XXXXXXXXr!r:ceZdZdZdZdS)rFaPublished when a Connection Pool creates a Connection object. NOTE: This connection is not ready for use until the :class:`ConnectionReadyEvent` is published. :Parameters: - `address`: The address (host, port) pair of the server this Connection is attempting to connect to. - `connection_id`: The integer ID of the Connection in this Pool. .. versionadded:: 3.9 r Nrr r!r"rFrFs  IIIr!rFceZdZdZdZdS)rIa3Published when a Connection has finished its setup, and is ready to use. :Parameters: - `address`: The address (host, port) pair of the server this Connection is attempting to connect to. - `connection_id`: The integer ID of the Connection in this Pool. .. versionadded:: 3.9 r Nrr r!r"rIrIIIIr!rIcHeZdZdZdZd fd Zedd Zdd ZxZ S)rMaVPublished when a Connection is closed. :Parameters: - `address`: The address (host, port) pair of the server this Connection is attempting to connect to. - `connection_id`: The integer ID of the Connection in this Pool. - `reason`: A reason explaining why this connection was closed. .. versionadded:: 3.9 __reasonrrrrzreasonrcZt||||_dSr)rr_ConnectionClosedEvent__reason)r-rrrGrs r"rzConnectionClosedEvent.__init__ s( -000 r!r'c|jS)zA reason explaining why this connection was closed. The reason must be one of the strings from the :class:`ConnectionClosedReason` enum. )rIrs r"rGzConnectionClosedEvent.reason }r!cdd|jj|j|j|jS)Nz{}({!r}, {!r}, {!r}))rrrrrrIrs r"rzConnectionClosedEvent.__repr__s2%,, N # L   M    r!)rrrrzrGrr rrrrrrrrGrrrs@r"rMrMs  IX        r!rMceZdZdZdZdS)rPzPublished when the driver starts attempting to check out a connection. :Parameters: - `address`: The address (host, port) pair of the server this Connection is attempting to connect to. .. versionadded:: 3.9 r Nrr r!r"rPrP#rr!rPcHeZdZdZdZd fd Zed d Zd d ZxZ S)rSa.Published when the driver's attempt to check out a connection fails. :Parameters: - `address`: The address (host, port) pair of the server this Connection is attempting to connect to. - `reason`: A reason explaining why connection check out failed. .. versionadded:: 3.9 rErrrGrr'r(cXt|||_dSr)rr&_ConnectionCheckOutFailedEvent__reason)r-rrGrs r"rz&ConnectionCheckOutFailedEvent.__init__=s& !!! r!c|jS)zA reason explaining why connection check out failed. The reason must be one of the strings from the :class:`ConnectionCheckOutFailedReason` enum. )rQrs r"rGz$ConnectionCheckOutFailedEvent.reasonArKr!c@|jjd|jd|jdSr)rrrrQrs r"rz&ConnectionCheckOutFailedEvent.__repr__Js*.)PPDLPPdmPPPPr!rrrGrr'r(rrMrs@r"rSrS0sIXQQQQQQQQr!rSceZdZdZdZdS)rVa*Published when the driver successfully checks out a connection. :Parameters: - `address`: The address (host, port) pair of the server this Connection is attempting to connect to. - `connection_id`: The integer ID of the Connection in this Pool. .. versionadded:: 3.9 r Nrr r!r"rVrVNrCr!rVceZdZdZdZdS)rYa*Published when the driver checks in a Connection into the Pool. :Parameters: - `address`: The address (host, port) pair of the server this Connection is attempting to connect to. - `connection_id`: The integer ID of the Connection in this Pool. .. versionadded:: 3.9 r Nrr r!r"rYrY\rCr!rYcVeZdZdZdZdd Zedd Zedd Zdd Z dS) _ServerEventzBase class for server events.)__server_address __topology_idserver_addressr topology_idr r'r(c"||_||_dSr)_ServerEvent__server_address_ServerEvent__topology_id)r-r[r\s r"rz_ServerEvent.__init__os .(r!c|jS)z+The address (host, port) pair of the server)r^rs r"r[z_ServerEvent.server_addressss $$r!c|jSz>A unique identifier for the topology this server is a part of.)r_rs r"r\z_ServerEvent.topology_idx !!r!rcBd|jjd|jd|jdS)N<  topology_id: >)rrr[r\rs r"rz_ServerEvent.__repr__}s/c4>*ccT-@ccPTP`ccccr!Nr[rr\r r'r(rr'r r) rrrrrrrr[r\rr r!r"rXrXjs''5I))))%%%X%"""X"ddddddr!rXc`eZdZdZdZdfd Zedd Zedd ZddZ xZ S)ruzJPublished when server description changes. .. versionadded:: 3.3 __previous_description__new_descriptionprevious_descriptionrnew_descriptionargsrr'r(cPtj|||_||_dSr)rr4_ServerDescriptionChangedEvent__previous_description/_ServerDescriptionChangedEvent__new_descriptionr-rorprqrs r"rz&ServerDescriptionChangedEvent.__init__/ $&:#!0r!c|jS)zUThe previous :class:`~pymongo.server_description.ServerDescription`. )rsrs r"roz2ServerDescriptionChangedEvent.previous_description **r!c|jS)zPThe new :class:`~pymongo.server_description.ServerDescription`. )rtrs r"rpz-ServerDescriptionChangedEvent.new_description %%r!rcdd|jj|j|j|jS)Nz <{} {} changed from: {}, to: {}>)rrrr[rorprs r"rz&ServerDescriptionChangedEvent.__repr__s4188 N #    %     r!)rorrprrqrr'r()r'rr rrrrrrrrorprrrs@r"ruru @I111111+++X+ &&&X&         r!ruceZdZdZdZdS)rszEPublished when server is initialized. .. versionadded:: 3.3 r Nrr r!r"rsrs IIIr!rsceZdZdZdZdS)rwz@Published when server is closed. .. versionadded:: 3.3 r Nrr r!r"rwrwrr!rwc>eZdZdZdZd dZed dZdd Zd S) TopologyEventz+Base class for topology description events.)rZr\r r'r(c||_dSr_TopologyEvent__topology_id)r-r\s r"rzTopologyEvent.__init__s(r!c|jSrbrrs r"r\zTopologyEvent.topology_idrcr!rc2d|jjd|jdS)Nrergrh)rrr\rs r"rzTopologyEvent.__repr__s#M4>*MM$:JMMMMr!Nr\r r'r(rjr) rrrrrrrr\rr r!r"rrsm55"I))))"""X"NNNNNNr!rc`eZdZdZdZdfd Zedd Zedd ZddZ xZ S)rizPPublished when the topology description changes. .. versionadded:: 3.3 rlrorrprqrr'r(cPtj|||_||_dSr)rr6_TopologyDescriptionChangedEvent__previous_description1_TopologyDescriptionChangedEvent__new_descriptionrus r"rz(TopologyDescriptionChangedEvent.__init__rvr!c|jS)zYThe previous :class:`~pymongo.topology_description.TopologyDescription`. )rrs r"roz4TopologyDescriptionChangedEvent.previous_descriptionrxr!c|jS)zTThe new :class:`~pymongo.topology_description.TopologyDescription`. )rrs r"rpz/TopologyDescriptionChangedEvent.new_descriptionrzr!rcdd|jj|j|j|jS)Nz-<{} topology_id: {} changed from: {}, to: {}>)rrrr\rorprs r"rz(TopologyDescriptionChangedEvent.__repr__s4>EE N #    %     r!)rorrprrqrr'r()r'rrr|rs@r"ririr}r!riceZdZdZdZdS)rfzKPublished when the topology is initialized. .. versionadded:: 3.3 r Nrr r!r"rfrfrr!rfceZdZdZdZdS)rlzFPublished when the topology is closed. .. versionadded:: 3.3 r Nrr r!r"rlrlrr!rlcXeZdZdZdZddd Zedd Zedd ZddZ dS)_ServerHeartbeatEventz'Base class for server heartbeat events.)r; __awaitedFrrawaitedrr'r(c"||_||_dSr)$_ServerHeartbeatEvent__connection_id_ServerHeartbeatEvent__awaited)r-rrs r"rz_ServerHeartbeatEvent.__init__ s, r!c|jS)zSThe address (host, port) of the server this heartbeat was sent to. )rrs r"rz#_ServerHeartbeatEvent.connection_ids ##r!c|jS)zgWhether the heartbeat was issued as an awaitable hello command. .. versionadded:: 4.6 )rrs r"rz_ServerHeartbeatEvent.awaiteds ~r!rcBd|jjd|jd|jdS)Nrerfz awaited: rh)rrrrrs r"rz_ServerHeartbeatEvent.__repr__ s-Z4>*ZZT-?ZZ4<ZZZZr!NFrrrrr'r(rr'rr) rrrrrrrrrrr r!r"rrs110I!!!!!$$$X$ X[[[[[[r!rceZdZdZdZdS)r^zFPublished when a heartbeat is started. .. versionadded:: 3.3 r Nrr r!r"r^r^$rr!r^ceZdZdZdZ ddfd ZeddZeddZedfd Z ddZ xZ S)r`zIFired when the server heartbeat succeeds. .. versionadded:: 3.3  __durationrFrfloatrr rrrrr'r(cht||||_||_dSr)rr(_ServerHeartbeatSucceededEvent__duration%_ServerHeartbeatSucceededEvent__replyr-rrrrrs r"rz&ServerHeartbeatSucceededEvent.__init__51 000" r!c|jSz/The duration of this heartbeat in microseconds.)rrs r"rz&ServerHeartbeatSucceededEvent.duration<rr!c|jS)z-An instance of :class:`~pymongo.hello.Hello`.)rrs r"rz#ServerHeartbeatSucceededEvent.replyArr!c*tjSzWhether the heartbeat was awaited. If true, then :meth:`duration` reflects the sum of the round trip time to the server and the time that the server waited before sending a response. .. versionadded:: 3.11 rrrs r"rz%ServerHeartbeatSucceededEvent.awaitedFwwr!rcpd|jj|j|j|j|jS)Nz,<{} {} duration: {}, awaited: {}, reply: {}>rrrrrrrrs r"rz&ServerHeartbeatSucceededEvent.__repr__Rs7=DD N #   M L J    r!r) rrrr rrrrr'r(r'r)r'r rr rrrrrrrrrrrrrs@r"r`r`-s *IW\XX     X         r!r`ceZdZdZdZ ddfd ZeddZeddZedfd Z ddZ xZ S)rbzxFired when the server heartbeat fails, either with an "ok: 0" or a socket exception. .. versionadded:: 3.3 rFrrr Exceptionrrrrr'r(cht||||_||_dSr)rr%_ServerHeartbeatFailedEvent__duration"_ServerHeartbeatFailedEvent__replyrs r"rz#ServerHeartbeatFailedEvent.__init__err!c|jSr)rrs r"rz#ServerHeartbeatFailedEvent.durationlrr!c|jS)zA subclass of :exc:`Exception`.)rrs r"rz ServerHeartbeatFailedEvent.replyqrr!c*tjSrrrs r"rz"ServerHeartbeatFailedEvent.awaitedvrr!rcpd|jj|j|j|j|jS)Nz.<{} {} duration: {}, awaited: {}, reply: {!r}>rrs r"rz#ServerHeartbeatFailedEvent.__repr__s7?FF N #   M L J    r!r) rrrrrrrrr'r(r)r'rrrrrs@r"rbrb\s *I[`XX     X         r!rbcjeZdZdZdJdZedKdZedKdZedKd ZedKd Z edKd Z dLd Z dMdNdZ dOdPd$Z dQdRd&ZdSd(ZdTd+ZdUd-ZdVd1ZdVd2ZdWd6ZdXd7ZdXd8ZdYd:ZdZd>Zd[d?Zd\d@Zd[dAZd]dBZd]dCZd^dEZd[dFZd_dGZ d]dHZ!d]dIZ"dS)`_EventListenerszConfigure event listeners for a client instance. Any event listeners registered globally are included by default. :Parameters: - `listeners`: A list of event listeners. r"Optional[Sequence[_EventListener]]ctjdd|_tjdd|_tj}|dd|_tjdd|_tj dd|_ ||D]}t|tr|j |t|tr|j |t|tr|j |t|t r|j |t|t"r|j |t%|j|_t%|j|_t%|j|_t%|j|_t%|j |_dSr)rr"_EventListeners__command_listenersr!_EventListeners__server_listenersr+_EventListeners__server_heartbeat_listenersr#_EventListeners__topology_listenersr_EventListeners__cmap_listenersrr$rrrr]rer8r%_EventListeners__enabled_for_commands#_EventListeners__enabled_for_server-_EventListeners__enabled_for_server_heartbeat%_EventListeners__enabled_for_topology!_EventListeners__enabled_for_cmap)r-rlsts r"rz_EventListeners.__init__s#-#?#B ","=aaa"@3,/F)$.$A!!!$D! * 9!!! <   6 6c?339,33C888c>228+223777c#:;;B5<;??1 $ $J $!!%(((( $ $ $!##### $ $ $rct||}|jD]6} ||#t$rt Y3wxYwdS)aPublish a ServerClosedEvent to all server listeners. :Parameters: - `server_address`: The address (host, port) pair of the server. - `topology_id`: A unique identifier for the topology this server is a part of. N)rwrrnrrrs r"publish_server_closedz%_EventListeners.publish_server_closedsx".+>>1 $ $J $!!%(((( $ $ $!##### $ $ $rrorrpct||||}|jD]6} ||#t$rt Y3wxYwdS)aPublish a ServerDescriptionChangedEvent to all server listeners. :Parameters: - `previous_description`: The previous server description. - `server_address`: The address (host, port) pair of the server. - `new_description`: The new server description. - `topology_id`: A unique identifier for the topology this server is a part of. N)rurrkrr)r-rorpr[r\r%rs r""publish_server_description_changedz2_EventListeners.publish_server_description_changeds . />;  1 $ $J $..u5555 $ $ $!##### $ $ $rct|}|jD]6} ||#t$rt Y3wxYwdS)zPublish a TopologyOpenedEvent to all topology listeners. :Parameters: - `topology_id`: A unique identifier for the topology this server is a part of. N)rfrrhrrr-r\r%rs r"publish_topology_openedz'_EventListeners.publish_topology_openedv$K003 $ $J $!!%(((( $ $ $!##### $ $ $0A  A ct|}|jD]6} ||#t$rt Y3wxYwdS)zPublish a TopologyClosedEvent to all topology listeners. :Parameters: - `topology_id`: A unique identifier for the topology this server is a part of. N)rlrrnrrrs r"publish_topology_closedz'_EventListeners.publish_topology_closedrrrct|||}|jD]6} ||#t$rt Y3wxYwdS)aIPublish a TopologyDescriptionChangedEvent to all topology listeners. :Parameters: - `previous_description`: The previous topology description. - `new_description`: The new topology description. - `topology_id`: A unique identifier for the topology this server is a part of. N)rirrkrr)r-rorpr\r%rs r"$publish_topology_description_changedz4_EventListeners.publish_topology_description_changeds|00DoWbcc3 $ $J $..u5555 $ $ $!##### $ $ $2A  A rrrct||}|jD]6} ||#t$rt Y3wxYwdS)z:Publish a :class:`PoolCreatedEvent` to all pool listeners.N)r9rr;rr)r-rrr%rs r"publish_pool_createdz$_EventListeners.publish_pool_createdsv '22/ $ $J $''.... $ $ $!##### $ $ $rct|}|jD]6} ||#t$rt Y3wxYwdS)z8Publish a :class:`PoolReadyEvent` to all pool listeners.N)r=rr?rrr-rr%rs r"publish_pool_readyz"_EventListeners.publish_pool_readystw''/ $ $J $%%e,,,, $ $ $!##### $ $ $rct||}|jD]6} ||#t$rt Y3wxYwdS)z:Publish a :class:`PoolClearedEvent` to all pool listeners.N)r@rrBrr)r-rrr%rs r"publish_pool_clearedz$_EventListeners.publish_pool_clearedsv *55/ $ $J $''.... $ $ $!##### $ $ $rct|}|jD]6} ||#t$rt Y3wxYwdS)z9Publish a :class:`PoolClosedEvent` to all pool listeners.N)rCrrErrrs r"publish_pool_closedz#_EventListeners.publish_pool_closedst((/ $ $J $&&u---- $ $ $!##### $ $ $rct||}|jD]6} ||#t$rt Y3wxYwdS)zWPublish a :class:`ConnectionCreatedEvent` to all connection listeners. N)rFrrHrrr-rrr%rs r"publish_connection_createdz*_EventListeners.publish_connection_createdsx'w >>/ $ $J $--e4444 $ $ $!##### $ $ $rct||}|jD]6} ||#t$rt Y3wxYwdS)zDPublish a :class:`ConnectionReadyEvent` to all connection listeners.N)rIrrKrrrs r"publish_connection_readyz(_EventListeners.publish_connection_readysv$Wm<</ $ $J $++E2222 $ $ $!##### $ $ $rrGct|||}|jD]6} ||#t$rt Y3wxYwdS)zVPublish a :class:`ConnectionClosedEvent` to all connection listeners. N)rMrrOrr)r-rrrGr%rs r"publish_connection_closedz)_EventListeners.publish_connection_closed#sz&g}fEE/ $ $J $,,U3333 $ $ $!##### $ $ $rct|}|jD]6} ||#t$rt Y3wxYwdS)z_Publish a :class:`ConnectionCheckOutStartedEvent` to all connection listeners. N)rPrrRrrrs r"$publish_connection_check_out_startedz4_EventListeners.publish_connection_check_out_started.sv/w77/ $ $J $77>>>> $ $ $!##### $ $ $rct||}|jD]6} ||#t$rt Y3wxYwdS)z^Publish a :class:`ConnectionCheckOutFailedEvent` to all connection listeners. N)rSrrUrr)r-rrGr%rs r"#publish_connection_check_out_failedz3_EventListeners.publish_connection_check_out_failed9sx.gv>>/ $ $J $66u==== $ $ $!##### $ $ $rct||}|jD]6} ||#t$rt Y3wxYwdS)zZPublish a :class:`ConnectionCheckedOutEvent` to all connection listeners. N)rVrrXrrrs r"publish_connection_checked_outz._EventListeners.publish_connection_checked_outDsx*'=AA/ $ $J $11%8888 $ $ $!##### $ $ $rct||}|jD]6} ||#t$rt Y3wxYwdS)zYPublish a :class:`ConnectionCheckedInEvent` to all connection listeners. N)rYrr[rrrs r"publish_connection_checked_inz-_EventListeners.publish_connection_checked_inOsx)-@@/ $ $J $007777 $ $ $!##### $ $ $r)rrr)r'r)NN)rrrrrrzrrrrrrr'r()NNFr)rrrrrrrrzrrrrrrrrrrr'r()NNr)rrrrrrrrzrrrrrrrrr'r(r) rrrrrr rrr'r() rrrrrrrrr'r(ri) rorrprr[rr\r r'r(r)rorrprr\r r'r(rr r r@)rrrrzrGrr'r(rT)#rrrrrrrrrrrrrrrrrrrrrrrrrrrrrr r rrrrr r!r"rrs>>>>2+++X+)))X)333X3+++X+'''X'    $)-$$$$$N $)-"'.$.$.$.$.$n $)-)$)$)$)$)$V $ $ $ $$$$$($$$$( $ $ $ $ $ $ $ $$$$$2 $ $ $ $ $ $ $ $$$$$*$$$$$$$$$$$$$$$$ $ $ $ $$$$$ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $r!r)ryrr'rz)r~rrrr'r)rrr'r()rrrrr'r)Kr __future__rdatetime collectionsrrtypingrrrr r bson.objectidr pymongo.hellor r pymongo.helpersrpymongo.typingsrrrpymongo.server_descriptionrpymongo.topology_descriptionrrrrr$r8r]rerrr}rrr__annotations__rrr&r0r3rr9r=r@rCr#r-r3r:rFrIrMrPrSrVrYrXrursrwrrirfrlrr^r`rbrr r!r"r siiiV#"""""''''''''BBBBBBBBBBBBBB"""""",,,,,,,,------22222222A""""""<<<<<<@@@@@@Z   ZBB + + 77777777"""""n"""@@"@"@"@"@"^@"@"@"F"""""n"""D"""""~"""B"""""^"""B++++ "3333<       77777777t< < < < < -< < < ~@ @ @ @ @ M@ @ @ F> > > > > > > > B@@@@@@@@&RRRRRzRRR2     Z   UUUUUzUUU>     j   FFFFFFFF*&@@@@@@@@&XXXXX)XXX$/"     -   ! ! ! ! ! .! ! ! H     %5   QQQQQ$4QQQ<      2        1   dddddddd.& & & & & L& & & R NNNNNNNN"& & & & & m& & & R--[[[[[[[[8"7, , , , , $9, , , ^- - - - - !6- - - `L$L$L$L$L$L$L$L$L$L$r!