U ~fh@svdZddlmZddlZddlmZmZddlmZm Z m Z m Z m Z ddl mZddlmZmZddlmZmZdd lmZmZerdd lmZdd lmZdd lmZed dZegggggZGdddZGdddeZ GdddeZ!GdddeZ"GdddeZ#GdddeZ$dddddZ%d d!d!d"d#d$Z&dd%d&d'd(Z'd d)d*d+d,d-Z(Gd.d/d/Z)Gd0d1d1e)Z*Gd2d3d3e)Z+Gd4d5d5e)Z,Gd6d7d7Z-Gd8d9d9e-Z.Gd:d;d;e-Z/Gdd?d?e-Z1Gd@dAdAZ2GdBdCdCZ3GdDdEdEZ4GdFdGdGe4Z5GdHdIdIe5Z6GdJdKdKe5Z7GdLdMdMe6Z8GdNdOdOe5Z9GdPdQdQe4Z:GdRdSdSe6Z;GdTdUdUe6ZGdZd[d[e>Z?Gd\d]d]e>Z@Gd^d_d_e>ZAGd`dadaZBGdbdcdceBZCGdddedeeBZDGdfdgdgeBZEGdhdidiZFGdjdkdkeFZGGdldmdmeFZHGdndodoeFZIGdpdqdqZJdS)raTools 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. .. seealso:: This module is compatible with both the synchronous and asynchronous PyMongo APIs. Use :func:`register` to register global listeners for specific events. Listeners must inherit from one of the abstract classes below and implement the correct functions for that class. For example, a simple command logger might be implemented like this:: import logging from pymongo import monitoring class CommandLogger(monitoring.CommandListener): def started(self, event): logging.info("Command {0.command_name} with request id " "{0.request_id} started on server " "{0.connection_id}".format(event)) def succeeded(self, event): logging.info("Command {0.command_name} with request id " "{0.request_id} on server {0.connection_id} " "succeeded in {0.duration_micros} " "microseconds".format(event)) def failed(self, event): logging.info("Command {0.command_name} with request id " "{0.request_id} on server {0.connection_id} " "failed in {0.duration_micros} " "microseconds".format(event)) monitoring.register(CommandLogger()) Server discovery and monitoring events are also available. For example:: class ServerLogger(monitoring.ServerListener): def opened(self, event): logging.info("Server {0.server_address} added to topology " "{0.topology_id}".format(event)) def description_changed(self, event): previous_server_type = event.previous_description.server_type new_server_type = event.new_description.server_type if new_server_type != previous_server_type: # server_type_name was added in PyMongo 3.4 logging.info( "Server {0.server_address} changed type from " "{0.previous_description.server_type_name} to " "{0.new_description.server_type_name}".format(event)) def closed(self, event): logging.warning("Server {0.server_address} removed from topology " "{0.topology_id}".format(event)) class HeartbeatLogger(monitoring.ServerHeartbeatListener): def started(self, event): logging.info("Heartbeat sent to server " "{0.connection_id}".format(event)) def succeeded(self, event): # The reply.document attribute was added in PyMongo 3.4. logging.info("Heartbeat to server {0.connection_id} " "succeeded with reply " "{0.reply.document}".format(event)) def failed(self, event): logging.warning("Heartbeat to server {0.connection_id} " "failed with error {0.reply}".format(event)) class TopologyLogger(monitoring.TopologyListener): def opened(self, event): logging.info("Topology with id {0.topology_id} " "opened".format(event)) def description_changed(self, event): logging.info("Topology description updated for " "topology id {0.topology_id}".format(event)) previous_topology_type = event.previous_description.topology_type new_topology_type = event.new_description.topology_type if new_topology_type != previous_topology_type: # topology_type_name was added in PyMongo 3.4 logging.info( "Topology {0.topology_id} changed type from " "{0.previous_description.topology_type_name} to " "{0.new_description.topology_type_name}".format(event)) # The has_writable_server and has_readable_server methods # were added in PyMongo 3.4. if not event.new_description.has_writable_server(): logging.warning("No writable servers available.") if not event.new_description.has_readable_server(): logging.warning("No readable servers available.") def closed(self, event): logging.info("Topology with id {0.topology_id} " "closed".format(event)) Connection monitoring and pooling events are also available. For example:: class ConnectionPoolLogger(ConnectionPoolListener): def pool_created(self, event): logging.info("[pool {0.address}] pool created".format(event)) def pool_ready(self, event): logging.info("[pool {0.address}] pool is ready".format(event)) def pool_cleared(self, event): logging.info("[pool {0.address}] pool cleared".format(event)) def pool_closed(self, event): logging.info("[pool {0.address}] pool closed".format(event)) def connection_created(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection created".format(event)) def connection_ready(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection setup succeeded".format(event)) def connection_closed(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection closed, reason: " "{0.reason}".format(event)) def connection_check_out_started(self, event): logging.info("[pool {0.address}] connection check out " "started".format(event)) def connection_check_out_failed(self, event): logging.info("[pool {0.address}] connection check out " "failed, reason: {0.reason}".format(event)) def connection_checked_out(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection checked out of pool".format(event)) def connection_checked_in(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection checked into pool".format(event)) Event listeners can also be registered per instance of :class:`~pymongo.mongo_client.MongoClient`:: client = MongoClient(event_listeners=[CommandLogger()]) Note that previously registered global listeners are automatically included when configuring per client event listeners. Registering a new global listener will not add that listener to existing client instances. .. note:: Events are delivered **synchronously**. Application threads block waiting for event handlers (e.g. :meth:`~CommandListener.started`) to return. Care must be taken to ensure that your event handlers are efficient enough to not adversely affect overall application performance. .. warning:: The command documents published through this API are *not* copies. If you intend to modify them in any way you must copy them in your event handler first. ) annotationsN)abc namedtuple) TYPE_CHECKINGAnyMappingOptionalSequence)ObjectId)Hello HelloCompat)_SENSITIVE_COMMANDS_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__rr6/tmp/pip-unpacked-wheel-36gvocj8/pymongo/monitoring.pyrsrc@s@eZdZdZdddddZddddd Zd ddd d Zd S)CommandListenerzAbstract base class for command listeners. Handles `CommandStartedEvent`, `CommandSucceededEvent`, and `CommandFailedEvent`. CommandStartedEventNoneeventreturncCstdS)zAbstract method to handle a `CommandStartedEvent`. :param event: An instance of :class:`CommandStartedEvent`. NNotImplementedErrorselfr%rrr startedszCommandListener.startedCommandSucceededEventcCstdS)zAbstract method to handle a `CommandSucceededEvent`. :param event: An instance of :class:`CommandSucceededEvent`. Nr'r)rrr succeededszCommandListener.succeededCommandFailedEventcCstdS)z}Abstract method to handle a `CommandFailedEvent`. :param event: An instance of :class:`CommandFailedEvent`. Nr'r)rrr failedszCommandListener.failedNrrrrr+r-r/rrrr 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 PoolCreatedEventr#r$cCstdS)zAbstract method to handle a :class:`PoolCreatedEvent`. Emitted when a connection Pool is created. :param event: An instance of :class:`PoolCreatedEvent`. Nr'r)rrr pool_createdsz#ConnectionPoolListener.pool_createdPoolReadyEventcCstdS)zAbstract method to handle a :class:`PoolReadyEvent`. Emitted when a connection Pool is marked ready. :param event: An instance of :class:`PoolReadyEvent`. .. versionadded:: 4.0 Nr'r)rrr pool_readys z!ConnectionPoolListener.pool_readyPoolClearedEventcCstdS)zAbstract method to handle a `PoolClearedEvent`. Emitted when a connection Pool is cleared. :param event: An instance of :class:`PoolClearedEvent`. Nr'r)rrr pool_cleared"sz#ConnectionPoolListener.pool_clearedPoolClosedEventcCstdS)zAbstract method to handle a `PoolClosedEvent`. Emitted when a connection Pool is closed. :param event: An instance of :class:`PoolClosedEvent`. Nr'r)rrr pool_closed+sz"ConnectionPoolListener.pool_closedConnectionCreatedEventcCstdS)zAbstract method to handle a :class:`ConnectionCreatedEvent`. Emitted when a connection Pool creates a Connection object. :param event: An instance of :class:`ConnectionCreatedEvent`. Nr'r)rrr connection_created4sz)ConnectionPoolListener.connection_createdConnectionReadyEventcCstdS)zAbstract method to handle a :class:`ConnectionReadyEvent`. Emitted when a connection has finished its setup, and is now ready to use. :param event: An instance of :class:`ConnectionReadyEvent`. Nr'r)rrr connection_ready=sz'ConnectionPoolListener.connection_readyConnectionClosedEventcCstdS)zAbstract method to handle a :class:`ConnectionClosedEvent`. Emitted when a connection Pool closes a connection. :param event: An instance of :class:`ConnectionClosedEvent`. Nr'r)rrr connection_closedGsz(ConnectionPoolListener.connection_closedConnectionCheckOutStartedEventcCstdS)zAbstract method to handle a :class:`ConnectionCheckOutStartedEvent`. Emitted when the driver starts attempting to check out a connection. :param event: An instance of :class:`ConnectionCheckOutStartedEvent`. Nr'r)rrr connection_check_out_startedPsz3ConnectionPoolListener.connection_check_out_startedConnectionCheckOutFailedEventcCstdS)zAbstract method to handle a :class:`ConnectionCheckOutFailedEvent`. Emitted when the driver's attempt to check out a connection fails. :param event: An instance of :class:`ConnectionCheckOutFailedEvent`. Nr'r)rrr connection_check_out_failedYsz2ConnectionPoolListener.connection_check_out_failedConnectionCheckedOutEventcCstdS)zAbstract method to handle a :class:`ConnectionCheckedOutEvent`. Emitted when the driver successfully checks out a connection. :param event: An instance of :class:`ConnectionCheckedOutEvent`. Nr'r)rrr connection_checked_outbsz-ConnectionPoolListener.connection_checked_outConnectionCheckedInEventcCstdS)zAbstract method to handle a :class:`ConnectionCheckedInEvent`. Emitted when the driver checks in a connection back to the connection Pool. :param event: An instance of :class:`ConnectionCheckedInEvent`. Nr'r)rrr connection_checked_inksz,ConnectionPoolListener.connection_checked_inN)rrrrr3r5r7r9r;r=r?rArCrErGrrrr r1s          r1c@s@eZdZdZdddddZddddd Zd ddd d Zd S)ServerHeartbeatListenerzAbstract base class for server heartbeat listeners. Handles `ServerHeartbeatStartedEvent`, `ServerHeartbeatSucceededEvent`, and `ServerHeartbeatFailedEvent`. .. versionadded:: 3.3 ServerHeartbeatStartedEventr#r$cCstdS)zAbstract method to handle a `ServerHeartbeatStartedEvent`. :param event: An instance of :class:`ServerHeartbeatStartedEvent`. Nr'r)rrr r+szServerHeartbeatListener.startedServerHeartbeatSucceededEventcCstdS)zAbstract method to handle a `ServerHeartbeatSucceededEvent`. :param event: An instance of :class:`ServerHeartbeatSucceededEvent`. Nr'r)rrr r-sz!ServerHeartbeatListener.succeededServerHeartbeatFailedEventcCstdS)zAbstract method to handle a `ServerHeartbeatFailedEvent`. :param event: An instance of :class:`ServerHeartbeatFailedEvent`. Nr'r)rrr r/szServerHeartbeatListener.failedNr0rrrr rHvsrHc@s@eZdZdZdddddZddddd Zd ddd d Zd S)TopologyListenerzAbstract base class for topology monitoring listeners. Handles `TopologyOpenedEvent`, `TopologyDescriptionChangedEvent`, and `TopologyClosedEvent`. .. versionadded:: 3.3 TopologyOpenedEventr#r$cCstdS)zAbstract method to handle a `TopologyOpenedEvent`. :param event: An instance of :class:`TopologyOpenedEvent`. Nr'r)rrr openedszTopologyListener.openedTopologyDescriptionChangedEventcCstdS)zAbstract method to handle a `TopologyDescriptionChangedEvent`. :param event: An instance of :class:`TopologyDescriptionChangedEvent`. Nr'r)rrr description_changedsz$TopologyListener.description_changedTopologyClosedEventcCstdS)zAbstract method to handle a `TopologyClosedEvent`. :param event: An instance of :class:`TopologyClosedEvent`. Nr'r)rrr closedszTopologyListener.closedNrrrrrNrPrRrrrr rLsrLc@s@eZdZdZdddddZddddd Zd ddd d Zd S)ServerListenerzAbstract base class for server listeners. Handles `ServerOpeningEvent`, `ServerDescriptionChangedEvent`, and `ServerClosedEvent`. .. versionadded:: 3.3 ServerOpeningEventr#r$cCstdS)z}Abstract method to handle a `ServerOpeningEvent`. :param event: An instance of :class:`ServerOpeningEvent`. Nr'r)rrr rNszServerListener.openedServerDescriptionChangedEventcCstdS)zAbstract method to handle a `ServerDescriptionChangedEvent`. :param event: An instance of :class:`ServerDescriptionChangedEvent`. Nr'r)rrr rPsz"ServerListener.description_changedServerClosedEventcCstdS)z{Abstract method to handle a `ServerClosedEvent`. :param event: An instance of :class:`ServerClosedEvent`. Nr'r)rrr rRszServerListener.closedNrSrrrr rTsrTrint)durr&cCst|dS)z'Convert duration 'dur' to microseconds.g.A)rX total_seconds)rYrrr _to_microssr[strzSequence[_EventListeners])option listenersr&cCsBt|tjst|d|D]}t|tstd|dq|S)zValidate event listenersz must be a list or tupleListeners for x must be either a CommandListener, ServerHeartbeatListener, ServerListener, TopologyListener, or ConnectionPoolListener.) isinstancerr TypeErrorr)r]r^listenerrrr _validate_event_listenerss   rdr#)rcr&cCst|tstd|dt|tr0tj|t|trFtj|t|t r\tj |t|t rrtj |t|t rtj|dS)zRegister a global event listener. :param listener: A subclasses of :class:`CommandListener`, :class:`ServerHeartbeatListener`, :class:`ServerListener`, :class:`TopologyListener`, or :class:`ConnectionPoolListener`. r_r`N)rarrbr! _LISTENERSrappendrHrrTrrLrr1r)rcrrr registers           rgzMapping[str, Any]bool) command_namedocr&cCs"|dtjfkrd|krdSdS)NZhelloZspeculativeAuthenticateTF)lowerr Z LEGACY_CMD)rirjrrr _is_speculative_authenticates rlc @seZdZdZdZdddddd ddd d d d ZeddddZeddddZeddddZ ed dddZ eddddZ eddddZ eddddZ dS) _CommandEventzBase class for command events.)Z __cmd_nameZ __rqst_idZ __conn_idZ__op_id __service_idZ__dbZ__server_conn_idNr\rXr Optional[int]Optional[ObjectId]r#)ri request_id connection_id operation_id service_id database_nameserver_connection_idr&cCs.||_||_||_||_||_||_||_dSN)_CommandEvent__cmd_name_CommandEvent__rqst_id_CommandEvent__conn_id_CommandEvent__op_id_CommandEvent__service_id_CommandEvent__db_CommandEvent__server_conn_id)r*rirrrsrtrurvrwrrr __init__s z_CommandEvent.__init__r&cCs|jS)zThe command name.)ryr*rrr ri+sz_CommandEvent.command_namecCs|jS)z"The request id for this operation.)rzrrrr rr0sz_CommandEvent.request_idcCs|jS)z@The address (host, port) of the server this command was sent to.)r{rrrr rs5sz_CommandEvent.connection_idcCs|jS)z^The service_id this command was sent to, or ``None``. .. versionadded:: 3.12 )r}rrrr ru:sz_CommandEvent.service_idcCs|jS)z(An id for this series of events or None.)r|rrrr rtBsz_CommandEvent.operation_idcCs|jS)z^The database_name this command was sent to, or ``""``. .. versionadded:: 4.6 )r~rrrr rvGsz_CommandEvent.database_namecCs|jS)zThe server-side connection id for the connection this command was sent on, or ``None``. .. versionadded:: 4.7 )rrrrr rwOsz"_CommandEvent.server_connection_id)NroN)rrrr __slots__rpropertyrirrrsrurtrvrwrrrr rm s(rmc speZdZdZdZddddddd dd d fd d ZeddddZeddfdd ZddddZ Z S)r"aEvent published when a command starts. :param command: The command document. :param database_name: The name of the database this command was run against. :param request_id: The request id for this operation. :param connection_id: The address (host, port) of the server this command was sent to. :param operation_id: An optional identifier for a series of related events. :param service_id: The service_id this command was sent to, or ``None``. )Z__cmdNrr\rXrrprqr#)commandrvrrrsrtrurwr&c sd|st|dtt|}tj|||||||d|} | tksRt| |rZi|_n||_dS)Nz is not a valid commandrurvrw) ValueErrornextitersuperrrkr rl_CommandStartedEvent__cmd) r*rrvrrrsrtrurwricmd_name __class__rr rfs   zCommandStartedEvent.__init__rcCs|jS)zThe command document.)rrrrr rszCommandStartedEvent.commandcstjS)z6The name of the database this command was run against.)rrvrrrr rvsz!CommandStartedEvent.database_namec Cs&d|jj|j|j|j|j|j|jS)Nz[<{} {} db: {!r}, command: {!r}, operation_id: {}, service_id: {}, server_connection_id: {}>) formatrrrsrvrirtrurwrrrr __repr__szCommandStartedEvent.__repr__)NN) rrrrrrrrrvr __classcell__rrrr r"Xs  "r"c speZdZdZdZdddddd d d dd d d fdd ZeddddZeddddZddddZ Z S)r,aOEvent published when a command succeeds. :param duration: The command duration as a datetime.timedelta. :param reply: The server reply document. :param command_name: The command name. :param request_id: The request id for this operation. :param connection_id: The address (host, port) of the server this command was sent to. :param operation_id: An optional identifier for a series of related events. :param service_id: The service_id this command was sent to, or ``None``. :param database_name: The database this command was sent to, or ``""``. )__duration_micros__replyNrodatetime.timedeltarr\rXrrprqr#) durationreplyrirrrsrtrurvrwr&c sPtj||||||| dt||_|} | tks>t| |rFi|_n||_dSNr)rrr['_CommandSucceededEvent__duration_microsrkr rl_CommandSucceededEvent__reply) r*rrrirrrsrtrurvrwrrrr rs  zCommandSucceededEvent.__init__rcCs|jSz/The duration of this operation in microseconds.)rrrrr duration_microssz%CommandSucceededEvent.duration_microscCs|jSz/The server failure document for this operation.)rrrrr rszCommandSucceededEvent.replyc Cs*d|jj|j|j|j|j|j|j|j S)Nzp<{} {} db: {!r}, command: {!r}, operation_id: {}, duration_micros: {}, service_id: {}, server_connection_id: {}>) rrrrsrvrirtrrurwrrrr rszCommandSucceededEvent.__repr__)NroN) rrrrrrrrrrrrrrr r,s  &r,c speZdZdZdZdddddd d d dd d d fdd ZeddddZeddddZddddZ Z S)r.aNEvent published when a command fails. :param duration: The command duration as a datetime.timedelta. :param failure: The server reply document. :param command_name: The command name. :param request_id: The request id for this operation. :param connection_id: The address (host, port) of the server this command was sent to. :param operation_id: An optional identifier for a series of related events. :param service_id: The service_id this command was sent to, or ``None``. :param database_name: The database this command was sent to, or ``""``. )rZ __failureNrorrr\rXrrprqr#) rfailurerirrrsrtrurvrwr&c s.tj||||||| dt||_||_dSr)rrr[$_CommandFailedEvent__duration_micros_CommandFailedEvent__failure) r*rrrirrrsrtrurvrwrrr rs  zCommandFailedEvent.__init__rcCs|jSr)rrrrr rsz"CommandFailedEvent.duration_microscCs|jSr)rrrrr r szCommandFailedEvent.failurec Cs.d|jj|j|j|j|j|j|j|j |j S)Nz<{} {} db: {!r}, command: {!r}, operation_id: {}, duration_micros: {}, failure: {!r}, service_id: {}, server_connection_id: {}>) rrrrsrvrirtrrrurwrrrr rszCommandFailedEvent.__repr__)NroN) rrrrrrrrrrrrrrr r.s  &r.c@sDeZdZdZdZdddddZeddd d Zd dd d ZdS) _PoolEventzBase class for pool events.Z __addressrr#addressr&cCs ||_dSrx_PoolEvent__addressr*rrrr r(sz_PoolEvent.__init__rcCs|jS)zbThe address (host, port) pair of the server the pool is attempting to connect to. rrrrr r+sz_PoolEvent.addressr\cCs|jjd|jdSN())rrrrrrr r2sz_PoolEvent.__repr__N rrrrrrrrrrrrr r#s rcsNeZdZdZdZddddfdd Zedd d d Zd d d dZZ S)r2zPublished when a Connection Pool is created. :param 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|||_dSrx)rr_PoolCreatedEvent__options)r*rrrrr rAs zPoolCreatedEvent.__init__rcCs|jS)zCAny non-default pool options that were set on this Connection Pool.)rrrrr rEszPoolCreatedEvent.optionsr\cCs|jjd|jd|jdSNrz, r)rrrrrrrr rJszPoolCreatedEvent.__repr__) rrrrrrrrrrrrrr r26s r2c@seZdZdZdZdS)r4zPublished when a Connection Pool is marked ready. :param address: The address (host, port) pair of the server this Pool is attempting to connect to. .. versionadded:: 4.0 rNrrrrrrrrr r4Nsr4csdeZdZdZdZdddddd fd d Zedd d dZedd ddZdd ddZ Z S)r6awPublished when a Connection Pool is cleared. :param address: The address (host, port) pair of the server this Pool is attempting to connect to. :param service_id: The service_id this command was sent to, or ``None``. :param interrupt_connections: True if all active connections were interrupted by the Pool during clearing. .. versionadded:: 3.9 )rnZ__interrupt_connectionsNFrrqrhr#rruinterrupt_connectionsr&cst|||_||_dSrx)rr_PoolClearedEvent__service_id(_PoolClearedEvent__interrupt_connections)r*rrurrrr rgs zPoolClearedEvent.__init__rcCs|jS)zConnections with this service_id are cleared. When service_id is ``None``, all connections in the pool are cleared. .. versionadded:: 3.12 )rrrrr ruqszPoolClearedEvent.service_idcCs|jS)zdIf True, active connections are interrupted during clearing. .. versionadded:: 4.7 )rrrrr r{sz&PoolClearedEvent.interrupt_connectionsr\cCs&|jjd|jd|jd|jdSr)rrrrrrrrr rszPoolClearedEvent.__repr__)NF) rrrrrrrrurrrrrrr r6Zs   r6c@seZdZdZdZdS)r8zPublished when a Connection Pool is closed. :param address: The address (host, port) pair of the server this Pool is attempting to connect to. .. versionadded:: 3.9 rNrrrrr r8sr8c@s eZdZdZdZdZdZdZdS)ConnectionClosedReasonzqAn enum that defines values for `reason` on a :class:`ConnectionClosedEvent`. .. versionadded:: 3.9 staleZidleerror poolClosedN)rrrrZSTALEZIDLEERROR POOL_CLOSEDrrrr rs rc@seZdZdZdZdZdZdS)ConnectionCheckOutFailedReasonzyAn enum that defines values for `reason` on a :class:`ConnectionCheckOutFailedEvent`. .. versionadded:: 3.9 timeoutrZconnectionErrorN)rrrrTIMEOUTrZ CONN_ERRORrrrr rs rc@sDeZdZdZdZdddddZeddd d Zd dd d ZdS)_ConnectionEventz)Private base class for connection events.rrr#rcCs ||_dSrx_ConnectionEvent__addressrrrr rsz_ConnectionEvent.__init__rcCs|jS)ziThe address (host, port) pair of the server this connection is attempting to connect to. rrrrr rsz_ConnectionEvent.addressr\cCs|jjd|jdSr)rrrrrrr rsz_ConnectionEvent.__repr__Nrrrrr rs rcsNeZdZdZdZddddfdd Zedd d d Zd d d dZZ S)_ConnectionIdEventz4Private base class for connection events with an id.)__connection_idrrXr#rrsr&cst|||_dSrx)rr!_ConnectionIdEvent__connection_id)r*rrsrrr rs z_ConnectionIdEvent.__init__rcCs|jS)zThe ID of the connection.)rrrrr rssz _ConnectionIdEvent.connection_idr\cCs|jjd|jd|jdSr)rrrrrrrr rsz_ConnectionIdEvent.__repr__) rrrrrrrrsrrrrrr rs rcsPeZdZdZdZdddddfdd Zedd d d Zd d ddZZ S)_ConnectionDurationEventz9Private base class for connection events with a duration.) __durationrrXOptional[float]r#rrsrr&cst||||_dSrx)rr"_ConnectionDurationEvent__duration)r*rrsrrrr rsz!_ConnectionDurationEvent.__init__rcCs|jS)zMThe duration of the connection event. .. versionadded:: 4.7 )rrrrr rsz!_ConnectionDurationEvent.durationr\cCs&|jjd|jd|jd|jdSr)rrrrsrrrrr rsz!_ConnectionDurationEvent.__repr__) rrrrrrrrrrrrrr rs rc@seZdZdZdZdS)r:aPublished when a Connection Pool creates a Connection object. NOTE: This connection is not ready for use until the :class:`ConnectionReadyEvent` is published. :param address: The address (host, port) pair of the server this Connection is attempting to connect to. :param connection_id: The integer ID of the Connection in this Pool. .. versionadded:: 3.9 rNrrrrr r:s r:c@seZdZdZdZdS)r<a&Published when a Connection has finished its setup, and is ready to use. :param address: The address (host, port) pair of the server this Connection is attempting to connect to. :param connection_id: The integer ID of the Connection in this Pool. .. versionadded:: 3.9 rNrrrrr r<s r<csNeZdZdZdZddddfdd Zedd d d Zdd d d ZZ S)r>aKPublished when a Connection is closed. :param address: The address (host, port) pair of the server this Connection is attempting to connect to. :param connection_id: The integer ID of the Connection in this Pool. :param reason: A reason explaining why this connection was closed. .. versionadded:: 3.9 Z__reasonrrXr\)rrsreasoncst||||_dSrx)rr_ConnectionClosedEvent__reason)r*rrsrrrr rszConnectionClosedEvent.__init__rcCs|jS)zA reason explaining why this connection was closed. The reason must be one of the strings from the :class:`ConnectionClosedReason` enum. )rrrrr r#szConnectionClosedEvent.reasoncCsd|jj|j|j|jS)Nz{}({!r}, {!r}, {!r}))rrrrrsrrrrr r,s zConnectionClosedEvent.__repr__ rrrrrrrrrrrrrr r>s  r>c@seZdZdZdZdS)r@zPublished when the driver starts attempting to check out a connection. :param address: The address (host, port) pair of the server this Connection is attempting to connect to. .. versionadded:: 3.9 rNrrrrr r@5sr@csPeZdZdZdZdddddfdd Zedd d d Zdd d dZZ S)rBa!Published when the driver's attempt to check out a connection fails. :param address: The address (host, port) pair of the server this Connection is attempting to connect to. :param reason: A reason explaining why connection check out failed. .. versionadded:: 3.9 rrr\rr#rrrr&cstj|d|d||_dS)Nr)rrsr)rr&_ConnectionCheckOutFailedEvent__reason)r*rrrrrr rMsz&ConnectionCheckOutFailedEvent.__init__rcCs|jS)zA reason explaining why connection check out failed. The reason must be one of the strings from the :class:`ConnectionCheckOutFailedReason` enum. )rrrrr rQsz$ConnectionCheckOutFailedEvent.reasoncCs&|jjd|jd|jd|jdSr)rrrrrrrrr rZsz&ConnectionCheckOutFailedEvent.__repr__rrrrr rBAs  rBc@seZdZdZdZdS)rDaPublished when the driver successfully checks out a connection. :param address: The address (host, port) pair of the server this Connection is attempting to connect to. :param connection_id: The integer ID of the Connection in this Pool. .. versionadded:: 3.9 rNrrrrr rD^s rDc@seZdZdZdZdS)rFaPublished when the driver checks in a Connection into the Pool. :param address: The address (host, port) pair of the server this Connection is attempting to connect to. :param connection_id: The integer ID of the Connection in this Pool. .. versionadded:: 3.9 rNrrrrr rFks rFc@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||_||_dSrx)_ServerEvent__server_address_ServerEvent__topology_id)r*rrrrr r}sz_ServerEvent.__init__rcCs|jS)z+The address (host, port) pair of the server)rrrrr rsz_ServerEvent.server_addresscCs|jSz>A unique identifier for the topology this server is a part of.)rrrrr rsz_ServerEvent.topology_idr\cCs d|jjd|jd|jdS)N<  topology_id: >)rrrrrrrr rsz_ServerEvent.__repr__N) rrrrrrrrrrrrrr rxsrcsbeZdZdZdZdddddfdd Zedd d d Zedd d d Zdd ddZ Z S)rVzJPublished when server description changes. .. versionadded:: 3.3 Z__previous_descriptionZ__new_descriptionrrr#previous_descriptionnew_descriptionargsr&cstj|||_||_dSrx)rr4_ServerDescriptionChangedEvent__previous_description/_ServerDescriptionChangedEvent__new_descriptionr*rrrrrr rs z&ServerDescriptionChangedEvent.__init__rcCs|jS)zUThe previous :class:`~pymongo.server_description.ServerDescription`. )rrrrr rsz2ServerDescriptionChangedEvent.previous_descriptioncCs|jS)zPThe new :class:`~pymongo.server_description.ServerDescription`. )rrrrr rsz-ServerDescriptionChangedEvent.new_descriptionr\cCsd|jj|j|j|jS)Nz <{} {} changed from: {}, to: {}>)rrrrrrrrrr rs z&ServerDescriptionChangedEvent.__repr__ rrrrrrrrrrrrrrr rVs rVc@seZdZdZdZdS)rUzEPublished when server is initialized. .. versionadded:: 3.3 rNrrrrr rUsrUc@seZdZdZdZdS)rWz@Published when server is closed. .. versionadded:: 3.3 rNrrrrr rWsrWc@sDeZdZdZdZdddddZeddd d Zd dd d ZdS) TopologyEventz+Base class for topology description events.)rr r#rr&cCs ||_dSrxZ_TopologyEvent__topology_id)r*rrrr rszTopologyEvent.__init__rcCs|jSrrrrrr rszTopologyEvent.topology_idr\cCsd|jjd|jdS)Nrrr)rrrrrrr rszTopologyEvent.__repr__N) rrrrrrrrrrrrr rs rcsbeZdZdZdZdddddfdd Zedd d d Zedd d d Zdd ddZ Z S)rOzPPublished when the topology description changes. .. versionadded:: 3.3 rrrr#rcstj|||_||_dSrx)rr6_TopologyDescriptionChangedEvent__previous_description1_TopologyDescriptionChangedEvent__new_descriptionrrrr rs z(TopologyDescriptionChangedEvent.__init__rcCs|jS)zYThe previous :class:`~pymongo.topology_description.TopologyDescription`. )rrrrr rsz4TopologyDescriptionChangedEvent.previous_descriptioncCs|jS)zTThe new :class:`~pymongo.topology_description.TopologyDescription`. )rrrrr rsz/TopologyDescriptionChangedEvent.new_descriptionr\cCsd|jj|j|j|jS)Nz-<{} topology_id: {} changed from: {}, to: {}>)rrrrrrrrrr rs z(TopologyDescriptionChangedEvent.__repr__rrrrr rOs rOc@seZdZdZdZdS)rMzKPublished when the topology is initialized. .. versionadded:: 3.3 rNrrrrr rMsrMc@seZdZdZdZdS)rQzFPublished when the topology is closed. .. versionadded:: 3.3 rNrrrrr rQ srQc@sZeZdZdZdZddddddd Zedd d d Zedd d dZdd ddZ dS)_ServerHeartbeatEventz'Base class for server heartbeat events.)rZ __awaitedFrrhr#rsawaitedr&cCs||_||_dSrx)$_ServerHeartbeatEvent__connection_id_ServerHeartbeatEvent__awaited)r*rsrrrr rsz_ServerHeartbeatEvent.__init__rcCs|jS)zSThe address (host, port) of the server this heartbeat was sent to. )rrrrr rssz#_ServerHeartbeatEvent.connection_idcCs|jS)zgWhether the heartbeat was issued as an awaitable hello command. .. versionadded:: 4.6 )rrrrr r&sz_ServerHeartbeatEvent.awaitedr\cCs d|jjd|jd|jdS)Nrrz awaited: r)rrrsrrrrr r.sz_ServerHeartbeatEvent.__repr__N)F) rrrrrrrrsrrrrrr rsrc@seZdZdZdZdS)rIzFPublished when a heartbeat is started. .. versionadded:: 3.3 rNrrrrr rI2srIcs|eZdZdZdZddddddd fd d Zedd d dZedd ddZedd fdd Z dd ddZ Z S)rJzIFired when the server heartbeat succeeds. .. versionadded:: 3.3 rrFfloatr rrhr#rrrsrr&cst||||_||_dSrx)rr(_ServerHeartbeatSucceededEvent__duration%_ServerHeartbeatSucceededEvent__replyr*rrrsrrrr rCsz&ServerHeartbeatSucceededEvent.__init__rcCs|jSz/The duration of this heartbeat in microseconds.)rrrrr rJsz&ServerHeartbeatSucceededEvent.durationcCs|jS)z-An instance of :class:`~pymongo.hello.Hello`.)rrrrr rOsz#ServerHeartbeatSucceededEvent.replycstjSzWhether the heartbeat was awaited. If true, then :meth:`duration` reflects the sum of the round trip time to the server and the time that the server waited before sending a response. .. versionadded:: 3.11 rrrrrr rTs z%ServerHeartbeatSucceededEvent.awaitedr\cCsd|jj|j|j|j|jS)Nz,<{} {} duration: {}, awaited: {}, reply: {}>rrrrsrrrrrrr r`sz&ServerHeartbeatSucceededEvent.__repr__)F rrrrrrrrrrrrrrrr rJ;s rJcs|eZdZdZdZddddddd fd d Zedd d dZedd ddZedd fdd Z dd ddZ Z S)rKzxFired when the server heartbeat fails, either with an "ok: 0" or a socket exception. .. versionadded:: 3.3 rFr Exceptionrrhr#rcst||||_||_dSrx)rr%_ServerHeartbeatFailedEvent__duration"_ServerHeartbeatFailedEvent__replyrrrr rssz#ServerHeartbeatFailedEvent.__init__rcCs|jSr)rrrrr rzsz#ServerHeartbeatFailedEvent.durationcCs|jS)zA subclass of :exc:`Exception`.)rrrrr rsz ServerHeartbeatFailedEvent.replycstjSrrrrrr rs z"ServerHeartbeatFailedEvent.awaitedr\cCsd|jj|j|j|j|jS)Nz.<{} {} duration: {}, awaited: {}, reply: {!r}>rrrrr rsz#ServerHeartbeatFailedEvent.__repr__)Frrrrr rKjs rKc @sbeZdZdZddddZedddd Zeddd d Zeddd d ZeddddZ eddddZ ddddZ dedddddddddddZ dfd"ddddddddddd# d$d%Z dgd"dddddddddd& d'd(Zdddd)d*d+Zdd,d-ddd.d/d0Zdd,d1ddd.d2d3Zdd4dd5d6d7Zdd4dd5d8d9Zd:d:dd4dd;dd?d@Zd4dd>dAdBZdCdCd4ddDdEdFZddGddHdIdJZdddKdLdMZdhdddddNdOdPZdddKdQdRZddddSdTdUZddd,ddVdWdXZdddddYdZd[ZdddKd\d]Zddd,dd^d_d`Z ddd,ddVdadbZ!ddddSdcddZ"dS)i_EventListenerszConfigure event listeners for a client instance. Any event listeners registered globally are included by default. :param listeners: A list of event listeners. z"Optional[Sequence[_EventListener]])r^cCstjdd|_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 |_dSrx)rer"_EventListeners__command_listenersr!_EventListeners__server_listenersr+_EventListeners__server_heartbeat_listenersr#_EventListeners__topology_listenersr_EventListeners__cmap_listenersrar!rfrTrHrLr1rh%_EventListeners__enabled_for_commands#_EventListeners__enabled_for_server-_EventListeners__enabled_for_server_heartbeat%_EventListeners__enabled_for_topology!_EventListeners__enabled_for_cmap)r*r^lstrrr rs.             z_EventListeners.__init__rhrcCs|jS)z-Are any CommandListener instances registered?)rrrrr enabled_for_commandssz$_EventListeners.enabled_for_commandscCs|jS)z,Are any ServerListener instances registered?)rrrrr enabled_for_serversz"_EventListeners.enabled_for_servercCs|jS)z5Are any ServerHeartbeatListener instances registered?)rrrrr enabled_for_server_heartbeatsz,_EventListeners.enabled_for_server_heartbeatcCs|jS)z.Are any TopologyListener instances registered?)rrrrr enabled_for_topologysz$_EventListeners.enabled_for_topologycCs|jS)z4Are any ConnectionPoolListener instances registered?)rrrrr enabled_for_cmapsz _EventListeners.enabled_for_cmapzlist[_EventListeners]cCs|j|j|j|j|jS)z#List of registered event listeners.)rrrrrrrrr event_listenerssz_EventListeners.event_listenersNrr\rXrrprqr#)rrvrrrsrwop_idrur&c Cs\|dkr |}t|||||||d}|jD].} z| |Wq(tk rTtYq(Xq(dS)aPublish a CommandStartedEvent to all command listeners. :param command: The command document. :param database_name: The name of the database this command was run against. :param request_id: The request id for this operation. :param connection_id: The address (host, port) of the server this command was sent to. :param op_id: The (optional) operation id for this operation. :param service_id: The service_id this command was sent to, or ``None``. N)rurw)r"rr+rr) r*rrvrrrsrwrrur% subscriberrrr publish_command_starts  z%_EventListeners.publish_command_startFror) rrrirrrsrwrruspeculative_hellorvr&c Csh|dkr |}| ri}t|||||||| |d } |jD].} z| | Wq4tk r`tYq4Xq4dS)aPublish a CommandSucceededEvent to all command listeners. :param duration: The command duration as a datetime.timedelta. :param reply: The server reply document. :param command_name: The command name. :param request_id: The request id for this operation. :param connection_id: The address (host, port) of the server this command was sent to. :param op_id: The (optional) operation id for this operation. :param service_id: The service_id this command was sent to, or ``None``. :param speculative_hello: Was the command sent with speculative auth? :param database_name: The database this command was sent to, or ``""``. N)rvrw)r,rr-rr) r*rrrirrrsrwrrurrvr%rrrr publish_command_successs( z'_EventListeners.publish_command_success) rrrirrrsrwrrurvr&c Cs`|dkr |}t|||||||| |d } |jD].} z| | Wq,tk rXtYq,Xq,dS)aPublish a CommandFailedEvent to all command listeners. :param duration: The command duration as a datetime.timedelta. :param failure: The server reply document or failure description document. :param command_name: The command name. :param request_id: The request id for this operation. :param connection_id: The address (host, port) of the server this command was sent to. :param op_id: The (optional) operation id for this operation. :param service_id: The service_id this command was sent to, or ``None``. :param database_name: The database this command was sent to, or ``""``. Nr)r.rr/rr) r*rrrirrrsrwrrurvr%rrrr publish_command_failure5s$ z'_EventListeners.publish_command_failurerc CsDt||}|jD].}z||Wqtk r<tYqXqdS)zPublish a ServerHeartbeatStartedEvent to all server heartbeat listeners. :param connection_id: The address (host, port) pair of the connection. :param awaited: True if this heartbeat is part of an awaitable hello command. N)rIrr+rr)r*rsrr%rrrr publish_server_heartbeat_startedas   z0_EventListeners.publish_server_heartbeat_startedrr )rsrrrr&c CsHt||||}|jD].}z||Wqtk r@tYqXqdS)aPublish a ServerHeartbeatSucceededEvent to all server heartbeat listeners. :param connection_id: The address (host, port) pair of the connection. :param duration: The execution time of the event in the highest possible resolution for the platform. :param reply: The command reply. :param awaited: True if the response was awaited. N)rJrr-rrr*rsrrrr%rrrr "publish_server_heartbeat_succeededos  z2_EventListeners.publish_server_heartbeat_succeededrc CsHt||||}|jD].}z||Wqtk r@tYqXqdS)aPublish a ServerHeartbeatFailedEvent to all server heartbeat listeners. :param connection_id: The address (host, port) pair of the connection. :param duration: The execution time of the event in the highest possible resolution for the platform. :param reply: The command reply. :param awaited: True if the response was awaited. N)rKrr/rrrrrr publish_server_heartbeat_faileds  z/_EventListeners.publish_server_heartbeat_failedr rc CsDt||}|jD].}z||Wqtk r<tYqXqdS)zPublish a ServerOpeningEvent to all server listeners. :param server_address: The address (host, port) pair of the server. :param topology_id: A unique identifier for the topology this server is a part of. N)rUrrNrrr*rrr%rrrr publish_server_openeds   z%_EventListeners.publish_server_openedc CsDt||}|jD].}z||Wqtk r<tYqXqdS)zPublish a ServerClosedEvent to all server listeners. :param server_address: The address (host, port) pair of the server. :param topology_id: A unique identifier for the topology this server is a part of. N)rWrrRrrrrrr publish_server_closeds   z%_EventListeners.publish_server_closedr)rrrrr&c CsHt||||}|jD].}z||Wqtk r@tYqXqdS)a~Publish a ServerDescriptionChangedEvent to all server listeners. :param previous_description: The previous server description. :param server_address: The address (host, port) pair of the server. :param new_description: The new server description. :param topology_id: A unique identifier for the topology this server is a part of. N)rVrrPrr)r*rrrrr%rrrr "publish_server_description_changeds z2_EventListeners.publish_server_description_changedrc CsBt|}|jD].}z||Wqtk r:tYqXqdS)zPublish a TopologyOpenedEvent to all topology listeners. :param topology_id: A unique identifier for the topology this server is a part of. N)rMrrNrrr*rr%rrrr publish_topology_openeds  z'_EventListeners.publish_topology_openedc CsBt|}|jD].}z||Wqtk r:tYqXqdS)zPublish a TopologyClosedEvent to all topology listeners. :param topology_id: A unique identifier for the topology this server is a part of. N)rQrrRrrrrrr publish_topology_closeds  z'_EventListeners.publish_topology_closedr)rrrr&c CsFt|||}|jD].}z||Wqtk r>tYqXqdS)a:Publish a TopologyDescriptionChangedEvent to all topology listeners. :param previous_description: The previous topology description. :param new_description: The new topology description. :param topology_id: A unique identifier for the topology this server is a part of. N)rOrrPrr)r*rrrr%rrrr $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)r2rr3rr)r*rrr%rrrr publish_pool_createds   z$_EventListeners.publish_pool_createdrc CsBt|}|jD].}z||Wqtk r:tYqXqdS)z8Publish a :class:`PoolReadyEvent` to all pool listeners.N)r4rr5rrr*rr%rrrr publish_pool_readys  z"_EventListeners.publish_pool_readyrc CsFt|||}|jD].}z||Wqtk r>tYqXqdS)z:Publish a :class:`PoolClearedEvent` to all pool listeners.N)r6rr7rr)r*rrurr%rrrr publish_pool_cleared s   z$_EventListeners.publish_pool_clearedc CsBt|}|jD].}z||Wqtk r:tYqXqdS)z9Publish a :class:`PoolClosedEvent` to all pool listeners.N)r8rr9rrr"rrr publish_pool_closeds  z#_EventListeners.publish_pool_closedrc CsDt||}|jD].}z||Wqtk r<tYqXqdS)zWPublish a :class:`ConnectionCreatedEvent` to all connection listeners. N)r:rr;rrr*rrsr%rrrr publish_connection_created s   z*_EventListeners.publish_connection_createdrc CsFt|||}|jD].}z||Wqtk r>tYqXqdS)zDPublish a :class:`ConnectionReadyEvent` to all connection listeners.N)r<rr=rrr*rrsrr%rrrr publish_connection_ready+s   z(_EventListeners.publish_connection_ready)rrsrr&c CsFt|||}|jD].}z||Wqtk r>tYqXqdS)zVPublish a :class:`ConnectionClosedEvent` to all connection listeners. N)r>rr?rr)r*rrsrr%rrrr publish_connection_closed6s   z)_EventListeners.publish_connection_closedc CsBt|}|jD].}z||Wqtk r:tYqXqdS)z_Publish a :class:`ConnectionCheckOutStartedEvent` to all connection listeners. N)r@rrArrr"rrr $publish_connection_check_out_startedAs  z4_EventListeners.publish_connection_check_out_startedrc CsFt|||}|jD].}z||Wqtk r>tYqXqdS)z^Publish a :class:`ConnectionCheckOutFailedEvent` to all connection listeners. N)rBrrCrr)r*rrrr%rrrr #publish_connection_check_out_failedLs   z3_EventListeners.publish_connection_check_out_failedc CsFt|||}|jD].}z||Wqtk r>tYqXqdS)zZPublish a :class:`ConnectionCheckedOutEvent` to all connection listeners. N)rDrrErrr(rrr publish_connection_checked_outYs   z._EventListeners.publish_connection_checked_outc CsDt||}|jD].}z||Wqtk r<tYqXqdS)zYPublish a :class:`ConnectionCheckedInEvent` to all connection listeners. N)rFrrGrrr&rrr publish_connection_checked_infs   z-_EventListeners.publish_connection_checked_in)NN)NNFro)NNro)F)#rrrrrrr r r r r rrrrrrrrrrrrr r!r#r$r%r'r)r*r+r,r-r.rrrr rs\.$9",           r)Kr __future__rdatetime collectionsrrtypingrrrrr Z bson.objectidr Z pymongo.hellor r Zpymongo.helpers_sharedr rZpymongo.typingsrrrZpymongo.server_descriptionrZpymongo.topology_descriptionrrrerr!r1rHrLrTr[rdrgrlrmr"r,r.rr2r4r6r8rrrrrr:r<r>r@rBrDrFrrVrUrWrrOrMrQrrIrJrKrrrrr s|/      x LCEC -  #   )  )   /0