3 ]] @sdZddlmZddlmZddlmZeddeZegggggZGd d d e Z Gd dde Z Gddde Z Gddde Z Gddde ZGddde ZddZddZddZedddd d!d"d#d$d%g ZGd&d'd'e ZGd(d)d)eZGd*d+d+eZGd,d-d-eZGd.d/d/e ZGd0d1d1eZGd2d3d3eZGd4d5d5eZGd6d7d7e ZGd8d9d9e ZGd:d;d;e ZGdd?d?eZ!Gd@dAdAeZ"GdBdCdCe Z#GdDdEdEe Z$GdFdGdGeZ%GdHdIdIeZ&GdJdKdKe Z'GdLdMdMe'Z(GdNdOdOe'Z)GdPdQdQe'Z*GdRdSdSe Z+GdTdUdUe+Z,GdVdWdWe+Z-GdXdYdYe+Z.GdZd[d[e Z/Gd\d]d]e/Z0Gd^d_d_e/Z1Gd`dadae/Z2Gdbdcdce Z3ddS)fa\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_exceptionZ Listenerscommand_listenersserver_listenersserver_heartbeat_listenerstopology_listenerscmap_listenersc@seZdZdZdS)_EventListenerz,Abstract base class for all event listeners.N)__name__ __module__ __qualname____doc__rr5/tmp/pip-build-20mum3z4/pymongo/pymongo/monitoring.pyr sr c@s(eZdZdZddZddZddZdS) CommandListenerzAbstract base class for command listeners. Handles `CommandStartedEvent`, `CommandSucceededEvent`, and `CommandFailedEvent`. cCstdS)zAbstract method to handle a `CommandStartedEvent`. :Parameters: - `event`: An instance of :class:`CommandStartedEvent`. N)NotImplementedError)selfeventrrrstartedszCommandListener.startedcCstdS)zAbstract method to handle a `CommandSucceededEvent`. :Parameters: - `event`: An instance of :class:`CommandSucceededEvent`. N)r)rrrrr succeededszCommandListener.succeededcCstdS)zAbstract method to handle a `CommandFailedEvent`. :Parameters: - `event`: An instance of :class:`CommandFailedEvent`. N)r)rrrrrfailedszCommandListener.failedN)r r r rrrrrrrrrsrc@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 cCstdS)zAbstract method to handle a :class:`PoolCreatedEvent`. Emitted when a Connection Pool is created. :Parameters: - `event`: An instance of :class:`PoolCreatedEvent`. N)r)rrrrr pool_createdsz#ConnectionPoolListener.pool_createdcCstdS)zAbstract method to handle a `PoolClearedEvent`. Emitted when a Connection Pool is cleared. :Parameters: - `event`: An instance of :class:`PoolClearedEvent`. N)r)rrrrr pool_clearedsz#ConnectionPoolListener.pool_clearedcCstdS)zAbstract method to handle a `PoolClosedEvent`. Emitted when a Connection Pool is closed. :Parameters: - `event`: An instance of :class:`PoolClosedEvent`. N)r)rrrrr pool_closedsz"ConnectionPoolListener.pool_closedcCstdS)zAbstract method to handle a :class:`ConnectionCreatedEvent`. Emitted when a Connection Pool creates a Connection object. :Parameters: - `event`: An instance of :class:`ConnectionCreatedEvent`. N)r)rrrrrconnection_createdsz)ConnectionPoolListener.connection_createdcCstdS)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`. N)r)rrrrrconnection_readys z'ConnectionPoolListener.connection_readycCstdS)zAbstract method to handle a :class:`ConnectionClosedEvent`. Emitted when a Connection Pool closes a Connection. :Parameters: - `event`: An instance of :class:`ConnectionClosedEvent`. N)r)rrrrrconnection_closed'sz(ConnectionPoolListener.connection_closedcCstdS)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`. N)r)rrrrrconnection_check_out_started1sz3ConnectionPoolListener.connection_check_out_startedcCstdS)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`. N)r)rrrrrconnection_check_out_failed;sz2ConnectionPoolListener.connection_check_out_failedcCstdS)zAbstract method to handle a :class:`ConnectionCheckedOutEvent`. Emitted when the driver successfully checks out a Connection. :Parameters: - `event`: An instance of :class:`ConnectionCheckedOutEvent`. N)r)rrrrrconnection_checked_outEsz-ConnectionPoolListener.connection_checked_outcCstdS)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`. N)r)rrrrrconnection_checked_inOs z,ConnectionPoolListener.connection_checked_inN)r r r rrrrrrrrr r!r"rrrrrs         rc@s(eZdZdZddZddZddZdS) ServerHeartbeatListenerzAbstract base class for server heartbeat listeners. Handles `ServerHeartbeatStartedEvent`, `ServerHeartbeatSucceededEvent`, and `ServerHeartbeatFailedEvent`. .. versionadded:: 3.3 cCstdS)zAbstract method to handle a `ServerHeartbeatStartedEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatStartedEvent`. N)r)rrrrrrdszServerHeartbeatListener.startedcCstdS)zAbstract method to handle a `ServerHeartbeatSucceededEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatSucceededEvent`. N)r)rrrrrrlsz!ServerHeartbeatListener.succeededcCstdS)zAbstract method to handle a `ServerHeartbeatFailedEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatFailedEvent`. N)r)rrrrrrtszServerHeartbeatListener.failedN)r r r rrrrrrrrr#[sr#c@s(eZdZdZddZddZddZdS) TopologyListenerzAbstract base class for topology monitoring listeners. Handles `TopologyOpenedEvent`, `TopologyDescriptionChangedEvent`, and `TopologyClosedEvent`. .. versionadded:: 3.3 cCstdS)zAbstract method to handle a `TopologyOpenedEvent`. :Parameters: - `event`: An instance of :class:`TopologyOpenedEvent`. N)r)rrrrropenedszTopologyListener.openedcCstdS)zAbstract method to handle a `TopologyDescriptionChangedEvent`. :Parameters: - `event`: An instance of :class:`TopologyDescriptionChangedEvent`. N)r)rrrrrdescription_changedsz$TopologyListener.description_changedcCstdS)zAbstract method to handle a `TopologyClosedEvent`. :Parameters: - `event`: An instance of :class:`TopologyClosedEvent`. N)r)rrrrrclosedszTopologyListener.closedN)r r r rr%r&r'rrrrr$}sr$c@s(eZdZdZddZddZddZdS) ServerListenerzAbstract base class for server listeners. Handles `ServerOpeningEvent`, `ServerDescriptionChangedEvent`, and `ServerClosedEvent`. .. versionadded:: 3.3 cCstdS)zAbstract method to handle a `ServerOpeningEvent`. :Parameters: - `event`: An instance of :class:`ServerOpeningEvent`. N)r)rrrrrr%szServerListener.openedcCstdS)zAbstract method to handle a `ServerDescriptionChangedEvent`. :Parameters: - `event`: An instance of :class:`ServerDescriptionChangedEvent`. N)r)rrrrrr&sz"ServerListener.description_changedcCstdS)zAbstract method to handle a `ServerClosedEvent`. :Parameters: - `event`: An instance of :class:`ServerClosedEvent`. N)r)rrrrrr'szServerListener.closedN)r r r rr%r&r'rrrrr(sr(cCst|jdS)z'Convert duration 'dur' to microseconds.g.A)int total_seconds)Zdurrrr _to_microssr+cCsDt|tjstd|fx$|D]}t|ts td|fq W|S)zValidate event listenersz%s must be a list or tuplezListeners for %s must be either a CommandListener, ServerHeartbeatListener, ServerListener, TopologyListener, or ConnectionPoolListener.) isinstancerSequence TypeErrorr )option listenerslistenerrrr_validate_event_listenerss   r2cCst|tstd|ft|tr.tjj|t|trDtjj|t|t rZtj j|t|t rptj j|t|t rtjj|dS)aRegister a global event listener. :Parameters: - `listener`: A subclasses of :class:`CommandListener`, :class:`ServerHeartbeatListener`, :class:`ServerListener`, :class:`TopologyListener`, or :class:`ConnectionPoolListener`. zListeners for %s must be either a CommandListener, ServerHeartbeatListener, ServerListener, TopologyListener, or ConnectionPoolListener.N)r,r r.r _LISTENERSrappendr#rr(rr$rrr )r1rrrregisters           r5Z authenticateZ saslstartZ saslcontinueZgetnonceZ createuserZ updateuserZcopydbgetnonceZcopydbsaslstartZcopydbc@sLeZdZdZdZddZedd Zed d Zed d Z eddZ dS) _CommandEventzBase class for command events. __cmd_name __rqst_id __conn_id__op_idcCs||_||_||_||_dS)N)_CommandEvent__cmd_name_CommandEvent__rqst_id_CommandEvent__conn_id_CommandEvent__op_id)r command_name request_id connection_id operation_idrrr__init__sz_CommandEvent.__init__cCs|jS)zThe command name.)r;)rrrrr?sz_CommandEvent.command_namecCs|jS)z"The request id for this operation.)r<)rrrrr@sz_CommandEvent.request_idcCs|jS)z@The address (host, port) of the server this command was sent to.)r=)rrrrrAsz_CommandEvent.connection_idcCs|jS)z(An id for this series of events or None.)r>)rrrrrB sz_CommandEvent.operation_idN)r7r8r9r:) r r r r __slots__rCpropertyr?r@rArBrrrrr6s   r6cs<eZdZdZd ZfddZeddZedd ZZ 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__dbcsX|std|ftt|}tt|j|f||jtkrHi|_n||_||_ dS)Nz%r is not a valid command) ValueErrornextitersuperrFrClower_SENSITIVE_COMMANDS_CommandStartedEvent__cmd_CommandStartedEvent__db)rcommand database_nameargsr?) __class__rrrCs  zCommandStartedEvent.__init__cCs|jS)zThe command document.)rO)rrrrrQ*szCommandStartedEvent.commandcCs|jS)z6The name of the database this command was run against.)rP)rrrrrR/sz!CommandStartedEvent.database_name)rGrH) r r r rrDrCrErQrR __classcell__rr)rTrrFs   rFcs<eZdZdZd ZfddZeddZedd ZZ S) 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|j||||t||_|jtkr4i|_n||_dS)N)rLrVrCr+'_CommandSucceededEvent__duration_microsrMrN_CommandSucceededEvent__reply)rdurationreplyr?r@rArB)rTrrrCCs     zCommandSucceededEvent.__init__cCs|jS)z/The duration of this operation in microseconds.)rY)rrrrduration_microsMsz%CommandSucceededEvent.duration_microscCs|jS)z/The server failure document for this operation.)rZ)rrrrr\RszCommandSucceededEvent.reply)rWrX) r r r rrDrCrEr]r\rUrr)rTrrV5s   rVcs<eZdZdZd ZfddZeddZedd ZZ S) 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. rW __failurecs$tt|j|t||_||_dS)N)rLr^rCr+$_CommandFailedEvent__duration_micros_CommandFailedEvent__failure)rr[failurerS)rTrrrCfs zCommandFailedEvent.__init__cCs|jS)z/The duration of this operation in microseconds.)r`)rrrrr]ksz"CommandFailedEvent.duration_microscCs|jS)z/The server failure document for this operation.)ra)rrrrrbpszCommandFailedEvent.failure)rWr_) r r r rrDrCrEr]rbrUrr)rTrr^Xs    r^c@s0eZdZdZd ZddZeddZddZd S) _PoolEventzBase class for pool events. __addresscCs ||_dS)N)_PoolEvent__address)raddressrrrrCzsz_PoolEvent.__init__cCs|jS)zbThe address (host, port) pair of the server the pool is attempting to connect to. )re)rrrrrf}sz_PoolEvent.addresscCsd|jj|jfS)Nz%s(%r))rTr re)rrrr__repr__sz_PoolEvent.__repr__N)rd) r r r rrDrCrErfrgrrrrrcvs  rccs8eZdZdZd ZfddZeddZddZZ 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|j|||_dS)N)rLrhrC_PoolCreatedEvent__options)rrfoptions)rTrrrCszPoolCreatedEvent.__init__cCs|jS)zLAny non-default pool options that were set on this Connection Pool. )rj)rrrrrkszPoolCreatedEvent.optionscCsd|jj|j|jfS)Nz %s(%r, %r))rTr rfrj)rrrrrgszPoolCreatedEvent.__repr__)ri) r r r rrDrCrErkrgrUrr)rTrrhs   rhc@seZdZdZfZdS)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 N)r r r rrDrrrrrlsrlc@seZdZdZfZdS)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 N)r r r rrDrrrrrmsrmc@s eZdZdZdZdZdZdZdS)ConnectionClosedReasonzqAn enum that defines values for `reason` on a :class:`ConnectionClosedEvent`. .. versionadded:: 3.9 staleZidleerror poolClosedN)r r r rZSTALEZIDLEERROR POOL_CLOSEDrrrrrns rnc@seZdZdZdZdZdZdS)ConnectionCheckOutFailedReasonzyAn enum that defines values for `reason` on a :class:`ConnectionCheckOutFailedEvent`. .. versionadded:: 3.9 timeoutrqZconnectionErrorN)r r r rTIMEOUTrsZ CONN_ERRORrrrrrts rtc@s<eZdZdZd ZddZeddZedd Zd d Z d S)_ConnectionEventz.Private base class for some connection events.rd__connection_idcCs||_||_dS)N)_ConnectionEvent__address_ConnectionEvent__connection_id)rrfrArrrrCsz_ConnectionEvent.__init__cCs|jS)ziThe address (host, port) pair of the server this connection is attempting to connect to. )ry)rrrrrfsz_ConnectionEvent.addresscCs|jS)zThe ID of the Connection.)rz)rrrrrAsz_ConnectionEvent.connection_idcCsd|jj|j|jfS)Nz %s(%r, %r))rTr ryrz)rrrrrgsz_ConnectionEvent.__repr__N)rdrx) r r r rrDrCrErfrArgrrrrrws   rwc@seZdZdZfZdS)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 N)r r r rrDrrrrr{s r{c@seZdZdZfZdS)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 N)r r r rrDrrrrr| s r|cs8eZdZdZd ZfddZeddZddZZ S) 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|j||||_dS)N)rLr}rC_ConnectionClosedEvent__reason)rrfrAreason)rTrrrC%szConnectionClosedEvent.__init__cCs|jS)zA reason explaining why this connection was closed. The reason must be one of the strings from the :class:`ConnectionClosedReason` enum. )r)rrrrr)szConnectionClosedEvent.reasoncCsd|jj|j|j|jfS)Nz%s(%r, %r, %r))rTr rfrAr)rrrrrg2szConnectionClosedEvent.__repr__)r~) r r r rrDrCrErrgrUrr)rTrr}s    r}c@s0eZdZdZd ZddZeddZddZd S) 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 rdcCs ||_dS)N)(_ConnectionCheckOutStartedEvent__address)rrfrrrrCCsz'ConnectionCheckOutStartedEvent.__init__cCs|jS)ziThe address (host, port) pair of the server this connection is attempting to connect to. )r)rrrrrfFsz&ConnectionCheckOutStartedEvent.addresscCsd|jj|jfS)Nz%s(%r))rTr r)rrrrrgMsz'ConnectionCheckOutStartedEvent.__repr__N)rd) r r r rrDrCrErfrgrrrrr8s  rc@s<eZdZdZd ZddZeddZedd Zd d Z d S)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 rdr~cCs||_||_dS)N)'_ConnectionCheckOutFailedEvent__address&_ConnectionCheckOutFailedEvent__reason)rrfrrrrrC]sz&ConnectionCheckOutFailedEvent.__init__cCs|jS)ziThe address (host, port) pair of the server this connection is attempting to connect to. )r)rrrrrfasz%ConnectionCheckOutFailedEvent.addresscCs|jS)zA reason explaining why connection check out failed. The reason must be one of the strings from the :class:`ConnectionCheckOutFailedReason` enum. )r)rrrrrhsz$ConnectionCheckOutFailedEvent.reasoncCsd|jj|j|jfS)Nz %s(%r, %r))rTr rr)rrrrrgqsz&ConnectionCheckOutFailedEvent.__repr__N)rdr~) r r r rrDrCrErfrrgrrrrrQs    rc@seZdZdZfZdS)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 N)r r r rrDrrrrrvs rc@seZdZdZfZdS)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 N)r r r rrDrrrrrs rc@s4eZdZdZd ZddZeddZedd Zd S) _ServerEventzBase class for server events.__server_address __topology_idcCs||_||_dS)N)_ServerEvent__server_address_ServerEvent__topology_id)rserver_address topology_idrrrrCsz_ServerEvent.__init__cCs|jS)z+The address (host, port) pair of the server)r)rrrrrsz_ServerEvent.server_addresscCs|jS)z>A unique identifier for the topology this server is a part of.)r)rrrrrsz_ServerEvent.topology_idN)rr) r r r rrDrCrErrrrrrrs  rcs<eZdZdZd ZfddZeddZedd ZZ S) ServerDescriptionChangedEventzJPublished when server description changes. .. versionadded:: 3.3 __previous_description__new_descriptioncs tt|j|||_||_dS)N)rLrrC4_ServerDescriptionChangedEvent__previous_description/_ServerDescriptionChangedEvent__new_description)rprevious_descriptionnew_descriptionrS)rTrrrCsz&ServerDescriptionChangedEvent.__init__cCs|jS)zLThe previous :class:`~pymongo.server_description.ServerDescription`.)r)rrrrrsz2ServerDescriptionChangedEvent.previous_descriptioncCs|jS)zGThe new :class:`~pymongo.server_description.ServerDescription`.)r)rrrrrsz-ServerDescriptionChangedEvent.new_description)rr) r r r rrDrCrErrrUrr)rTrrs   rc@seZdZdZfZdS)ServerOpeningEventzEPublished when server is initialized. .. versionadded:: 3.3 N)r r r rrDrrrrrsrc@seZdZdZfZdS)ServerClosedEventz@Published when server is closed. .. versionadded:: 3.3 N)r r r rrDrrrrrsrc@s(eZdZdZdZddZeddZdS) TopologyEventz+Base class for topology description events.rcCs ||_dS)N)_TopologyEvent__topology_id)rrrrrrCszTopologyEvent.__init__cCs|jS)z>A unique identifier for the topology this server is a part of.)r)rrrrrszTopologyEvent.topology_idN)r r r rrDrCrErrrrrrsrcs<eZdZdZd ZfddZeddZedd ZZ S) TopologyDescriptionChangedEventzPPublished when the topology description changes. .. versionadded:: 3.3 rrcs tt|j|||_||_dS)N)rLrrC6_TopologyDescriptionChangedEvent__previous_description1_TopologyDescriptionChangedEvent__new_description)rrrrS)rTrrrCsz(TopologyDescriptionChangedEvent.__init__cCs|jS)zPThe previous :class:`~pymongo.topology_description.TopologyDescription`.)r)rrrrrsz4TopologyDescriptionChangedEvent.previous_descriptioncCs|jS)zKThe new :class:`~pymongo.topology_description.TopologyDescription`.)r)rrrrrsz/TopologyDescriptionChangedEvent.new_description)rr) r r r rrDrCrErrrUrr)rTrrs   rc@seZdZdZfZdS)TopologyOpenedEventzKPublished when the topology is initialized. .. versionadded:: 3.3 N)r r r rrDrrrrrsrc@seZdZdZfZdS)TopologyClosedEventzFPublished when the topology is closed. .. versionadded:: 3.3 N)r r r rrDrrrrrsrc@s(eZdZdZdZddZeddZdS)_ServerHeartbeatEventz'Base class for server heartbeat events.rxcCs ||_dS)N)$_ServerHeartbeatEvent__connection_id)rrArrrrCsz_ServerHeartbeatEvent.__init__cCs|jS)zJThe address (host, port) of the server this heartbeat was sent to.)r)rrrrrAsz#_ServerHeartbeatEvent.connection_idN)r r r rrDrCrErArrrrr src@seZdZdZfZdS)ServerHeartbeatStartedEventzFPublished when a heartbeat is started. .. versionadded:: 3.3 N)r r r rrDrrrrrsrcs<eZdZdZd ZfddZeddZedd ZZ S) ServerHeartbeatSucceededEventzIFired when the server heartbeat succeeds. .. versionadded:: 3.3 __durationrXcs tt|j|||_||_dS)N)rLrrC(_ServerHeartbeatSucceededEvent__duration%_ServerHeartbeatSucceededEvent__reply)rr[r\rS)rTrrrC*sz&ServerHeartbeatSucceededEvent.__init__cCs|jS)z/The duration of this heartbeat in microseconds.)r)rrrrr[/sz&ServerHeartbeatSucceededEvent.durationcCs|jS)z3An instance of :class:`~pymongo.ismaster.IsMaster`.)r)rrrrr\4sz#ServerHeartbeatSucceededEvent.reply)rrX) r r r rrDrCrEr[r\rUrr)rTrr"s   rcs<eZdZdZd ZfddZeddZedd ZZ S) ServerHeartbeatFailedEventzxFired when the server heartbeat fails, either with an "ok: 0" or a socket exception. .. versionadded:: 3.3 rrXcs tt|j|||_||_dS)N)rLrrC%_ServerHeartbeatFailedEvent__duration"_ServerHeartbeatFailedEvent__reply)rr[r\rS)rTrrrCCsz#ServerHeartbeatFailedEvent.__init__cCs|jS)z/The duration of this heartbeat in microseconds.)r)rrrrr[Hsz#ServerHeartbeatFailedEvent.durationcCs|jS)zA subclass of :exc:`Exception`.)r)rrrrr\Msz ServerHeartbeatFailedEvent.reply)rrX) r r r rrDrCrEr[r\rUrr)rTrr: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|_ |dk rxz|D]r}t |t r||jj |t |tr|jj |t |tr|jj |t |tr|jj |t |trb|j j |qbWt|j|_t|j|_t|j|_t|j|_t|j |_dS)N)r3r"_EventListeners__command_listenersr!_EventListeners__server_listenersr+_EventListeners__server_heartbeat_listenersr#_EventListeners__topology_listenersr _EventListeners__cmap_listenersr,rr4r(r#r$rbool%_EventListeners__enabled_for_commands#_EventListeners__enabled_for_server-_EventListeners__enabled_for_server_heartbeat%_EventListeners__enabled_for_topology!_EventListeners__enabled_for_cmap)rr0lstrrrrC[s0              z_EventListeners.__init__cCs|jS)z-Are any CommandListener instances registered?)r)rrrrenabled_for_commandsusz$_EventListeners.enabled_for_commandscCs|jS)z,Are any ServerListener instances registered?)r)rrrrenabled_for_serverzsz"_EventListeners.enabled_for_servercCs|jS)z5Are any ServerHeartbeatListener instances registered?)r)rrrrenabled_for_server_heartbeatsz,_EventListeners.enabled_for_server_heartbeatcCs|jS)z.Are any TopologyListener instances registered?)r)rrrrenabled_for_topologysz$_EventListeners.enabled_for_topologycCs|jS)z4Are any ConnectionPoolListener instances registered?)r)rrrrenabled_for_cmapsz _EventListeners.enabled_for_cmapcCs4|jdd|jdd|jdd|jddfS)z#List of registered event listeners.N)rrrr)rrrrevent_listenerss   z_EventListeners.event_listenersNc CsZ|dkr |}t|||||}x8|jD].}y|j|Wq$tk rPtYq$Xq$WdS)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)rFrr Exceptionr)rrQrRr@rAop_idr subscriberrrrpublish_command_starts  z%_EventListeners.publish_command_startc Cs\|dkr |}t||||||}x8|jD].}y|j|Wq&tk rRtYq&Xq&WdS)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)rVrrrr) rr[r\r?r@rArrrrrrpublish_command_successs  z'_EventListeners.publish_command_successc Cs\|dkr |}t||||||}x8|jD].}y|j|Wq&tk rRtYq&Xq&WdS)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^rrrr) rr[rbr?r@rArrrrrrpublish_command_failures z'_EventListeners.publish_command_failurec CsFt|}x8|jD].}y|j|Wqtk r<tYqXqWdS)zPublish a ServerHeartbeatStartedEvent to all server heartbeat listeners. :Parameters: - `connection_id`: The address (host, port) pair of the connection. N)rrrrr)rrArrrrr publish_server_heartbeat_starteds  z0_EventListeners.publish_server_heartbeat_startedc CsJt|||}x8|jD].}y|j|Wqtk r@tYqXqWdS)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)rrrrr)rrAr[r\rrrrr"publish_server_heartbeat_succeededs  z2_EventListeners.publish_server_heartbeat_succeededc CsJt|||}x8|jD].}y|j|Wqtk r@tYqXqWdS)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)rrrrr)rrAr[r\rrrrrpublish_server_heartbeat_faileds  z/_EventListeners.publish_server_heartbeat_failedc CsHt||}x8|jD].}y|j|Wqtk r>tYqXqWdS)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%rr)rrrrrrrrpublish_server_opened s   z%_EventListeners.publish_server_openedc CsHt||}x8|jD].}y|j|Wqtk r>tYqXqWdS)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)rrr'rr)rrrrrrrrpublish_server_closeds   z%_EventListeners.publish_server_closedc CsLt||||}x8|jD].}y|j|Wqtk rBtYqXqWdS)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&rr)rrrrrrrrrr"publish_server_description_changed*s  z2_EventListeners.publish_server_description_changedc CsFt|}x8|jD].}y|j|Wqtk r<tYqXqWdS)zPublish a TopologyOpenedEvent to all topology listeners. :Parameters: - `topology_id`: A unique identifier for the topology this server is a part of. N)rrr%rr)rrrrrrrpublish_topology_opened?s  z'_EventListeners.publish_topology_openedc CsFt|}x8|jD].}y|j|Wqtk r<tYqXqWdS)zPublish a TopologyClosedEvent to all topology listeners. :Parameters: - `topology_id`: A unique identifier for the topology this server is a part of. N)rrr'rr)rrrrrrrpublish_topology_closedMs  z'_EventListeners.publish_topology_closedc CsJt|||}x8|jD].}y|j|Wqtk r@tYqXqWdS)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&rr)rrrrrrrrr$publish_topology_description_changed[s  z4_EventListeners.publish_topology_description_changedc CsHt||}x8|jD].}y|j|Wqtk r>tYqXqWdS)zCPublish a :class:`PoolCreatedEvent` to all pool listeners. N)rhrrrr)rrfrkrrrrrpublish_pool_createdms   z$_EventListeners.publish_pool_createdc CsFt|}x8|jD].}y|j|Wqtk r<tYqXqWdS)zCPublish a :class:`PoolClearedEvent` to all pool listeners. N)rlrrrr)rrfrrrrrpublish_pool_clearedws  z$_EventListeners.publish_pool_clearedc CsFt|}x8|jD].}y|j|Wqtk r<tYqXqWdS)zBPublish a :class:`PoolClosedEvent` to all pool listeners. N)rmrrrr)rrfrrrrrpublish_pool_closeds  z#_EventListeners.publish_pool_closedc CsHt||}x8|jD].}y|j|Wqtk r>tYqXqWdS)zWPublish a :class:`ConnectionCreatedEvent` to all connection listeners. N)r{rrrr)rrfrArrrrrpublish_connection_createds   z*_EventListeners.publish_connection_createdc CsHt||}x8|jD].}y|j|Wqtk r>tYqXqWdS)zMPublish a :class:`ConnectionReadyEvent` to all connection listeners. N)r|rrrr)rrfrArrrrrpublish_connection_readys   z(_EventListeners.publish_connection_readyc CsJt|||}x8|jD].}y|j|Wqtk r@tYqXqWdS)zVPublish a :class:`ConnectionClosedEvent` to all connection listeners. N)r}rrrr)rrfrArrrrrrpublish_connection_closeds   z)_EventListeners.publish_connection_closedc CsFt|}x8|jD].}y|j|Wqtk r<tYqXqWdS)z_Publish a :class:`ConnectionCheckOutStartedEvent` to all connection listeners. N)rrrrr)rrfrrrrr$publish_connection_check_out_starteds  z4_EventListeners.publish_connection_check_out_startedc CsHt||}x8|jD].}y|j|Wqtk r>tYqXqWdS)z^Publish a :class:`ConnectionCheckOutFailedEvent` to all connection listeners. N)rrrrr)rrfrrrrrr#publish_connection_check_out_faileds   z3_EventListeners.publish_connection_check_out_failedc CsHt||}x8|jD].}y|j|Wqtk r>tYqXqWdS)zZPublish a :class:`ConnectionCheckedOutEvent` to all connection listeners. N)rrr!rr)rrfrArrrrrpublish_connection_checked_outs   z._EventListeners.publish_connection_checked_outc CsHt||}x8|jD].}y|j|Wqtk r>tYqXqWdS)zYPublish a :class:`ConnectionCheckedInEvent` to all connection listeners. N)rrr"rr)rrfrArrrrrpublish_connection_checked_ins   z-_EventListeners.publish_connection_checked_in)N)N)N)"r r r rrCrErrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrSs<                 rN)rrrrr )4r collectionsrZbson.py3compatrZpymongo.helpersrZ _Listenersr3objectr rrr#r$r(r+r2r5setrNr6rFrVr^rcrhrlrmrnrtrwr{r|r}rrrrrrrrrrrrrrrrrrrrrsf    w"!!   $#    %