U d @sUdZddlmZddlZddlmZmZddlmZm Z m Z m Z m Z m Z mZddlmZddlmZmZddlmZdd lmZmZerdd lmZdd lmZdd lmZed dZegggggZGdddZ Gddde Z!Gddde Z"Gddde Z#Gddde Z$Gddde Z%dddddZ&d d!d!d"d#d$Z'dd%d&d'd(Z(d)d*d+d,d-d.d/d0d1h Z)d2e*d3<d d4d5d6d7d8Z+Gd9d:d:Z,Gd;d<dd>e,Z.Gd?d@d@e,Z/GdAdBdBZ0GdCdDdDe0Z1GdEdFdFe0Z2GdGdHdHe0Z3GdIdJdJe0Z4GdKdLdLZ5GdMdNdNZ6GdOdPdPZ7GdQdRdRe7Z8GdSdTdTe8Z9GdUdVdVe8Z:GdWdXdXe8Z;GdYdZdZe7ZGd_d`d`e8Z?GdadbdbZ@Gdcdddde@ZAGdedfdfe@ZBGdgdhdhe@ZCGdidjdjZDGdkdldleDZEGdmdndneDZFGdodpdpeDZGGdqdrdrZHGdsdtdteHZIGdudvdveHZJGdwdxdxeHZKGdydzdzZLdS){aTools 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_CHECKINGAnyDictListMappingOptionalSequence)ObjectId)Hello HelloCompat)_handle_exception)_Address _DocumentOut) timedelta)ServerDescription)TopologyDescription _Listeners)command_listenersserver_listenersserver_heartbeat_listenerstopology_listenerscmap_listenersc@seZdZdZdS)_EventListenerz,Abstract base class for all event listeners.N)__name__ __module__ __qualname____doc__r r 6/tmp/pip-unpacked-wheel-oblwsawz/pymongo/monitoring.pyrsrc@s@eZdZdZdddddZddddd Zd ddd d Zd S)CommandListenerzAbstract base class for command listeners. Handles `CommandStartedEvent`, `CommandSucceededEvent`, and `CommandFailedEvent`. z'CommandStartedEvent'NoneeventreturncCstdS)zAbstract method to handle a `CommandStartedEvent`. :Parameters: - `event`: An instance of :class:`CommandStartedEvent`. NNotImplementedErrorselfr%r r r!startedszCommandListener.startedz'CommandSucceededEvent'cCstdS)zAbstract method to handle a `CommandSucceededEvent`. :Parameters: - `event`: An instance of :class:`CommandSucceededEvent`. Nr'r)r r r! succeededszCommandListener.succeededz'CommandFailedEvent'cCstdS)zAbstract method to handle a `CommandFailedEvent`. :Parameters: - `event`: An instance of :class:`CommandFailedEvent`. Nr'r)r r r!failedszCommandListener.failedNrrrrr+r,r-r r r r!r"sr"c@seZdZdZdddddZddddd Zd ddd d Zd ddddZdddddZdddddZ dddddZ dddddZ dddddZ dddd d!Z d"ddd#d$Zd%S)&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 z'PoolCreatedEvent'r#r$cCstdS)zAbstract method to handle a :class:`PoolCreatedEvent`. Emitted when a connection Pool is created. :Parameters: - `event`: An instance of :class:`PoolCreatedEvent`. Nr'r)r r r! pool_createdsz#ConnectionPoolListener.pool_createdz'PoolReadyEvent'cCstdS)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 Nr'r)r r r! pool_readys z!ConnectionPoolListener.pool_readyz'PoolClearedEvent'cCstdS)zAbstract method to handle a `PoolClearedEvent`. Emitted when a connection Pool is cleared. :Parameters: - `event`: An instance of :class:`PoolClearedEvent`. Nr'r)r r r! pool_cleared$sz#ConnectionPoolListener.pool_clearedz'PoolClosedEvent'cCstdS)zAbstract method to handle a `PoolClosedEvent`. Emitted when a connection Pool is closed. :Parameters: - `event`: An instance of :class:`PoolClosedEvent`. Nr'r)r r r! pool_closed.sz"ConnectionPoolListener.pool_closedz'ConnectionCreatedEvent'cCstdS)zAbstract method to handle a :class:`ConnectionCreatedEvent`. Emitted when a connection Pool creates a Connection object. :Parameters: - `event`: An instance of :class:`ConnectionCreatedEvent`. Nr'r)r r r!connection_created8sz)ConnectionPoolListener.connection_createdz'ConnectionReadyEvent'cCstdS)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`. Nr'r)r r r!connection_readyBs z'ConnectionPoolListener.connection_readyz'ConnectionClosedEvent'cCstdS)zAbstract method to handle a :class:`ConnectionClosedEvent`. Emitted when a connection Pool closes a connection. :Parameters: - `event`: An instance of :class:`ConnectionClosedEvent`. Nr'r)r r r!connection_closedMsz(ConnectionPoolListener.connection_closedz 'ConnectionCheckOutStartedEvent'cCstdS)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`. Nr'r)r r r!connection_check_out_startedWsz3ConnectionPoolListener.connection_check_out_startedz'ConnectionCheckOutFailedEvent'cCstdS)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`. Nr'r)r r r!connection_check_out_failedasz2ConnectionPoolListener.connection_check_out_failedz'ConnectionCheckedOutEvent'cCstdS)zAbstract method to handle a :class:`ConnectionCheckedOutEvent`. Emitted when the driver successfully checks out a connection. :Parameters: - `event`: An instance of :class:`ConnectionCheckedOutEvent`. Nr'r)r r r!connection_checked_outksz-ConnectionPoolListener.connection_checked_outz'ConnectionCheckedInEvent'cCstdS)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`. Nr'r)r r r!connection_checked_inus z,ConnectionPoolListener.connection_checked_inN)rrrrr0r1r2r3r4r5r6r7r8r9r:r r r r!r/s          r/c@s@eZdZdZdddddZddddd Zd ddd d Zd S)ServerHeartbeatListenerzAbstract base class for server heartbeat listeners. Handles `ServerHeartbeatStartedEvent`, `ServerHeartbeatSucceededEvent`, and `ServerHeartbeatFailedEvent`. .. versionadded:: 3.3 z'ServerHeartbeatStartedEvent'r#r$cCstdS)zAbstract method to handle a `ServerHeartbeatStartedEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatStartedEvent`. Nr'r)r r r!r+szServerHeartbeatListener.startedz'ServerHeartbeatSucceededEvent'cCstdS)zAbstract method to handle a `ServerHeartbeatSucceededEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatSucceededEvent`. Nr'r)r r r!r,sz!ServerHeartbeatListener.succeededz'ServerHeartbeatFailedEvent'cCstdS)zAbstract method to handle a `ServerHeartbeatFailedEvent`. :Parameters: - `event`: An instance of :class:`ServerHeartbeatFailedEvent`. Nr'r)r r r!r-szServerHeartbeatListener.failedNr.r r r r!r;sr;c@s@eZdZdZdddddZddddd Zd ddd d Zd S)TopologyListenerzAbstract base class for topology monitoring listeners. Handles `TopologyOpenedEvent`, `TopologyDescriptionChangedEvent`, and `TopologyClosedEvent`. .. versionadded:: 3.3 z'TopologyOpenedEvent'r#r$cCstdS)zAbstract method to handle a `TopologyOpenedEvent`. :Parameters: - `event`: An instance of :class:`TopologyOpenedEvent`. Nr'r)r r r!openedszTopologyListener.openedz!'TopologyDescriptionChangedEvent'cCstdS)zAbstract method to handle a `TopologyDescriptionChangedEvent`. :Parameters: - `event`: An instance of :class:`TopologyDescriptionChangedEvent`. Nr'r)r r r!description_changedsz$TopologyListener.description_changedz'TopologyClosedEvent'cCstdS)zAbstract method to handle a `TopologyClosedEvent`. :Parameters: - `event`: An instance of :class:`TopologyClosedEvent`. Nr'r)r r r!closedszTopologyListener.closedNrrrrr=r>r?r r r r!r<sr<c@s@eZdZdZdddddZddddd Zd ddd d Zd S)ServerListenerzAbstract base class for server listeners. Handles `ServerOpeningEvent`, `ServerDescriptionChangedEvent`, and `ServerClosedEvent`. .. versionadded:: 3.3 z'ServerOpeningEvent'r#r$cCstdS)zAbstract method to handle a `ServerOpeningEvent`. :Parameters: - `event`: An instance of :class:`ServerOpeningEvent`. Nr'r)r r r!r=szServerListener.openedz'ServerDescriptionChangedEvent'cCstdS)zAbstract method to handle a `ServerDescriptionChangedEvent`. :Parameters: - `event`: An instance of :class:`ServerDescriptionChangedEvent`. Nr'r)r r r!r>sz"ServerListener.description_changedz'ServerClosedEvent'cCstdS)zAbstract method to handle a `ServerClosedEvent`. :Parameters: - `event`: An instance of :class:`ServerClosedEvent`. Nr'r)r r r!r?szServerListener.closedNr@r r r r!rAsrArint)durr&cCst|dS)z'Convert duration 'dur' to microseconds.g.A)rB total_seconds)rCr r r! _to_microssrEstrzSequence[_EventListeners])option listenersr&cCs@t|tjst|d|D]}t|tstd|q|S)zValidate event listenersz must be a list or tupleListeners for {} must be either a CommandListener, ServerHeartbeatListener, ServerListener, TopologyListener, or ConnectionPoolListener.) isinstancerr TypeErrorrformat)rGrHlistenerr r r!_validate_event_listenerss  rNr#)rMr&cCst|tstd|t|tr.tj|t|trDtj |t|t rZtj |t|t rptj |t|trtj|dS)aRegister a global event listener. :Parameters: - `listener`: A subclasses of :class:`CommandListener`, :class:`ServerHeartbeatListener`, :class:`ServerListener`, :class:`TopologyListener`, or :class:`ConnectionPoolListener`. rIN)rJrrKrLr" _LISTENERSrappendr;rrArr<rr/r)rMr r r!registers           rQZ authenticateZ saslstartZ saslcontinueZgetnonceZ createuserZ updateuserZcopydbgetnonceZcopydbsaslstartZcopydbset_SENSITIVE_COMMANDSzMapping[str, Any]bool) command_namedocr&cCs"|dtjfkrd|krdSdS)NZhelloZspeculativeAuthenticateTF)lowerrZ LEGACY_CMD)rUrVr r r!_is_speculative_authenticate(s rXc@seZdZdZdZddddddd d d d Zedd ddZedd ddZedd ddZ edd ddZ edd ddZ dS) _CommandEventzBase class for command events.)Z __cmd_nameZ __rqst_idZ __conn_idZ__op_id __service_idNrFrBr Optional[int]Optional[ObjectId]r#)rU request_id connection_id operation_id service_idr&cCs"||_||_||_||_||_dSN)_CommandEvent__cmd_name_CommandEvent__rqst_id_CommandEvent__conn_id_CommandEvent__op_id_CommandEvent__service_id)r*rUr]r^r_r`r r r!__init__6s z_CommandEvent.__init__r&cCs|jS)zThe command name.)rbr*r r r!rUDsz_CommandEvent.command_namecCs|jS)z"The request id for this operation.)rcrir r r!r]Isz_CommandEvent.request_idcCs|jS)z@The address (host, port) of the server this command was sent to.)rdrir r r!r^Nsz_CommandEvent.connection_idcCs|jS)z^The service_id this command was sent to, or ``None``. .. versionadded:: 3.12 )rfrir r r!r`Ssz_CommandEvent.service_idcCs|jS)z(An id for this series of events or None.)rerir r r!r_[sz_CommandEvent.operation_id)N) rrrr __slots__rgpropertyrUr]r^r`r_r r r r!rY1srYc sjeZdZdZdZddddddd d d fd d ZeddddZeddddZddddZ Z 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. - `service_id`: The service_id this command was sent to, or ``None``. )Z__cmdZ__dbNrrFrBrr[r\r#)command database_namer]r^r_r`r&c sf|st|dtt|}tj|||||d|}|tksNt||rVi|_n||_||_ dS)Nz is not a valid commandr`) ValueErrornextitersuperrgrWrSrX_CommandStartedEvent__cmd_CommandStartedEvent__db) r*rmrnr]r^r_r`rUcmd_name __class__r r!rgps  zCommandStartedEvent.__init__rhcCs|jS)zThe command document.)rtrir r r!rmszCommandStartedEvent.commandcCs|jS)z6The name of the database this command was run against.)rurir r r!rnsz!CommandStartedEvent.database_namecCs"d|jj|j|j|j|j|jS)NzA<{} {} db: {!r}, command: {!r}, operation_id: {}, service_id: {}>)rLrxrr^rnrUr_r`rir r r!__repr__szCommandStartedEvent.__repr__)N) rrrrrjrgrkrmrnry __classcell__r r rwr!rlas  rlc sleZdZdZdZddddddd d d d fd d ZeddddZeddddZddddZ Z S)CommandSucceededEventa Event 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``. )__duration_micros__replyNdatetime.timedeltarrFrBrr[r\r#)durationreplyrUr]r^r_r`r&c sLtj|||||dt||_|}|tks:t||rBi|_n||_dSNro)rsrgrE'_CommandSucceededEvent__duration_microsrWrSrX_CommandSucceededEvent__reply) r*rrrUr]r^r_r`rvrwr r!rgs  zCommandSucceededEvent.__init__rhcCs|jSz/The duration of this operation in microseconds.)rrir r r!duration_microssz%CommandSucceededEvent.duration_microscCs|jSz/The server failure document for this operation.)rrir r r!rszCommandSucceededEvent.replycCs"d|jj|j|j|j|j|jS)NzL<{} {} command: {!r}, operation_id: {}, duration_micros: {}, service_id: {}>)rLrxrr^rUr_rr`rir r r!ryszCommandSucceededEvent.__repr__)N) rrrrrjrgrkrrryrzr r rwr!r{s  "r{c sleZdZdZdZddddddd d d d fd d ZeddddZeddddZddddZ Z S)CommandFailedEventa Event 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``. )r|Z __failureNr~rrFrBrr[r\r#)rfailurerUr]r^r_r`r&cs*tj|||||dt||_||_dSr)rsrgrE$_CommandFailedEvent__duration_micros_CommandFailedEvent__failure)r*rrrUr]r^r_r`rwr r!rgs  zCommandFailedEvent.__init__rhcCs|jSr)rrir r r!rsz"CommandFailedEvent.duration_microscCs|jSr)rrir r r!rszCommandFailedEvent.failurec Cs&d|jj|j|j|j|j|j|jS)Nz[<{} {} command: {!r}, operation_id: {}, duration_micros: {}, failure: {!r}, service_id: {}>) rLrxrr^rUr_rrr`rir r r!ryszCommandFailedEvent.__repr__)N) rrrrrjrgrkrrryrzr r rwr!rs  "rc@sDeZdZdZdZdddddZeddd d Zd dd d ZdS) _PoolEventzBase class for pool events.Z __addressrr#addressr&cCs ||_dSra_PoolEvent__addressr*rr r r!rgsz_PoolEvent.__init__rhcCs|jS)zbThe address (host, port) pair of the server the pool is attempting to connect to. rrir r r!rsz_PoolEvent.addressrFcCs|jjd|jdSN())rxrrrir r r!rysz_PoolEvent.__repr__N rrrrrjrgrkrryr r r r!rs rcsNeZdZdZdZddddfdd Zedd d d Zd d d dZZ 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 )Z __optionsrDict[str, Any]r#roptionsr&cst|||_dSra)rsrg_PoolCreatedEvent__options)r*rrrwr r!rg/s zPoolCreatedEvent.__init__rhcCs|jS)zCAny non-default pool options that were set on this Connection Pool.)rrir r r!r3szPoolCreatedEvent.optionsrFcCs|jjd|jd|jdSNrz, r)rxrrrrir r r!ry8szPoolCreatedEvent.__repr__) rrrrrjrgrkrryrzr r rwr!r#s  rc@seZdZdZdZdS)PoolReadyEventzPublished 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 Nrrrrrjr r r r!r<s rcsPeZdZdZdZdddddfdd Zedd d d Zd d ddZZ S)PoolClearedEventaPublished 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 )rZNrr\r#rr`r&cst|||_dSra)rsrg_PoolClearedEvent__service_id)r*rr`rwr r!rgVs zPoolClearedEvent.__init__rhcCs|jS)zConnections with this service_id are cleared. When service_id is ``None``, all connections in the pool are cleared. .. versionadded:: 3.12 )rrir r r!r`ZszPoolClearedEvent.service_idrFcCs|jjd|jd|jdSr)rxrrrrir r r!rydszPoolClearedEvent.__repr__)N) rrrrrjrgrkr`ryrzr r rwr!rIs   rc@seZdZdZdZdS)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 r Nrr r r r!rhs rc@s eZdZdZdZdZdZdZdS)ConnectionClosedReasonzqAn enum that defines values for `reason` on a :class:`ConnectionClosedEvent`. .. versionadded:: 3.9 staleZidleerror poolClosedN)rrrrZSTALEZIDLEERROR POOL_CLOSEDr r r r!rus rc@seZdZdZdZdZdZdS)ConnectionCheckOutFailedReasonzyAn enum that defines values for `reason` on a :class:`ConnectionCheckOutFailedEvent`. .. versionadded:: 3.9 timeoutrZconnectionErrorN)rrrrTIMEOUTrZ CONN_ERRORr r r r!rs rc@sDeZdZdZdZdddddZeddd d Zd dd d ZdS)_ConnectionEventz)Private base class for connection events.rrr#rcCs ||_dSra_ConnectionEvent__addressrr r r!rgsz_ConnectionEvent.__init__rhcCs|jS)ziThe address (host, port) pair of the server this connection is attempting to connect to. rrir r r!rsz_ConnectionEvent.addressrFcCs|jjd|jdSr)rxrrrir r r!rysz_ConnectionEvent.__repr__Nrr r r r!rs rcsNeZdZdZdZddddfdd Zedd d d Zd d d dZZ S)_ConnectionIdEventz4Private base class for connection events with an id.)__connection_idrrBr#rr^r&cst|||_dSra)rsrg!_ConnectionIdEvent__connection_id)r*rr^rwr r!rgs z_ConnectionIdEvent.__init__rhcCs|jS)zThe ID of the connection.)rrir r r!r^sz _ConnectionIdEvent.connection_idrFcCs|jjd|jd|jdSr)rxrrrrir r r!rysz_ConnectionIdEvent.__repr__) rrrrrjrgrkr^ryrzr r rwr!rs rc@seZdZdZdZdS)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 r Nrr r r r!rs rc@seZdZdZdZdS)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 r Nrr r r r!rs rcsNeZdZdZdZddddfdd Zedd d d Zdd d d ZZ 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 Z__reasonrrBrF)rr^reasoncst||||_dSra)rsrg_ConnectionClosedEvent__reason)r*rr^rrwr r!rgszConnectionClosedEvent.__init__rhcCs|jS)zA reason explaining why this connection was closed. The reason must be one of the strings from the :class:`ConnectionClosedReason` enum. )rrir r r!rszConnectionClosedEvent.reasoncCsd|jj|j|j|jS)Nz{}({!r}, {!r}, {!r}))rLrxrrr^rrir r r!rys zConnectionClosedEvent.__repr__ rrrrrjrgrkrryrzr r rwr!rs  rc@seZdZdZdZdS)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 r Nrr r r r!rs rcsNeZdZdZdZddddfdd Zedd d d Zdd d d ZZ 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 rrrFr#rrr&cst|||_dSra)rsrg&_ConnectionCheckOutFailedEvent__reason)r*rrrwr r!rgs z&ConnectionCheckOutFailedEvent.__init__rhcCs|jS)zA reason explaining why connection check out failed. The reason must be one of the strings from the :class:`ConnectionCheckOutFailedReason` enum. )rrir r r!r#sz$ConnectionCheckOutFailedEvent.reasoncCs|jjd|jd|jdSr)rxrrrrir r r!ry,sz&ConnectionCheckOutFailedEvent.__repr__rr r rwr!rs  rc@seZdZdZdZdS)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 r Nrr r r r!r0s rc@seZdZdZdZdS)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 r Nrr r r r!r>s rc@sXeZdZdZdZddddddZedd d d Zedd d d Zdd ddZ dS) _ServerEventzBase class for server events.)Z__server_address __topology_idrr r#server_address topology_idr&cCs||_||_dSra)_ServerEvent__server_address_ServerEvent__topology_id)r*rrr r r!rgQsz_ServerEvent.__init__rhcCs|jS)z+The address (host, port) pair of the server)rrir r r!rUsz_ServerEvent.server_addresscCs|jSz>A unique identifier for the topology this server is a part of.)rrir r r!rZsz_ServerEvent.topology_idrFcCsd|jj|j|jS)Nz<{} {} topology_id: {}>)rLrxrrrrir r r!ry_s z_ServerEvent.__repr__N) rrrrrjrgrkrrryr r r r!rLsrcsbeZdZdZdZdddddfdd Zedd d d Zedd d d Zdd ddZ Z S)ServerDescriptionChangedEventzJPublished when server description changes. .. versionadded:: 3.3 Z__previous_descriptionZ__new_descriptionrrr#previous_descriptionnew_descriptionargsr&cstj|||_||_dSra)rsrg4_ServerDescriptionChangedEvent__previous_description/_ServerDescriptionChangedEvent__new_descriptionr*rrrrwr r!rgos z&ServerDescriptionChangedEvent.__init__rhcCs|jS)zUThe previous :class:`~pymongo.server_description.ServerDescription`. )rrir r r!rysz2ServerDescriptionChangedEvent.previous_descriptioncCs|jS)zPThe new :class:`~pymongo.server_description.ServerDescription`. )rrir r r!rsz-ServerDescriptionChangedEvent.new_descriptionrFcCsd|jj|j|j|jS)Nz <{} {} changed from: {}, to: {}>)rLrxrrrrrir r r!rys z&ServerDescriptionChangedEvent.__repr__ rrrrrjrgrkrrryrzr r rwr!rgs rc@seZdZdZdZdS)ServerOpeningEventzEPublished when server is initialized. .. versionadded:: 3.3 r Nrr r r r!rsrc@seZdZdZdZdS)ServerClosedEventz@Published when server is closed. .. versionadded:: 3.3 r Nrr r r r!rsrc@sDeZdZdZdZdddddZeddd d Zd dd d ZdS) TopologyEventz+Base class for topology description events.rr r#rr&cCs ||_dSraZ_TopologyEvent__topology_id)r*rr r r!rgszTopologyEvent.__init__rhcCs|jSrrrir r r!rszTopologyEvent.topology_idrFcCsd|jjd|jdS)N)rxrrrir r r!ryszTopologyEvent.__repr__N) rrrrrjrgrkrryr r r r!rs rcsbeZdZdZdZdddddfdd Zedd d d Zedd d d Zdd ddZ Z S)TopologyDescriptionChangedEventzPPublished when the topology description changes. .. versionadded:: 3.3 rrrr#rcstj|||_||_dSra)rsrg6_TopologyDescriptionChangedEvent__previous_description1_TopologyDescriptionChangedEvent__new_descriptionrrwr r!rgs z(TopologyDescriptionChangedEvent.__init__rhcCs|jS)zYThe previous :class:`~pymongo.topology_description.TopologyDescription`. )rrir r r!rsz4TopologyDescriptionChangedEvent.previous_descriptioncCs|jS)zTThe new :class:`~pymongo.topology_description.TopologyDescription`. )rrir r r!rsz/TopologyDescriptionChangedEvent.new_descriptionrFcCsd|jj|j|j|jS)Nz-<{} topology_id: {} changed from: {}, to: {}>)rLrxrrrrrir r r!rys z(TopologyDescriptionChangedEvent.__repr__rr r rwr!rs rc@seZdZdZdZdS)TopologyOpenedEventzKPublished when the topology is initialized. .. versionadded:: 3.3 r Nrr r r r!rsrc@seZdZdZdZdS)TopologyClosedEventzFPublished when the topology is closed. .. versionadded:: 3.3 r Nrr r r r!rsrc@sDeZdZdZdZdddddZeddd d Zd dd d ZdS)_ServerHeartbeatEventz'Base class for server heartbeat events.rrr#r^r&cCs ||_dSraZ$_ServerHeartbeatEvent__connection_id)r*r^r r r!rgsz_ServerHeartbeatEvent.__init__rhcCs|jS)zSThe address (host, port) of the server this heartbeat was sent to. rrir r r!r^sz#_ServerHeartbeatEvent.connection_idrFcCsd|jjd|jdS)Nr r)rxrr^rir r r!rysz_ServerHeartbeatEvent.__repr__N) rrrrrjrgrkr^ryr r r r!rs rc@seZdZdZdZdS)ServerHeartbeatStartedEventzFPublished when a heartbeat is started. .. versionadded:: 3.3 r Nrr r r r!rsrcsxeZdZdZdZddddddd fd d Zedd d dZedd ddZedd ddZ dd ddZ Z S)ServerHeartbeatSucceededEventzIFired when the server heartbeat succeeds. .. versionadded:: 3.3 Z __durationr}Z __awaitedFfloatr rrTr#rrr^awaitedr&cs"t|||_||_||_dSra)rsrg(_ServerHeartbeatSucceededEvent__duration%_ServerHeartbeatSucceededEvent__reply'_ServerHeartbeatSucceededEvent__awaitedr*rrr^rrwr r!rgs z&ServerHeartbeatSucceededEvent.__init__rhcCs|jSz/The duration of this heartbeat in microseconds.)rrir r r!rsz&ServerHeartbeatSucceededEvent.durationcCs|jS)z-An instance of :class:`~pymongo.hello.Hello`.)rrir r r!rsz#ServerHeartbeatSucceededEvent.replycCs|jSzWhether 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. )rrir r r!r$sz%ServerHeartbeatSucceededEvent.awaitedrFcCsd|jj|j|j|j|jS)Nz,<{} {} duration: {}, awaited: {}, reply: {}>rLrxrr^rrrrir r r!ry.sz&ServerHeartbeatSucceededEvent.__repr__)F rrrrrjrgrkrrrryrzr r rwr!r s rcsxeZdZdZdZddddddd fd d Zedd d dZedd ddZedd ddZ dd ddZ Z S)ServerHeartbeatFailedEventzxFired when the server heartbeat fails, either with an "ok: 0" or a socket exception. .. versionadded:: 3.3 rFr ExceptionrrTr#rcs"t|||_||_||_dSra)rsrg%_ServerHeartbeatFailedEvent__duration"_ServerHeartbeatFailedEvent__reply$_ServerHeartbeatFailedEvent__awaitedrrwr r!rgAs z#ServerHeartbeatFailedEvent.__init__rhcCs|jSr)rrir r r!rIsz#ServerHeartbeatFailedEvent.durationcCs|jS)zA subclass of :exc:`Exception`.)rrir r r!rNsz ServerHeartbeatFailedEvent.replycCs|jSr)rrir r r!rSsz"ServerHeartbeatFailedEvent.awaitedrFcCsd|jj|j|j|j|jS)Nz.<{} {} duration: {}, awaited: {}, reply: {!r}>rrir r r!ry]sz#ServerHeartbeatFailedEvent.__repr__)Frr r rwr!r8s rc @sLeZdZdZddddZedddd Zeddd d Zeddd d ZeddddZ eddddZ ddddZ dcddddddddddZ ddd!ddddddddd" d#d$Z ded!dddddddd%d&d'Zddd(d)d*Zdd+d,ddd-d.d/Zdd+d0ddd-d1d2Zdd3dd4d5d6Zdd3dd4d7d8Zd9d9dd3dd:d;d<Zd3dd=d>d?Zd3dd=d@dAZdBdBd3ddCdDdEZddFddGdHdIZdddJdKdLZddddMdNdOZdddJdPdQZddddRdSdTZddddRdUdVZdddddWdXdYZdddJdZd[Zdddd\d]d^Z ddddRd_d`Z!ddddRdadbZ"dS)f_EventListenerszConfigure event listeners for a client instance. Any event listeners registered globally are included by default. :Parameters: - `listeners`: A list of event listeners. z"Optional[Sequence[_EventListener]])rHcCstjdd|_tjdd|_tj}|dd|_tjdd|_tj dd|_ |dk r|D]r}t |t rz|j |t |tr|j |t |tr|j |t |tr|j |t |tr`|j |q`t|j|_t|j|_t|j|_t|j|_t|j |_dSra)rOr"_EventListeners__command_listenersr!_EventListeners__server_listenersr+_EventListeners__server_heartbeat_listenersr#_EventListeners__topology_listenersr_EventListeners__cmap_listenersrJr"rPrAr;r<r/rT%_EventListeners__enabled_for_commands#_EventListeners__enabled_for_server-_EventListeners__enabled_for_server_heartbeat%_EventListeners__enabled_for_topology!_EventListeners__enabled_for_cmap)r*rHlstr r r!rgps.             z_EventListeners.__init__rTrhcCs|jS)z-Are any CommandListener instances registered?)rrir r r!enabled_for_commandssz$_EventListeners.enabled_for_commandscCs|jS)z,Are any ServerListener instances registered?)rrir r r!enabled_for_serversz"_EventListeners.enabled_for_servercCs|jS)z5Are any ServerHeartbeatListener instances registered?)rrir r r!enabled_for_server_heartbeatsz,_EventListeners.enabled_for_server_heartbeatcCs|jS)z.Are any TopologyListener instances registered?)rrir r r!enabled_for_topologysz$_EventListeners.enabled_for_topologycCs|jS)z4Are any ConnectionPoolListener instances registered?)rrir r r!enabled_for_cmapsz _EventListeners.enabled_for_cmapzList[_EventListeners]cCs|j|j|j|j|jS)z#List of registered event listeners.)rrrrrrir r r!event_listenerssz_EventListeners.event_listenersNrrFrBrr[r\r#)rmrnr]r^op_idr`r&c CsZ|dkr |}t||||||d}|jD].}z||Wq&tk rRtYq&Xq&dS)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. - `service_id`: The service_id this command was sent to, or ``None``. Nro)rlrr+rr) r*rmrnr]r^rr`r% subscriberr r r!publish_command_starts z%_EventListeners.publish_command_startFr) rrrUr]r^rr`speculative_hellor&c Csb|dkr |}|ri}t|||||||} |jD].} z| | Wq.tk rZtYq.Xq.dS)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. - `service_id`: The service_id this command was sent to, or ``None``. - `speculative_hello`: Was the command sent with speculative auth? N)r{rr,rr) r*rrrUr]r^rr`r r%rr r r!publish_command_successs$ z'_EventListeners.publish_command_success)rrrUr]r^rr`r&c Cs\|dkr |}t|||||||d}|jD].} z| |Wq(tk rTtYq(Xq(dS)acPublish 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. - `service_id`: The service_id this command was sent to, or ``None``. Nro)rrr-rr) r*rrrUr]r^rr`r%rr r r!publish_command_failures  z'_EventListeners.publish_command_failurerc CsBt|}|jD].}z||Wqtk r:tYqXqdS)zPublish a ServerHeartbeatStartedEvent to all server heartbeat listeners. :Parameters: - `connection_id`: The address (host, port) pair of the connection. N)rrr+rr)r*r^r%rr r r! publish_server_heartbeat_starteds  z0_EventListeners.publish_server_heartbeat_startedrr )r^rrrr&c CsHt||||}|jD].}z||Wqtk r@tYqXqdS)aPublish 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. - `awaited`: True if the response was awaited. N)rrr,rrr*r^rrrr%rr r r!"publish_server_heartbeat_succeeded#s  z2_EventListeners.publish_server_heartbeat_succeededrc CsHt||||}|jD].}z||Wqtk r@tYqXqdS)aPublish 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. - `awaited`: True if the response was awaited. N)rrr-rrr r r r!publish_server_heartbeat_failed7s  z/_EventListeners.publish_server_heartbeat_failedr rc CsDt||}|jD].}z||Wqtk r<tYqXqdS)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=rrr*rrr%rr r r!publish_server_openedKs   z%_EventListeners.publish_server_openedc CsDt||}|jD].}z||Wqtk r<tYqXqdS)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?rrrr r r!publish_server_closedZs   z%_EventListeners.publish_server_closedr)rrrrr&c CsHt||||}|jD].}z||Wqtk r@tYqXqdS)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)r*rrrrr%rr r r!"publish_server_description_changedis z2_EventListeners.publish_server_description_changedrc CsBt|}|jD].}z||Wqtk r:tYqXqdS)zPublish a TopologyOpenedEvent to all topology listeners. :Parameters: - `topology_id`: A unique identifier for the topology this server is a part of. N)rrr=rrr*rr%rr r r!publish_topology_openeds  z'_EventListeners.publish_topology_openedc CsBt|}|jD].}z||Wqtk r:tYqXqdS)zPublish a TopologyClosedEvent to all topology listeners. :Parameters: - `topology_id`: A unique identifier for the topology this server is a part of. N)rrr?rrrr r r!publish_topology_closeds  z'_EventListeners.publish_topology_closedr)rrrr&c CsFt|||}|jD].}z||Wqtk r>tYqXqdS)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)r*rrrr%rr r r!$publish_topology_description_changeds   z4_EventListeners.publish_topology_description_changedrrc CsDt||}|jD].}z||Wqtk r<tYqXqdS)z:Publish a :class:`PoolCreatedEvent` to all pool listeners.N)rrr0rr)r*rrr%rr r r!publish_pool_createds   z$_EventListeners.publish_pool_createdrc CsBt|}|jD].}z||Wqtk r:tYqXqdS)z8Publish a :class:`PoolReadyEvent` to all pool listeners.N)rrr1rrr*rr%rr r r!publish_pool_readys  z"_EventListeners.publish_pool_readyrc CsDt||}|jD].}z||Wqtk r<tYqXqdS)z:Publish a :class:`PoolClearedEvent` to all pool listeners.N)rrr2rr)r*rr`r%rr r r!publish_pool_cleareds   z$_EventListeners.publish_pool_clearedc CsBt|}|jD].}z||Wqtk r:tYqXqdS)z9Publish a :class:`PoolClosedEvent` to all pool listeners.N)rrr3rrrr r r!publish_pool_closeds  z#_EventListeners.publish_pool_closedrc CsDt||}|jD].}z||Wqtk r<tYqXqdS)zWPublish a :class:`ConnectionCreatedEvent` to all connection listeners. N)rrr4rrr*rr^r%rr r r!publish_connection_createds   z*_EventListeners.publish_connection_createdc CsDt||}|jD].}z||Wqtk r<tYqXqdS)zDPublish a :class:`ConnectionReadyEvent` to all connection listeners.N)rrr5rrrr r r!publish_connection_readys   z(_EventListeners.publish_connection_ready)rr^rr&c CsFt|||}|jD].}z||Wqtk r>tYqXqdS)zVPublish a :class:`ConnectionClosedEvent` to all connection listeners. N)rrr6rr)r*rr^rr%rr r r!publish_connection_closeds   z)_EventListeners.publish_connection_closedc CsBt|}|jD].}z||Wqtk r:tYqXqdS)z_Publish a :class:`ConnectionCheckOutStartedEvent` to all connection listeners. N)rrr7rrrr r r!$publish_connection_check_out_starteds  z4_EventListeners.publish_connection_check_out_startedrc CsDt||}|jD].}z||Wqtk r<tYqXqdS)z^Publish a :class:`ConnectionCheckOutFailedEvent` to all connection listeners. N)rrr8rr)r*rrr%rr r r!#publish_connection_check_out_faileds   z3_EventListeners.publish_connection_check_out_failedc CsDt||}|jD].}z||Wqtk r<tYqXqdS)zZPublish a :class:`ConnectionCheckedOutEvent` to all connection listeners. N)rrr9rrrr r r!publish_connection_checked_out s   z._EventListeners.publish_connection_checked_outc CsDt||}|jD].}z||Wqtk r<tYqXqdS)zYPublish a :class:`ConnectionCheckedInEvent` to all connection listeners. N)rrr:rrrr r r!publish_connection_checked_ins   z-_EventListeners.publish_connection_checked_in)NN)NNF)NN)#rrrrrgrkrrrrrrrr r r rrrrrrrrrrrrrrr r!r"r#r$r r r r!rgsV' ."          r)Mr __future__rdatetime collectionsrrtypingrrrrr r r Z bson.objectidr Z pymongo.hellor rZpymongo.helpersrZpymongo.typingsrrrZpymongo.server_descriptionrZpymongo.topology_descriptionrrrOrr"r/r;r<rArErNrQrS__annotations__rXrYrlr{rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr r r r!s, $       "!!  0;;9  $ )  )   ./