o h{@sZdZddlmZddlZddlmZmZddlmZm Z m Z m Z m Z ddl mZddlmZmZddlmZmZdd lmZmZerTdd lmZdd lmZdd lmZed dZegggggZGdddZGdddeZ GdddeZ!GdddeZ"GdddeZ#GdddeZ$dudd Z%dvd%d&Z&dwd)d*Z'dxd/d0Z(Gd1d2d2Z)Gd3d4d4e)Z*Gd5d6d6e)Z+Gd7d8d8e)Z,Gd9d:d:Z-Gd;d<dd>e-Z/Gd?d@d@e-Z0GdAdBdBe-Z1GdCdDdDZ2GdEdFdFZ3GdGdHdHZ4GdIdJdJe4Z5GdKdLdLe5Z6GdMdNdNe5Z7GdOdPdPe6Z8GdQdRdRe5Z9GdSdTdTe4Z:GdUdVdVe6Z;GdWdXdXe6ZGd]d^d^e>Z?Gd_d`d`e>Z@Gdadbdbe>ZAGdcddddZBGdedfdfeBZCGdgdhdheBZDGdidjdjeBZEGdkdldlZFGdmdndneFZGGdodpdpeFZHGdqdrdreFZIGdsdtdtZJdS)yaTools 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__rrE/var/www/html/venv/lib/python3.10/site-packages/pymongo/monitoring.pyrsrc@.eZdZdZdddZdd d Zdd d ZdS)CommandListenerzAbstract base class for command listeners. Handles `CommandStartedEvent`, `CommandSucceededEvent`, and `CommandFailedEvent`. eventCommandStartedEventreturnNonecCt)zAbstract method to handle a `CommandStartedEvent`. :param event: An instance of :class:`CommandStartedEvent`. NotImplementedErrorselfr#rrr startedzCommandListener.startedCommandSucceededEventcCr')zAbstract method to handle a `CommandSucceededEvent`. :param event: An instance of :class:`CommandSucceededEvent`. r(r*rrr succeededr-zCommandListener.succeededCommandFailedEventcCr')z}Abstract method to handle a `CommandFailedEvent`. :param event: An instance of :class:`CommandFailedEvent`. r(r*rrr failedr-zCommandListener.failedN)r#r$r%r&)r#r.r%r&)r#r0r%r&rrrrr,r/r1rrrr r"s   r"c@s~eZdZdZd'ddZd(d d Zd)d d Zd*ddZd+ddZd,ddZ d-ddZ d.ddZ d/ddZ d0d!d"Z d1d$d%Zd&S)2ConnectionPoolListenera-Abstract base class for connection pool listeners. Handles all of the connection pool events defined in the Connection Monitoring and Pooling Specification: :class:`PoolCreatedEvent`, :class:`PoolClearedEvent`, :class:`PoolClosedEvent`, :class:`ConnectionCreatedEvent`, :class:`ConnectionReadyEvent`, :class:`ConnectionClosedEvent`, :class:`ConnectionCheckOutStartedEvent`, :class:`ConnectionCheckOutFailedEvent`, :class:`ConnectionCheckedOutEvent`, and :class:`ConnectionCheckedInEvent`. .. versionadded:: 3.9 r#PoolCreatedEventr%r&cCr')zAbstract method to handle a :class:`PoolCreatedEvent`. Emitted when a connection Pool is created. :param event: An instance of :class:`PoolCreatedEvent`. r(r*rrr pool_createdz#ConnectionPoolListener.pool_createdPoolReadyEventcCr')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 r(r*rrr pool_readys z!ConnectionPoolListener.pool_readyPoolClearedEventcCr')zAbstract method to handle a `PoolClearedEvent`. Emitted when a connection Pool is cleared. :param event: An instance of :class:`PoolClearedEvent`. r(r*rrr pool_cleared"r6z#ConnectionPoolListener.pool_clearedPoolClosedEventcCr')zAbstract method to handle a `PoolClosedEvent`. Emitted when a connection Pool is closed. :param event: An instance of :class:`PoolClosedEvent`. r(r*rrr pool_closed+r6z"ConnectionPoolListener.pool_closedConnectionCreatedEventcCr')zAbstract method to handle a :class:`ConnectionCreatedEvent`. Emitted when a connection Pool creates a Connection object. :param event: An instance of :class:`ConnectionCreatedEvent`. r(r*rrr connection_created4r6z)ConnectionPoolListener.connection_createdConnectionReadyEventcCr')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`. r(r*rrr connection_ready=z'ConnectionPoolListener.connection_readyConnectionClosedEventcCr')zAbstract method to handle a :class:`ConnectionClosedEvent`. Emitted when a connection Pool closes a connection. :param event: An instance of :class:`ConnectionClosedEvent`. r(r*rrr connection_closedGr6z(ConnectionPoolListener.connection_closedConnectionCheckOutStartedEventcCr')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`. r(r*rrr connection_check_out_startedPr6z3ConnectionPoolListener.connection_check_out_startedConnectionCheckOutFailedEventcCr')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`. r(r*rrr connection_check_out_failedYr6z2ConnectionPoolListener.connection_check_out_failedConnectionCheckedOutEventcCr')zAbstract method to handle a :class:`ConnectionCheckedOutEvent`. Emitted when the driver successfully checks out a connection. :param event: An instance of :class:`ConnectionCheckedOutEvent`. r(r*rrr connection_checked_outbr6z-ConnectionPoolListener.connection_checked_outConnectionCheckedInEventcCr')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`. r(r*rrr connection_checked_inkrAz,ConnectionPoolListener.connection_checked_inN)r#r4r%r&)r#r7r%r&)r#r9r%r&)r#r;r%r&)r#r=r%r&)r#r?r%r&)r#rBr%r&)r#rDr%r&)r#rFr%r&)r#rHr%r&)r#rJr%r&)rrrrr5r8r:r<r>r@rCrErGrIrKrrrr r3s   r3c@r!)ServerHeartbeatListenerzAbstract base class for server heartbeat listeners. Handles `ServerHeartbeatStartedEvent`, `ServerHeartbeatSucceededEvent`, and `ServerHeartbeatFailedEvent`. .. versionadded:: 3.3 r#ServerHeartbeatStartedEventr%r&cCr')zAbstract method to handle a `ServerHeartbeatStartedEvent`. :param event: An instance of :class:`ServerHeartbeatStartedEvent`. r(r*rrr r,r-zServerHeartbeatListener.startedServerHeartbeatSucceededEventcCr')zAbstract method to handle a `ServerHeartbeatSucceededEvent`. :param event: An instance of :class:`ServerHeartbeatSucceededEvent`. r(r*rrr r/r-z!ServerHeartbeatListener.succeededServerHeartbeatFailedEventcCr')zAbstract method to handle a `ServerHeartbeatFailedEvent`. :param event: An instance of :class:`ServerHeartbeatFailedEvent`. r(r*rrr r1r-zServerHeartbeatListener.failedN)r#rMr%r&)r#rNr%r&)r#rOr%r&r2rrrr rLvs   rLc@r!)TopologyListenerzAbstract base class for topology monitoring listeners. Handles `TopologyOpenedEvent`, `TopologyDescriptionChangedEvent`, and `TopologyClosedEvent`. .. versionadded:: 3.3 r#TopologyOpenedEventr%r&cCr')zAbstract method to handle a `TopologyOpenedEvent`. :param event: An instance of :class:`TopologyOpenedEvent`. r(r*rrr openedr-zTopologyListener.openedTopologyDescriptionChangedEventcCr')zAbstract method to handle a `TopologyDescriptionChangedEvent`. :param event: An instance of :class:`TopologyDescriptionChangedEvent`. r(r*rrr description_changedr-z$TopologyListener.description_changedTopologyClosedEventcCr')zAbstract method to handle a `TopologyClosedEvent`. :param event: An instance of :class:`TopologyClosedEvent`. r(r*rrr closedr-zTopologyListener.closedN)r#rQr%r&)r#rSr%r&)r#rUr%r&rrrrrRrTrVrrrr rP   rPc@r!)ServerListenerzAbstract base class for server listeners. Handles `ServerOpeningEvent`, `ServerDescriptionChangedEvent`, and `ServerClosedEvent`. .. versionadded:: 3.3 r#ServerOpeningEventr%r&cCr')z}Abstract method to handle a `ServerOpeningEvent`. :param event: An instance of :class:`ServerOpeningEvent`. r(r*rrr rRr-zServerListener.openedServerDescriptionChangedEventcCr')zAbstract method to handle a `ServerDescriptionChangedEvent`. :param event: An instance of :class:`ServerDescriptionChangedEvent`. r(r*rrr rTr-z"ServerListener.description_changedServerClosedEventcCr')z{Abstract method to handle a `ServerClosedEvent`. :param event: An instance of :class:`ServerClosedEvent`. r(r*rrr rVr-zServerListener.closedN)r#rZr%r&)r#r[r%r&)r#r\r%r&rWrrrr rYrXrYdurrr%intcCst|dS)z'Convert duration 'dur' to microseconds.g.A)r^ total_seconds)r]rrr _to_microssr`optionstr listenersSequence[_EventListeners]cCsRt|tjst|dt||D]}t|ts&td|dt|q|S)zValidate event listenersz must be a list or tuple, not Listeners for | must be either a CommandListener, ServerHeartbeatListener, ServerListener, TopologyListener, or ConnectionPoolListener,not ) isinstancerr TypeErrortyper)rarclistenerrrr _validate_event_listenerss  rkrjr&cCst|tstd|dt|t|trtj|t|tr'tj |t|t r2tj |t|t r=tj |t|trJtj|dSdS)zRegister a global event listener. :param listener: A subclasses of :class:`CommandListener`, :class:`ServerHeartbeatListener`, :class:`ServerListener`, :class:`TopologyListener`, or :class:`ConnectionPoolListener`. rerfN)rgrrhrir" _LISTENERSrappendrLrrYrrPrr3r)rjrrr registers"          rn command_namedocMapping[str, Any]boolcCs"|dtjfvrd|vrdSdS)NZhelloZspeculativeAuthenticateTF)lowerr Z LEGACY_CMD)rorprrr _is_speculative_authenticatesrtc@seZdZdZdZ   d#d$ddZed%ddZed&ddZed'ddZ ed(ddZ ed)ddZ ed%dd Z ed)d!d"Z dS)* _CommandEventzBase class for command events.)Z __cmd_nameZ __rqst_idZ __conn_idZ__op_id __service_idZ__dbZ__server_conn_idNrorb request_idr^ connection_idr operation_id Optional[int] service_idOptional[ObjectId] database_nameserver_connection_idr%r&cCs.||_||_||_||_||_||_||_dSN)_CommandEvent__cmd_name_CommandEvent__rqst_id_CommandEvent__conn_id_CommandEvent__op_id_CommandEvent__service_id_CommandEvent__db_CommandEvent__server_conn_id)r+rorxryrzr|r~rrrr __init__s  z_CommandEvent.__init__cC|jS)zThe command name.)rr+rrr ro-z_CommandEvent.command_namecCr)z"The request id for this operation.)rrrrr rx2rz_CommandEvent.request_idcCr)z@The address (host, port) of the server this command was sent to.)rrrrr ry7rz_CommandEvent.connection_idcCr)z^The service_id this command was sent to, or ``None``. .. versionadded:: 3.12 )rrrrr r|<z_CommandEvent.service_idcCr)z(An id for this series of events or None.)rrrrr rzDrz_CommandEvent.operation_idcCr)z^The database_name this command was sent to, or ``""``. .. versionadded:: 4.6 )rrrrr r~Irz_CommandEvent.database_namecCr)zThe server-side connection id for the connection this command was sent on, or ``None``. .. versionadded:: 4.7 )rrrrr rQrz"_CommandEvent.server_connection_idNrwN)rorbrxr^ryrrzr{r|r}r~rbrr{r%r&r%rbr%r^r%rr%r})r%r{)rrrr __slots__rpropertyrorxryr|rzr~rrrrr rus*       rucsVeZdZdZdZ  ddfdd ZedddZedfdd ZdddZ 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__cmdNcommandrr~rbrxr^ryrrzr{r|r}rr%r&c sf|s t|dtt|}tj|||||||d|} | tvs)t| |r.i|_dS||_dS)Nz is not a valid commandr|r~r) ValueErrornextitersuperrrsr rt_CommandStartedEvent__cmd) r+rr~rxryrzr|rrocmd_name __class__rr rhs      zCommandStartedEvent.__init__cCr)zThe command document.)rrrrr rrzCommandStartedEvent.commandctjS)z6The name of the database this command was run against.)rr~rrrr r~sz!CommandStartedEvent.database_namec Cs&d|jj|j|j|j|j|j|jS)Nz[<{} {} db: {!r}, command: {!r}, operation_id: {}, service_id: {}, server_connection_id: {}>) formatrrryr~rorzr|rrrrr __repr__szCommandStartedEvent.__repr__NN)rrr~rbrxr^ryrrzr{r|r}rr{r%r&r%rr) rrrrrrrrr~r __classcell__rrrr r$Zs   r$cTeZdZdZdZ   dd fdd Zed!ddZed"ddZd#ddZ 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__replyNrwdurationdatetime.timedeltareplyrrorbrxr^ryrrzr{r|r}r~rr%r&c sRtj||||||| dt||_|} | tvst| |r$i|_dS||_dSNr)rrr`'_CommandSucceededEvent__duration_microsrsr rt_CommandSucceededEvent__reply) r+rrrorxryrzr|r~rrrrr rs    zCommandSucceededEvent.__init__cCrz/The duration of this operation in microseconds.)rrrrr duration_microsrz%CommandSucceededEvent.duration_microscCrz/The server failure document for this operation.)rrrrr rrzCommandSucceededEvent.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: {}>) rrrryr~rorzrr|rrrrr rszCommandSucceededEvent.__repr__r)rrrrrorbrxr^ryrrzr{r|r}r~rbrr{r%r&rrr) rrrrrrrrrrrrrrr r.s    r.cr)$r0aNEvent 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 __failureNrwrrfailurerrorbrxr^ryrrzr{r|r}r~rr%r&c s.tj||||||| dt||_||_dSr)rrr`$_CommandFailedEvent__duration_micros_CommandFailedEvent__failure) r+rrrorxryrzr|r~rrrr rs  zCommandFailedEvent.__init__cCrr)rrrrr r rz"CommandFailedEvent.duration_microscCrr)rrrrr rrzCommandFailedEvent.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: {}>) rrrryr~rorzrrr|rrrrr rszCommandFailedEvent.__repr__r)rrrrrorbrxr^ryrrzr{r|r}r~rbrr{r%r&rrr) rrrrrrrrrrrrrrr r0s    r0c@6eZdZdZdZdddZedd d Zdd d ZdS) _PoolEventzBase class for pool events.Z __addressaddressrr%r&cC ||_dSr_PoolEvent__addressr+rrrr r* z_PoolEvent.__init__cCr)zbThe address (host, port) pair of the server the pool is attempting to connect to. rrrrr r-z_PoolEvent.addressrbcC|jjd|jdSN())rrrrrrr r4z_PoolEvent.__repr__Nrrr%r&rr rrrrrrrrrrrrr r%  rc>eZdZdZdZdfd d Zedd d ZdddZZ S)r4zPublished 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 __optionsrroptionsdict[str, Any]r%r&ct|||_dSr)rr_PoolCreatedEvent__options)r+rrrrr rC  zPoolCreatedEvent.__init__cCr)zCAny non-default pool options that were set on this Connection Pool.)rrrrr rGrzPoolCreatedEvent.optionsrbcC|jjd|jd|jdSNrz, r)rrrrrrrr rLzPoolCreatedEvent.__repr__rrrrr%r&)r%rr) rrrrrrrrrrrrrr r48s r4c@eZdZdZdZdS)r7zPublished 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 r7Pr7csReZdZdZdZ  ddfd d ZedddZedddZdddZ Z S)r9awPublished 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 )rvZ__interrupt_connectionsNFrrr|r}interrupt_connectionsrrr%r&cst|||_||_dSr)rr_PoolClearedEvent__service_id(_PoolClearedEvent__interrupt_connections)r+rr|rrrr ri  zPoolClearedEvent.__init__cCr)zConnections with this service_id are cleared. When service_id is ``None``, all connections in the pool are cleared. .. versionadded:: 3.12 )rrrrr r|sszPoolClearedEvent.service_idcCr)zdIf True, active connections are interrupted during clearing. .. versionadded:: 4.7 )rrrrr r}rz&PoolClearedEvent.interrupt_connectionsrbcC&|jjd|jd|jd|jdSr)rrrrrrrrr r&zPoolClearedEvent.__repr__)NFrrr|r}rrrr%r&rr%rrr) rrrrrrrr|rrrrrrr r9\s   r9c@r)r;zPublished 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 r;rr;c@s&eZdZdZdZ dZ dZ dZdS)ConnectionClosedReasonzqAn enum that defines values for `reason` on a :class:`ConnectionClosedEvent`. .. versionadded:: 3.9 staleZidleerror poolClosedN)rrrrZSTALEZIDLEERROR POOL_CLOSEDrrrr rsrc@s eZdZdZdZ dZ dZdS)ConnectionCheckOutFailedReasonzyAn enum that defines values for `reason` on a :class:`ConnectionCheckOutFailedEvent`. .. versionadded:: 3.9 timeoutrZconnectionErrorN)rrrrTIMEOUTrZ CONN_ERRORrrrr rsrc@r)_ConnectionEventz)Private base class for connection events.rrrr%r&cCrr_ConnectionEvent__addressrrrr rrz_ConnectionEvent.__init__cCr)ziThe address (host, port) pair of the server this connection is attempting to connect to. rrrrr rrz_ConnectionEvent.addressrbcCrr)rrrrrrr rrz_ConnectionEvent.__repr__Nrrrrrrrr rrrcr)_ConnectionIdEventz4Private base class for connection events with an id.)__connection_idrrryr^r%r&crr)rr!_ConnectionIdEvent__connection_id)r+rryrrr rrz_ConnectionIdEvent.__init__cCr)zThe ID of the connection.)rrrrr ryrz _ConnectionIdEvent.connection_idrbcCrr)rrrrrrrr rrz_ConnectionIdEvent.__repr__rrryr^r%r&rr) rrrrrrrryrrrrrr rs rcs>eZdZdZdZdfd d Zedd dZdddZZ S)_ConnectionDurationEventz9Private base class for connection events with a duration.) __durationrrryr^rOptional[float]r%r&ct||||_dSr)rr"_ConnectionDurationEvent__duration)r+rryrrrr r z!_ConnectionDurationEvent.__init__cCr)zMThe duration of the connection event. .. versionadded:: 4.7 )rrrrr rrz!_ConnectionDurationEvent.durationrbcCrr)rrrryrrrrr rrz!_ConnectionDurationEvent.__repr__)rrryr^rrr%r&)r%rr) rrrrrrrrrrrrrr rs rc@r)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@r)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? r?cs>eZdZdZdZdfd d Zedd d ZdddZZ S)rBaKPublished 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__reasonrrryr^reasonrbcrr)rr_ConnectionClosedEvent__reason)r+rryrrrr r!rzConnectionClosedEvent.__init__r%cCr)zA reason explaining why this connection was closed. The reason must be one of the strings from the :class:`ConnectionClosedReason` enum. )rrrrr r%zConnectionClosedEvent.reasoncCd|jj|j|j|jS)Nz{}({!r}, {!r}, {!r}))rrrrryrrrrr r. zConnectionClosedEvent.__repr__)rrryr^rrbr rrrrrrrrrrrrrr rBs  rBc@r)rDzPublished 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 rD7rrDcs>eZdZdZdZdfd d Zedd dZdddZZ S)rFa!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 rrrrrbrrr%r&cstj|d|d||_dS)Nr)rryr)rr&_ConnectionCheckOutFailedEvent__reason)r+rrrrrr rOs z&ConnectionCheckOutFailedEvent.__init__cCr)zA reason explaining why connection check out failed. The reason must be one of the strings from the :class:`ConnectionCheckOutFailedReason` enum. )rrrrr rSrz$ConnectionCheckOutFailedEvent.reasoncCrr)rrrrrrrrr r\rz&ConnectionCheckOutFailedEvent.__repr__)rrrrbrrr%r&rrrrrr rFCs  rFc@r)rHaPublished 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 rH`rrHc@r)rJaPublished 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 rJmrrJc@sDeZdZdZdZdd d Zedd d Zedd dZdddZ dS) _ServerEventzBase class for server events.)Z__server_address __topology_idserver_addressr topology_idr r%r&cC||_||_dSr)_ServerEvent__server_address_ServerEvent__topology_id)r+rrrrr r z_ServerEvent.__init__cCr)z+The address (host, port) pair of the server)rrrrr rrz_ServerEvent.server_addresscCrz>A unique identifier for the topology this server is a part of.)rrrrr rrz_ServerEvent.topology_idrbcC d|jjd|jd|jdS)N<  topology_id: >)rrrrrrrr r z_ServerEvent.__repr__Nrrrr r%r&rr%r r) rrrrrrrrrrrrrr rzs   rcLeZdZdZdZdfd d Zedd d ZedddZdddZ Z S)r[zJPublished when server description changes. .. versionadded:: 3.3 Z__previous_descriptionZ__new_descriptionprevious_descriptionrnew_descriptionargsrr%r&ctj|||_||_dSr)rr4_ServerDescriptionChangedEvent__previous_description/_ServerDescriptionChangedEvent__new_descriptionr+r r rrrr rrz&ServerDescriptionChangedEvent.__init__cCr)zUThe previous :class:`~pymongo.server_description.ServerDescription`. )rrrrr r rz2ServerDescriptionChangedEvent.previous_descriptioncCr)zPThe new :class:`~pymongo.server_description.ServerDescription`. )rrrrr r rz-ServerDescriptionChangedEvent.new_descriptionrbcCr)Nz <{} {} changed from: {}, to: {}>)rrrrr r rrrr rrz&ServerDescriptionChangedEvent.__repr__)r rr rrrr%r&)r%rr rrrrrrrr r rrrrrr r[  r[c@r)rZzEPublished when server is initialized. .. versionadded:: 3.3 rNrrrrr rZrZc@r)r\z@Published when server is closed. .. versionadded:: 3.3 rNrrrrr r\rr\c@r) TopologyEventz+Base class for topology description events.)rrr r%r&cCrrZ_TopologyEvent__topology_id)r+rrrr rrzTopologyEvent.__init__cCrrrrrrr rrzTopologyEvent.topology_idrbcCsd|jjd|jdS)Nrrr)rrrrrrr rszTopologyEvent.__repr__Nrr r%r&r r) rrrrrrrrrrrrr rs  rcr )rSzPPublished when the topology description changes. .. versionadded:: 3.3 r r rr rrr%r&crr)rr6_TopologyDescriptionChangedEvent__previous_description1_TopologyDescriptionChangedEvent__new_descriptionrrrr rrz(TopologyDescriptionChangedEvent.__init__cCr)zYThe previous :class:`~pymongo.topology_description.TopologyDescription`. )rrrrr r rz4TopologyDescriptionChangedEvent.previous_descriptioncCr)zTThe new :class:`~pymongo.topology_description.TopologyDescription`. )rrrrr r rz/TopologyDescriptionChangedEvent.new_descriptionrbcCr)Nz-<{} topology_id: {} changed from: {}, to: {}>)rrrrr r rrrr rrz(TopologyDescriptionChangedEvent.__repr__)r rr rrrr%r&)r%rrrrrrr rSrrSc@r)rQzKPublished when the topology is initialized. .. versionadded:: 3.3 rNrrrrr rQrrQc@r)rUzFPublished when the topology is closed. .. versionadded:: 3.3 rNrrrrr rUrrUc@sFeZdZdZdZddd d Zedd d ZedddZdddZ dS)_ServerHeartbeatEventz'Base class for server heartbeat events.)rZ __awaitedFryrawaitedrrr%r&cCrr)$_ServerHeartbeatEvent__connection_id_ServerHeartbeatEvent__awaited)r+ryrrrr rrz_ServerHeartbeatEvent.__init__cCr)zSThe address (host, port) of the server this heartbeat was sent to. )rrrrr ry!rz#_ServerHeartbeatEvent.connection_idcCr)zgWhether the heartbeat was issued as an awaitable hello command. .. versionadded:: 4.6 )rrrrr r(rz_ServerHeartbeatEvent.awaitedrbcCr)Nrrz awaited: r)rrryrrrrr r0rz_ServerHeartbeatEvent.__repr__NFryrrrrr%r&rrr) rrrrrrrryrrrrrr rs   rc@r)rMzFPublished when a heartbeat is started. .. versionadded:: 3.3 rNrrrrr rM4rrMcbeZdZdZdZ ddfdd ZedddZedddZedfdd Z dddZ Z S)rNzIFired when the server heartbeat succeeds. .. versionadded:: 3.3 rrFrfloatrr ryrrrrr%r&ct||||_||_dSr)rr(_ServerHeartbeatSucceededEvent__duration%_ServerHeartbeatSucceededEvent__replyr+rrryrrrr rE z&ServerHeartbeatSucceededEvent.__init__cCrz/The duration of this heartbeat in microseconds.)r%rrrr rLrz&ServerHeartbeatSucceededEvent.durationcCr)z-An instance of :class:`~pymongo.hello.Hello`.)r&rrrr rQrz#ServerHeartbeatSucceededEvent.replycrzWhether 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 rV z%ServerHeartbeatSucceededEvent.awaitedrbcCd|jj|j|j|j|jS)Nz,<{} {} duration: {}, awaited: {}, reply: {}>rrrryrrrrrrr rbz&ServerHeartbeatSucceededEvent.__repr__r) rr#rr ryrrrrr%r&r%r#)r%r rr rrrrrrrrrrrrrrrr rN=s   rNcr!)rOzxFired when the server heartbeat fails, either with an "ok: 0" or a socket exception. .. versionadded:: 3.3 r"Frr#r Exceptionryrrrrr%r&cr$r)rr%_ServerHeartbeatFailedEvent__duration"_ServerHeartbeatFailedEvent__replyr'rrr rur(z#ServerHeartbeatFailedEvent.__init__cCrr))r3rrrr r|rz#ServerHeartbeatFailedEvent.durationcCr)zA subclass of :exc:`Exception`.)r4rrrr rrz ServerHeartbeatFailedEvent.replycrr*r+rrrr rr,z"ServerHeartbeatFailedEvent.awaitedrbcCr-)Nz.<{} {} duration: {}, awaited: {}, reply: {!r}>r.rrrr rr/z#ServerHeartbeatFailedEvent.__repr__r) rr#rr2ryrrrrr%r&r0)r%r2rrr1rrrr rOls   rOc@sleZdZdZdjddZedkdd Zedkd d Zedkd d ZedkddZ edkddZ dlddZ  dmdnd$d%Z   & 'dodpd-d.Z   'dqdrd0d1Zdsd3d4Zdtd7d8Zdud:d;Zdvd?d@ZdvdAdBZdwdFdGZdxdHdIZdxdJdKZdydMdNZdzdRdSZd{dTdUZ &d|d}dWdXZd{dYdZZd~d[d\Zdd]d^Zdd`daZd{dbdcZddddeZ ddfdgZ!d~dhdiZ"dS)_EventListenerszConfigure event listeners for a client instance. Any event listeners registered globally are included by default. :param listeners: A list of event listeners. rc"Optional[Sequence[_EventListener]]cCstjdd|_tjdd|_tj}|dd|_tjdd|_tj dd|_ |durj|D]9}t |t r=|j |t |trH|j |t |trS|j |t |tr^|j |t |tri|j |q0t|j|_t|j|_t|j|_t|j|_t|j |_dSr)rlr"_EventListeners__command_listenersr!_EventListeners__server_listenersr+_EventListeners__server_heartbeat_listenersr#_EventListeners__topology_listenersr_EventListeners__cmap_listenersrgr"rmrYrLrPr3rr%_EventListeners__enabled_for_commands#_EventListeners__enabled_for_server-_EventListeners__enabled_for_server_heartbeat%_EventListeners__enabled_for_topology!_EventListeners__enabled_for_cmap)r+rclstrrr rs0              z_EventListeners.__init__r%rrcCr)z-Are any CommandListener instances registered?)r<rrrr enabled_for_commandsrz$_EventListeners.enabled_for_commandscCr)z,Are any ServerListener instances registered?)r=rrrr enabled_for_serverrz"_EventListeners.enabled_for_servercCr)z5Are any ServerHeartbeatListener instances registered?)r>rrrr enabled_for_server_heartbeatrz,_EventListeners.enabled_for_server_heartbeatcCr)z.Are any TopologyListener instances registered?)r?rrrr enabled_for_topologyrz$_EventListeners.enabled_for_topologycCr)z4Are any ConnectionPoolListener instances registered?)r@rrrr enabled_for_cmaprz _EventListeners.enabled_for_cmaplist[_EventListeners]cCs|j|j|j|j|jS)z#List of registered event listeners.)r7r9r8r:r;rrrr event_listenerssz_EventListeners.event_listenersNrrr~rbrxr^ryrrr{op_idr|r}r&c CsX|dur|}t|||||||d}|jD]} z| |Wqty)tYqwdS)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)r|r)r$r7r,r2r) r+rr~rxryrrIr|r# subscriberrrr publish_command_starts$   z%_EventListeners.publish_command_startFrwrrrrospeculative_helloc Csd|dur|}| r i}t|||||||| |d } |jD]} z| | Wqty/tYqwdS)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)r~r)r.r7r/r2r) r+rrrorxryrrIr|rLr~r#rJrrr publish_command_successs,   z'_EventListeners.publish_command_successrc Cs\|dur|}t|||||||| |d } |jD]} z| | Wqty+tYqwdS)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)r0r7r1r2r) r+rrrorxryrrIr|r~r#rJrrr publish_command_failure7s(   z'_EventListeners.publish_command_failurerc C@t||}|jD]}z||WqtytYqwdS)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)rMr9r,r2r)r+ryrr#rJrrr publish_server_heartbeat_startedc    z0_EventListeners.publish_server_heartbeat_startedr#r c CDt||||}|jD]}z||Wq tytYq wdS)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)rNr9r/r2rr+ryrrrr#rJrrr "publish_server_heartbeat_succeededq   z2_EventListeners.publish_server_heartbeat_succeededr2c CrR)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)rOr9r1r2rrSrrr publish_server_heartbeat_failedrUz/_EventListeners.publish_server_heartbeat_failedrrr c CrO)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)rZr8rRr2rr+rrr#rJrrr publish_server_openedrQz%_EventListeners.publish_server_openedc CrO)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)r\r8rVr2rrWrrr publish_server_closedrQz%_EventListeners.publish_server_closedr rr c CsDt||||}|jD]}z||Wq tytYq wdS)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)r[r8rTr2r)r+r r rrr#rJrrr "publish_server_description_changeds   z2_EventListeners.publish_server_description_changedc C>t|}|jD]}z||WqtytYqwdS)zPublish a TopologyOpenedEvent to all topology listeners. :param topology_id: A unique identifier for the topology this server is a part of. N)rQr:rRr2rr+rr#rJrrr publish_topology_opened   z'_EventListeners.publish_topology_openedc Cr[)zPublish a TopologyClosedEvent to all topology listeners. :param topology_id: A unique identifier for the topology this server is a part of. N)rUr:rVr2rr\rrr publish_topology_closedr^z'_EventListeners.publish_topology_closedrc CBt|||}|jD]}z||Wq tytYq wdS)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)rSr:rTr2r)r+r r rr#rJrrr $publish_topology_description_changeds   z4_EventListeners.publish_topology_description_changedrrrc CrO)z:Publish a :class:`PoolCreatedEvent` to all pool listeners.N)r4r;r5r2r)r+rrr#rJrrr publish_pool_createds    z$_EventListeners.publish_pool_createdc Cr[)z8Publish a :class:`PoolReadyEvent` to all pool listeners.N)r7r;r8r2rr+rr#rJrrr publish_pool_ready   z"_EventListeners.publish_pool_readyrc Cr`)z:Publish a :class:`PoolClearedEvent` to all pool listeners.N)r9r;r:r2r)r+rr|rr#rJrrr publish_pool_cleared s    z$_EventListeners.publish_pool_clearedc Cr[)z9Publish a :class:`PoolClosedEvent` to all pool listeners.N)r;r;r<r2rrcrrr publish_pool_closedrez#_EventListeners.publish_pool_closedc CrO)zWPublish a :class:`ConnectionCreatedEvent` to all connection listeners. N)r=r;r>r2rr+rryr#rJrrr publish_connection_created"    z*_EventListeners.publish_connection_createdc Cr`)zDPublish a :class:`ConnectionReadyEvent` to all connection listeners.N)r?r;r@r2rr+rryrr#rJrrr publish_connection_ready-    z(_EventListeners.publish_connection_readyrc Cr`)zVPublish a :class:`ConnectionClosedEvent` to all connection listeners. N)rBr;rCr2r)r+rryrr#rJrrr publish_connection_closed8rmz)_EventListeners.publish_connection_closedc Cr[)z_Publish a :class:`ConnectionCheckOutStartedEvent` to all connection listeners. N)rDr;rEr2rrcrrr $publish_connection_check_out_startedCs   z4_EventListeners.publish_connection_check_out_startedc Cr`)z^Publish a :class:`ConnectionCheckOutFailedEvent` to all connection listeners. N)rFr;rGr2r)r+rrrr#rJrrr #publish_connection_check_out_failedN    z3_EventListeners.publish_connection_check_out_failedc Cr`)zZPublish a :class:`ConnectionCheckedOutEvent` to all connection listeners. N)rHr;rIr2rrkrrr publish_connection_checked_out[rqz._EventListeners.publish_connection_checked_outc CrO)zYPublish a :class:`ConnectionCheckedInEvent` to all connection listeners. N)rJr;rKr2rrhrrr publish_connection_checked_inhrjz-_EventListeners.publish_connection_checked_in)rcr6r)r%rGr)rrr~rbrxr^ryrrr{rIr{r|r}r%r&)NNFrw)rrrrrorbrxr^ryrrr{rIr{r|r}rLrrr~rbr%r&)NNrw)rrrrrorbrxr^ryrrr{rIr{r|r}r~rbr%r&r ) ryrrr#rr rrrr%r&) ryrrr#rr2rrrr%r&r) r rr rrrrr r%r&r)r rr rrr r%r&rrrrr)rrryr^rr#r%r&)rrryr^rrbr%r&)rrrrbrr#r%r&)#rrrrrrrBrCrDrErFrHrKrMrNrPrTrVrXrYrZr]r_rarbrdrfrgrirlrnrorprrrsrrrr r5s^        . 9 ,           r5)r]rr%r^)rarbrcrdr%rd)rjrr%r&)rorbrprqr%rr)Kr __future__rdatetime collectionsrrtypingrrrrr Z bson.objectidr Z pymongo.hellor r Zpymongo.helpers_sharedr rZpymongo.typingsrrrZpymongo.server_descriptionrZpymongo.topology_descriptionrrrlrr"r3rLrPrYr`rkrnrtrur$r.r0rr4r7r9r;rrrrrr=r?rBrDrFrHrJrr[rZr\rrSrQrUrrMrNrOr5rrrr s~ /     x     LCEC -  #   )  )   /0