o ]@sdZddlmZddlmZddlmZeddZegggggZGddde Z Gd d d e Z Gd d d e Z Gd dde Z Gddde ZGddde ZddZddZddZegdZGddde ZGdddeZGdddeZGd d!d!eZGd"d#d#e ZGd$d%d%eZGd&d'd'eZGd(d)d)eZGd*d+d+e ZGd,d-d-e ZGd.d/d/e ZGd0d1d1eZ Gd2d3d3eZ!Gd4d5d5eZ"Gd6d7d7e Z#Gd8d9d9e Z$Gd:d;d;eZ%Gdd?d?e Z'Gd@dAdAe'Z(GdBdCdCe'Z)GdDdEdEe'Z*GdFdGdGe Z+GdHdIdIe+Z,GdJdKdKe+Z-GdLdMdMe+Z.GdNdOdOe Z/GdPdQdQe/Z0GdRdSdSe/Z1GdTdUdUe/Z2GdVdWdWe Z3dXS)Ya\Tools to monitor driver events. .. versionadded:: 3.1 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_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}][conn #{0.connection_id}] " "connection created".format(event)) def connection_ready(self, event): logging.info("[pool {0.address}][conn #{0.connection_id}] " "connection setup succeeded".format(event)) def connection_closed(self, event): logging.info("[pool {0.address}][conn #{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}][conn #{0.connection_id}] " "connection checked out of pool".format(event)) def connection_checked_in(self, event): logging.info("[pool {0.address}][conn #{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. ) namedtuple)abc)_handle_exception Listeners)command_listenersserver_listenersserver_heartbeat_listenerstopology_listenerscmap_listenersc@seZdZdZdS)_EventListenerz,Abstract base class for all event listeners.N)__name__ __module__ __qualname____doc__rrD/var/www/html/env/lib/python3.10/site-packages/pymongo/monitoring.pyr sr c@(eZdZdZddZddZddZdS) CommandListenerzAbstract base class for command listeners. Handles `CommandStartedEvent`, `CommandSucceededEvent`, and `CommandFailedEvent`. cCt)zAbstract method to handle a `CommandStartedEvent`. :Parameters: - `event`: An instance of :class:`CommandStartedEvent`. NotImplementedErrorselfeventrrrstartedzCommandListener.startedcCr)zAbstract method to handle a `CommandSucceededEvent`. :Parameters: - `event`: An instance of :class:`CommandSucceededEvent`. rrrrr succeededrzCommandListener.succeededcCr)zAbstract method to handle a `CommandFailedEvent`. :Parameters: - `event`: An instance of :class:`CommandFailedEvent`. rrrrrfailedrzCommandListener.failedNr r rrrrrrrrrrs  rc@s`eZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ dS)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 cCr)zAbstract method to handle a :class:`PoolCreatedEvent`. Emitted when a Connection Pool is created. :Parameters: - `event`: An instance of :class:`PoolCreatedEvent`. rrrrr pool_createdz#ConnectionPoolListener.pool_createdcCr)zAbstract method to handle a `PoolClearedEvent`. Emitted when a Connection Pool is cleared. :Parameters: - `event`: An instance of :class:`PoolClearedEvent`. rrrrr pool_clearedr!z#ConnectionPoolListener.pool_clearedcCr)zAbstract method to handle a `PoolClosedEvent`. Emitted when a Connection Pool is closed. :Parameters: - `event`: An instance of :class:`PoolClosedEvent`. rrrrr pool_closedr!z"ConnectionPoolListener.pool_closedcCr)zAbstract method to handle a :class:`ConnectionCreatedEvent`. Emitted when a Connection Pool creates a Connection object. :Parameters: - `event`: An instance of :class:`ConnectionCreatedEvent`. rrrrrconnection_createdr!z)ConnectionPoolListener.connection_createdcCr)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`. rrrrrconnection_ready z'ConnectionPoolListener.connection_readycCr)zAbstract method to handle a :class:`ConnectionClosedEvent`. Emitted when a Connection Pool closes a Connection. :Parameters: - `event`: An instance of :class:`ConnectionClosedEvent`. rrrrrconnection_closed'r!z(ConnectionPoolListener.connection_closedcCr)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`. rrrrrconnection_check_out_started1r!z3ConnectionPoolListener.connection_check_out_startedcCr)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`. rrrrrconnection_check_out_failed;r!z2ConnectionPoolListener.connection_check_out_failedcCr)zAbstract method to handle a :class:`ConnectionCheckedOutEvent`. Emitted when the driver successfully checks out a Connection. :Parameters: - `event`: An instance of :class:`ConnectionCheckedOutEvent`. rrrrrconnection_checked_outEr!z-ConnectionPoolListener.connection_checked_outcCr)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`. rrrrrconnection_checked_inOr&z,ConnectionPoolListener.connection_checked_inN)r r rrr r"r#r$r%r'r(r)r*r+rrrrrs        rc@r) ServerHeartbeatListenerzAbstract base class for server heartbeat listeners. Handles `ServerHeartbeatStartedEvent`, `ServerHeartbeatSucceededEvent`, and `ServerHeartbeatFailedEvent`. .. versionadded:: 3.3 cCr)zAbstract method to handle a `ServerHeartbeatStartedEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatStartedEvent`. rrrrrrdrzServerHeartbeatListener.startedcCr)zAbstract method to handle a `ServerHeartbeatSucceededEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatSucceededEvent`. rrrrrrlrz!ServerHeartbeatListener.succeededcCr)zAbstract method to handle a `ServerHeartbeatFailedEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatFailedEvent`. rrrrrrtrzServerHeartbeatListener.failedNrrrrrr,[s  r,c@r) TopologyListenerzAbstract base class for topology monitoring listeners. Handles `TopologyOpenedEvent`, `TopologyDescriptionChangedEvent`, and `TopologyClosedEvent`. .. versionadded:: 3.3 cCr)zAbstract method to handle a `TopologyOpenedEvent`. :Parameters: - `event`: An instance of :class:`TopologyOpenedEvent`. rrrrropenedrzTopologyListener.openedcCr)zAbstract method to handle a `TopologyDescriptionChangedEvent`. :Parameters: - `event`: An instance of :class:`TopologyDescriptionChangedEvent`. rrrrrdescription_changedrz$TopologyListener.description_changedcCr)zAbstract method to handle a `TopologyClosedEvent`. :Parameters: - `event`: An instance of :class:`TopologyClosedEvent`. rrrrrclosedrzTopologyListener.closedNr r rrr.r/r0rrrrr-}  r-c@r) ServerListenerzAbstract base class for server listeners. Handles `ServerOpeningEvent`, `ServerDescriptionChangedEvent`, and `ServerClosedEvent`. .. versionadded:: 3.3 cCr)zAbstract method to handle a `ServerOpeningEvent`. :Parameters: - `event`: An instance of :class:`ServerOpeningEvent`. rrrrrr.rzServerListener.openedcCr)zAbstract method to handle a `ServerDescriptionChangedEvent`. :Parameters: - `event`: An instance of :class:`ServerDescriptionChangedEvent`. rrrrrr/rz"ServerListener.description_changedcCr)zAbstract method to handle a `ServerClosedEvent`. :Parameters: - `event`: An instance of :class:`ServerClosedEvent`. rrrrrr0rzServerListener.closedNr1rrrrr3r2r3cCst|dS)z'Convert duration 'dur' to microseconds.g.A)int total_seconds)durrrr _to_microssr7cCs@t|tjs td|f|D]}t|tstd|fq|S)zValidate event listenersz%s must be a list or tupleListeners for %s must be either a CommandListener, ServerHeartbeatListener, ServerListener, TopologyListener, or ConnectionPoolListener.) isinstancerSequence TypeErrorr )option listenerslistenerrrr_validate_event_listenerss  r?cCst|ts td|ft|trtj|t|tr"tj|t|t r-tj |t|t r8tj |t|t rEtj|dSdS)aRegister a global event listener. :Parameters: - `listener`: A subclasses of :class:`CommandListener`, :class:`ServerHeartbeatListener`, :class:`ServerListener`, :class:`TopologyListener`, or :class:`ConnectionPoolListener`. r8N)r9r r;r _LISTENERSrappendr,rr3rr-r rr )r>rrrregisters          rB) authenticate saslstart saslcontinuegetnonce createuser updateusercopydbgetnoncecopydbsaslstartcopydbc@sLeZdZdZdZddZeddZeddZed d Z ed d Z d S) _CommandEventzBase class for command events.) __cmd_name __rqst_id __conn_id__op_idcCs||_||_||_||_dSN)_CommandEvent__cmd_name_CommandEvent__rqst_id_CommandEvent__conn_id_CommandEvent__op_id)r command_name request_id connection_id operation_idrrr__init__s z_CommandEvent.__init__cC|jS)zThe command name.)rRrrrrrVz_CommandEvent.command_namecCr[)z"The request id for this operation.)rSr\rrrrWr]z_CommandEvent.request_idcCr[)z@The address (host, port) of the server this command was sent to.)rTr\rrrrXr]z_CommandEvent.connection_idcCr[)z(An id for this series of events or None.)rUr\rrrrY r]z_CommandEvent.operation_idN) r r rr __slots__rZpropertyrVrWrXrYrrrrrLs   rLc<eZdZdZdZfddZeddZeddZZ S) CommandStartedEventaEvent 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. )__cmd__dbcsZ|s td|ftt|}tt|j|g|R|tvr%i|_n||_||_ dS)Nz%r is not a valid command) ValueErrornextitersuperrarZlower_SENSITIVE_COMMANDS_CommandStartedEvent__cmd_CommandStartedEvent__db)rcommand database_nameargsrV __class__rrrZs   zCommandStartedEvent.__init__cCr[)zThe command document.)rjr\rrrrl*r]zCommandStartedEvent.commandcCr[)z6The name of the database this command was run against.)rkr\rrrrm/r]z!CommandStartedEvent.database_name) r r rrr^rZr_rlrm __classcell__rrrorras  racr`) CommandSucceededEventaEvent 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. )__duration_micros__replycs@tt|||||t||_|tvri|_dS||_dSrQ)rgrrrZr7'_CommandSucceededEvent__duration_microsrhri_CommandSucceededEvent__reply)rdurationreplyrVrWrXrYrorrrZCs     zCommandSucceededEvent.__init__cCr[z/The duration of this operation in microseconds.)rur\rrrduration_microsMr]z%CommandSucceededEvent.duration_microscCr[z/The server failure document for this operation.)rvr\rrrrxRr]zCommandSucceededEvent.reply) r r rrr^rZr_rzrxrqrrrorrr5s  rrcr`) CommandFailedEventaEvent 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. )rs __failurecs$tt|j|t||_||_dSrQ)rgr|rZr7$_CommandFailedEvent__duration_micros_CommandFailedEvent__failure)rrwfailurernrorrrZfs  zCommandFailedEvent.__init__cCr[ry)r~r\rrrrzkr]z"CommandFailedEvent.duration_microscCr[r{)rr\rrrrpr]zCommandFailedEvent.failure) r r rrr^rZr_rzrrqrrrorr|Xs  r|c@0eZdZdZdZddZeddZddZd S) _PoolEventzBase class for pool events. __addresscC ||_dSrQ_PoolEvent__addressraddressrrrrZz z_PoolEvent.__init__cCr[)zbThe address (host, port) pair of the server the pool is attempting to connect to. rr\rrrr}z_PoolEvent.addresscCd|jj|jfSNz%s(%r))rpr rr\rrr__repr__z_PoolEvent.__repr__N r r rrr^rZr_rrrrrrrvs  rc8eZdZdZdZfddZeddZddZZ S) PoolCreatedEventzPublished 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 ) __optionscstt||||_dSrQ)rgrrZ_PoolCreatedEvent__options)rroptionsrorrrZs zPoolCreatedEvent.__init__cCr[)zLAny non-default pool options that were set on this Connection Pool. )rr\rrrrzPoolCreatedEvent.optionscCd|jj|j|jfSNz %s(%r, %r))rpr rrr\rrrrzPoolCreatedEvent.__repr__) r r rrr^rZr_rrrqrrrorrs  rc@eZdZdZdZdS)PoolClearedEventzPublished when a Connection Pool is cleared. :Parameters: - `address`: The address (host, port) pair of the server this Pool is attempting to connect to. .. versionadded:: 3.9 rNr r rrr^rrrrrrc@r)PoolClosedEventzPublished 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 rNrrrrrrrrc@s&eZdZdZdZ dZ dZ dZdS)ConnectionClosedReasonzqAn enum that defines values for `reason` on a :class:`ConnectionClosedEvent`. .. versionadded:: 3.9 staleidleerror poolClosedN)r r rrSTALEIDLEERROR POOL_CLOSEDrrrrrsrc@s eZdZdZdZ dZ dZdS)ConnectionCheckOutFailedReasonzyAn enum that defines values for `reason` on a :class:`ConnectionCheckOutFailedEvent`. .. versionadded:: 3.9 timeoutrconnectionErrorN)r r rrTIMEOUTr CONN_ERRORrrrrrsrc@<eZdZdZdZddZeddZeddZd d Z d S) _ConnectionEventz.Private base class for some connection events.)r__connection_idcC||_||_dSrQ)_ConnectionEvent__address_ConnectionEvent__connection_id)rrrXrrrrZ z_ConnectionEvent.__init__cCr[ziThe address (host, port) pair of the server this connection is attempting to connect to. )rr\rrrrrz_ConnectionEvent.addresscCr[)zThe ID of the Connection.)rr\rrrrXr]z_ConnectionEvent.connection_idcCrr)rpr rrr\rrrrrz_ConnectionEvent.__repr__N) r r rrr^rZr_rrXrrrrrrs   rc@r)ConnectionCreatedEventaPublished 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 rNrrrrrrs rc@r)ConnectionReadyEventa3Published 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 rNrrrrrr  rcr) ConnectionClosedEventaVPublished 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 )__reasoncstt|||||_dSrQ)rgrrZ_ConnectionClosedEvent__reason)rrrXreasonrorrrZ%s zConnectionClosedEvent.__init__cCr[)zA reason explaining why this connection was closed. The reason must be one of the strings from the :class:`ConnectionClosedReason` enum. )rr\rrrr)zConnectionClosedEvent.reasoncCsd|jj|j|j|jfS)Nz%s(%r, %r, %r))rpr rrXrr\rrrr2szConnectionClosedEvent.__repr__) r r rrr^rZr_rrrqrrrorrs  rc@r) ConnectionCheckOutStartedEventzPublished 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 rcCrrQ(_ConnectionCheckOutStartedEvent__addressrrrrrZCrz'ConnectionCheckOutStartedEvent.__init__cCr[rrr\rrrrFrz&ConnectionCheckOutStartedEvent.addresscCrr)rpr rr\rrrrMrz'ConnectionCheckOutStartedEvent.__repr__Nrrrrrr8s  rc@r) ConnectionCheckOutFailedEventa.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 )rrcCrrQ)'_ConnectionCheckOutFailedEvent__address&_ConnectionCheckOutFailedEvent__reason)rrrrrrrZ]rz&ConnectionCheckOutFailedEvent.__init__cCr[r)rr\rrrrarz%ConnectionCheckOutFailedEvent.addresscCr[)zA reason explaining why connection check out failed. The reason must be one of the strings from the :class:`ConnectionCheckOutFailedReason` enum. )rr\rrrrhrz$ConnectionCheckOutFailedEvent.reasoncCrr)rpr rrr\rrrrqrz&ConnectionCheckOutFailedEvent.__repr__N) r r rrr^rZr_rrrrrrrrQs    rc@r)ConnectionCheckedOutEventa*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 rNrrrrrrvrrc@r)ConnectionCheckedInEventa*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 rNrrrrrrrrc@s4eZdZdZdZddZeddZeddZd S) _ServerEventzBase class for server events.)__server_address __topology_idcCrrQ)_ServerEvent__server_address_ServerEvent__topology_id)rserver_address topology_idrrrrZrz_ServerEvent.__init__cCr[)z+The address (host, port) pair of the server)rr\rrrrr]z_ServerEvent.server_addresscCr[z>A unique identifier for the topology this server is a part of.)rr\rrrrr]z_ServerEvent.topology_idN) r r rrr^rZr_rrrrrrrs rcr`) ServerDescriptionChangedEventzJPublished when server description changes. .. versionadded:: 3.3 __previous_description__new_descriptionc tt|j|||_||_dSrQ)rgrrZ4_ServerDescriptionChangedEvent__previous_description/_ServerDescriptionChangedEvent__new_descriptionrprevious_descriptionnew_descriptionrnrorrrZ z&ServerDescriptionChangedEvent.__init__cCr[)zLThe previous :class:`~pymongo.server_description.ServerDescription`.)rr\rrrrrz2ServerDescriptionChangedEvent.previous_descriptioncCr[)zGThe new :class:`~pymongo.server_description.ServerDescription`.)rr\rrrrrz-ServerDescriptionChangedEvent.new_description r r rrr^rZr_rrrqrrrorr  rc@r)ServerOpeningEventzEPublished when server is initialized. .. versionadded:: 3.3 rNrrrrrrrc@r)ServerClosedEventz@Published when server is closed. .. versionadded:: 3.3 rNrrrrrrrrc@(eZdZdZdZddZeddZdS) TopologyEventz+Base class for topology description events.rcCrrQ_TopologyEvent__topology_id)rrrrrrZrzTopologyEvent.__init__cCr[rrr\rrrrr]zTopologyEvent.topology_idN)r r rrr^rZr_rrrrrr rcr`) TopologyDescriptionChangedEventzPPublished when the topology description changes. .. versionadded:: 3.3 rcrrQ)rgrrZ6_TopologyDescriptionChangedEvent__previous_description1_TopologyDescriptionChangedEvent__new_descriptionrrorrrZrz(TopologyDescriptionChangedEvent.__init__cCr[)zPThe previous :class:`~pymongo.topology_description.TopologyDescription`.)rr\rrrrrz4TopologyDescriptionChangedEvent.previous_descriptioncCr[)zKThe new :class:`~pymongo.topology_description.TopologyDescription`.)rr\rrrrrz/TopologyDescriptionChangedEvent.new_descriptionrrrrorrrrc@r)TopologyOpenedEventzKPublished when the topology is initialized. .. versionadded:: 3.3 rNrrrrrrrrc@r)TopologyClosedEventzFPublished when the topology is closed. .. versionadded:: 3.3 rNrrrrrrrrc@r)_ServerHeartbeatEventz'Base class for server heartbeat events.rcCrrQ$_ServerHeartbeatEvent__connection_id)rrXrrrrZrz_ServerHeartbeatEvent.__init__cCr[)zJThe address (host, port) of the server this heartbeat was sent to.rr\rrrrXrz#_ServerHeartbeatEvent.connection_idN)r r rrr^rZr_rXrrrrr rrc@r)ServerHeartbeatStartedEventzFPublished when a heartbeat is started. .. versionadded:: 3.3 rNrrrrrrrrcr`) ServerHeartbeatSucceededEventzIFired when the server heartbeat succeeds. .. versionadded:: 3.3  __durationrtcrrQ)rgrrZ(_ServerHeartbeatSucceededEvent__duration%_ServerHeartbeatSucceededEvent__replyrrwrxrnrorrrZ*rz&ServerHeartbeatSucceededEvent.__init__cCr[z/The duration of this heartbeat in microseconds.)rr\rrrrw/r]z&ServerHeartbeatSucceededEvent.durationcCr[)z3An instance of :class:`~pymongo.ismaster.IsMaster`.)rr\rrrrx4r]z#ServerHeartbeatSucceededEvent.reply r r rrr^rZr_rwrxrqrrrorr"s  rcr`) ServerHeartbeatFailedEventzxFired when the server heartbeat fails, either with an "ok: 0" or a socket exception. .. versionadded:: 3.3 rcrrQ)rgrrZ%_ServerHeartbeatFailedEvent__duration"_ServerHeartbeatFailedEvent__replyrrorrrZCrz#ServerHeartbeatFailedEvent.__init__cCr[r)rr\rrrrwHr]z#ServerHeartbeatFailedEvent.durationcCr[)zA subclass of :exc:`Exception`.)rr\rrrrxMr]z ServerHeartbeatFailedEvent.replyrrrrorr:s  rc@seZdZdZddZeddZeddZedd Zed d Z ed d Z ddZ d=ddZ d=ddZ d=ddZddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2Zd3d4Zd5d6Zd7d8Zd9d:Z d;d<Z!dS)>_EventListenerszConfigure event listeners for a client instance. Any event listeners registered globally are included by default. :Parameters: - `listeners`: A list of event listeners. cCstjdd|_tjdd|_tj}|dd|_tjdd|_tj dd|_ |durj|D]9}t |t r=|j |t |trH|j |t |trS|j |t |tr^|j |t |tri|j |q0t|j|_t|j|_t|j|_t|j|_t|j |_dSrQ)r@r"_EventListeners__command_listenersr!_EventListeners__server_listenersr+_EventListeners__server_heartbeat_listenersr #_EventListeners__topology_listenersr _EventListeners__cmap_listenersr9rrAr3r,r-rbool%_EventListeners__enabled_for_commands#_EventListeners__enabled_for_server-_EventListeners__enabled_for_server_heartbeat%_EventListeners__enabled_for_topology!_EventListeners__enabled_for_cmap)rr=lstrrrrZ[s4             z_EventListeners.__init__cCr[)z-Are any CommandListener instances registered?)rr\rrrenabled_for_commandsur]z$_EventListeners.enabled_for_commandscCr[)z,Are any ServerListener instances registered?)rr\rrrenabled_for_serverzr]z"_EventListeners.enabled_for_servercCr[)z5Are any ServerHeartbeatListener instances registered?)rr\rrrenabled_for_server_heartbeatr]z,_EventListeners.enabled_for_server_heartbeatcCr[)z.Are any TopologyListener instances registered?)rr\rrrenabled_for_topologyr]z$_EventListeners.enabled_for_topologycCr[)z4Are any ConnectionPoolListener instances registered?)rr\rrrenabled_for_cmapr]z _EventListeners.enabled_for_cmapcCs4|jdd|jdd|jdd|jddfS)z#List of registered event listeners.N)rrrrr\rrrevent_listenerss    z_EventListeners.event_listenersNc CsR|dur|}t|||||}|jD]}z||Wqty&tYqwdS)aPublish a CommandStartedEvent to all command listeners. :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. - `op_id`: The (optional) operation id for this operation. N)rarr Exceptionr)rrlrmrWrXop_idr subscriberrrrpublish_command_starts     z%_EventListeners.publish_command_startc CT|dur|}t||||||}|jD]}z||Wqty'tYqwdS)aPublish a CommandSucceededEvent to all command listeners. :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. - `op_id`: The (optional) operation id for this operation. N)rrrrr r) rrwrxrVrWrXr rr rrrpublish_command_successs     z'_EventListeners.publish_command_successc Cr )aPublish a CommandFailedEvent to all command listeners. :Parameters: - `duration`: The command duration as a datetime.timedelta. - `failure`: The server reply document or failure description 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. - `op_id`: The (optional) operation id for this operation. N)r|rrr r) rrwrrVrWrXr rr rrrpublish_command_failures    z'_EventListeners.publish_command_failurec C>t|}|jD]}z||WqtytYqwdS)zPublish a ServerHeartbeatStartedEvent to all server heartbeat listeners. :Parameters: - `connection_id`: The address (host, port) pair of the connection. N)rrrr r)rrXrr rrr publish_server_heartbeat_started   z0_EventListeners.publish_server_heartbeat_startedc CBt|||}|jD]}z||Wq tytYq wdS)a^Publish a ServerHeartbeatSucceededEvent to all server heartbeat listeners. :Parameters: - `connection_id`: The address (host, port) pair of the connection. - `duration`: The execution time of the event in the highest possible resolution for the platform. - `reply`: The command reply. N)rrrr rrrXrwrxrr rrr"publish_server_heartbeat_succeededs   z2_EventListeners.publish_server_heartbeat_succeededc Cr)a[Publish a ServerHeartbeatFailedEvent to all server heartbeat listeners. :Parameters: - `connection_id`: The address (host, port) pair of the connection. - `duration`: The execution time of the event in the highest possible resolution for the platform. - `reply`: The command reply. N)rrrr rrrrrpublish_server_heartbeat_faileds   z/_EventListeners.publish_server_heartbeat_failedc C@t||}|jD]}z||WqtytYqwdS)aPublish a ServerOpeningEvent 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)rrr.r rrrrrr rrrpublish_server_opened     z%_EventListeners.publish_server_openedc Cr)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)rrr0r rrrrrpublish_server_closedrz%_EventListeners.publish_server_closedc CsDt||||}|jD]}z||Wq tytYq wdS)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)rrr/r r)rrrrrrr rrr"publish_server_description_changed*s    z2_EventListeners.publish_server_description_changedc Cr)zPublish a TopologyOpenedEvent to all topology listeners. :Parameters: - `topology_id`: A unique identifier for the topology this server is a part of. N)rrr.r rrrrr rrrpublish_topology_opened?rz'_EventListeners.publish_topology_openedc Cr)zPublish a TopologyClosedEvent to all topology listeners. :Parameters: - `topology_id`: A unique identifier for the topology this server is a part of. N)rrr0r rrrrrpublish_topology_closedMrz'_EventListeners.publish_topology_closedc CBt|||}|jD]}z||Wq tytYq wdS)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)rrr/r r)rrrrrr rrr$publish_topology_description_changed[s    z4_EventListeners.publish_topology_description_changedc Cr)zCPublish a :class:`PoolCreatedEvent` to all pool listeners. N)rrr r r)rrrrr rrrpublish_pool_createdm    z$_EventListeners.publish_pool_createdc Cr)zCPublish a :class:`PoolClearedEvent` to all pool listeners. N)rrr"r rrrrr rrrpublish_pool_clearedw   z$_EventListeners.publish_pool_clearedc Cr)zBPublish a :class:`PoolClosedEvent` to all pool listeners. N)rrr#r rr$rrrpublish_pool_closedr&z#_EventListeners.publish_pool_closedc Cr)zWPublish a :class:`ConnectionCreatedEvent` to all connection listeners. N)rrr$r rrrrXrr rrrpublish_connection_created    z*_EventListeners.publish_connection_createdc Cr)zMPublish a :class:`ConnectionReadyEvent` to all connection listeners. N)rrr%r rr(rrrpublish_connection_readyr#z(_EventListeners.publish_connection_readyc Cr )zVPublish a :class:`ConnectionClosedEvent` to all connection listeners. N)rrr'r r)rrrXrrr rrrpublish_connection_closeds    z)_EventListeners.publish_connection_closedc Cr)z_Publish a :class:`ConnectionCheckOutStartedEvent` to all connection listeners. N)rrr(r rr$rrr$publish_connection_check_out_starteds   z4_EventListeners.publish_connection_check_out_startedc Cr)z^Publish a :class:`ConnectionCheckOutFailedEvent` to all connection listeners. N)rrr(r r)rrrrr rrr#publish_connection_check_out_failedr*z3_EventListeners.publish_connection_check_out_failedc Cr)zZPublish a :class:`ConnectionCheckedOutEvent` to all connection listeners. N)rrr*r rr(rrrpublish_connection_checked_outr*z._EventListeners.publish_connection_checked_outc Cr)zYPublish a :class:`ConnectionCheckedInEvent` to all connection listeners. N)rrr+r rr(rrrpublish_connection_checked_inr*z-_EventListeners.publish_connection_checked_inrQ)"r r rrrZr_rrrrrrr rrrrrrrrrrr!r"r%r'r)r+r,r-r.r/r0rrrrrSsN                rN)4r collectionsrbson.py3compatrpymongo.helpersr _Listenersr@objectr rrr,r-r3r7r?rBsetrirLrarrr|rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrsh %   w"!!  $#    %