Ii`SSrSSKJr SSKJr SSKJrJrJrJ r J r SSK J r SSK Jr SSKJrJr \(a SSKJr SS KJr SrS rS rS rS rSr\\\4r\ \\\4rS)SjrS*SjrS+Sjr S,Sjr!"SS5r""SS\"5r#"SS\"5r$"SS\"5r%"SS\"5r&"SS\"5r'"SS 5r(\#\$\%\&\'4r)S-S.S!jjr*S"r+"S#S$5r,S/S%jr-"S&S'5r.g()0zUtilities for choosing which member of a replica set to read from. .. seealso:: This module is compatible with both the synchronous and asynchronous PyMongo APIs. ) annotations)abc) TYPE_CHECKINGAnyMappingOptionalSequence)max_staleness_selectors)ConfigurationError) member_with_tags_server_selector#secondary_with_tags_server_selector) Selection)TopologyDescription)primaryprimaryPreferred secondarysecondaryPreferrednearestc&UcU$[U[[45(d[SU<S35e[ U5S:Xa[ SU<S35eUH2n[U[ R5(aM$[SU<S35e [U5$)z$Validate tag sets for a MongoClient.z Tag sets z invalid, must be a sequencerz: invalid, must be None or contain at least one set of tagszTag set zg invalid, must be an instance of dict, bson.son.SON or other type that inherits from collection.Mapping) isinstancelisttuple TypeErrorlen ValueErrorrr)tag_setstagss >/venv/lib/python3.13/site-packages/pymongo/read_preferences.py_validate_tag_setsr#8s hu . .)Hc SU-$)Nz6maxStalenessSeconds must be a positive integer, not %s max_stalenesss r"_invalid_max_staleness_msgr)Os Cm SSr$cUS:Xag[U[5(d[[U55eUS::a[ [U55eU$)zValidate max_staleness.r)rintrr)rr's r"_validate_max_stalenessr-TsJ mS ) )2=ABB3MBCC r$cVUcg[U[5(d[SU<35eU$)zValidate hedge.Nz hedge must be a dictionary, not )rdictr)hedges r"_validate_hedger1bs/ } eT " ":5)DEE Lr$c\rSrSrSrSrSSSjjr\SSj5r\SSj5r \SSj5r \SS j5r \SS j5r \SS j5r \SS j5r\SS j5rSSjrSSjrSSjrSSjrSSjrSSjrSrg) _ServerModemz$Base class for all read preferences.) __mongos_mode__mode __tag_sets__max_staleness__hedgeNc[UUlXl[U5Ul[ U5Ul[U5UlgN) _MONGOS_MODES_ServerMode__mongos_mode_ServerMode__moder#_ServerMode__tag_setsr-_ServerMode__max_stalenessr1_ServerMode__hedge)selfmoder r(r0s r"__init___ServerMode.__init__rs;+40 ,X66}E&u- r$c.URR$)z!The name of this read preference.) __class____name__rBs r"name_ServerMode.names~~&&&r$cUR$)z(The mongos mode of this read preference.)r=rIs r" mongos_mode_ServerMode.mongos_modes!!!r$cSUR0nURS0/4;aURUS'URS:waURUS'URS04;aURUS'U$)zRead preference as a document.rCNr!r+maxStalenessSecondsr0)r=r?r@rA)rBdocs r"document_ServerMode.documentst &t'9'9: ??4", .//CK   2 %)-)=)=C% & <<bz )<rIs r"rC_ServerMode.modes{{r$cTUR(a[UR5$0/$)aSet ``tag_sets`` to a list of dictionaries like [{'dc': 'ny'}] to read only from members whose ``dc`` tag has the value ``"ny"``. To specify a priority-order for tag sets, provide a list of tag sets: ``[{'dc': 'ny'}, {'dc': 'la'}, {}]``. A final, empty tag set, ``{}``, means "read from any member that matches the mode, ignoring tags." MongoClient tries each set of tags in turn until it finds a set of tags with at least one matching member. For example, to only send a query to an analytic node:: Nearest(tag_sets=[{"node":"analytics"}]) Or using :class:`SecondaryPreferred`:: SecondaryPreferred(tag_sets=[{"node":"analytics"}]) .. seealso:: `Data-Center Awareness `_ )r?rrIs r"r _ServerMode.tag_setss ()-tDOO$AbTAr$cUR$)zThe maximum estimated length of time (in seconds) a replica set secondary can fall behind the primary in replication before it will no longer be selected for operations, or -1 for no maximum. r@rIs r"r(_ServerMode.max_stalenesss ###r$cUR$)a@The read preference ``hedge`` parameter. A dictionary that configures how the server will perform hedged reads. It consists of the following keys: - ``enabled``: Enables or disables hedged reads in sharded clusters. Hedged reads are automatically enabled in MongoDB 4.4+ when using a ``nearest`` read preference. To explicitly enable hedged reads, set the ``enabled`` key to ``true``:: >>> Nearest(hedge={'enabled': True}) To explicitly disable hedged reads, set the ``enabled`` key to ``False``:: >>> Nearest(hedge={'enabled': False}) .. versionadded:: 3.11 )rArIs r"r0_ServerMode.hedges,||r$c*URS:XaS$S$)aRThe wire protocol version the server must support. Some read preferences impose version requirements on all servers (e.g. maxStalenessSeconds requires MongoDB 3.4 / maxWireVersion 5). All servers' maxWireVersion must be at least this read preference's `min_wire_version`, or the driver raises :exc:`~pymongo.errors.ConfigurationError`. r+rrYrIs r"min_wire_version_ServerMode.min_wire_versions((B.q5A5r$czSRURURURUR5$)Nz1{}(tag_sets={!r}, max_staleness={!r}, hedge={!r}))formatrJr?r@rArIs r"__repr___ServerMode.__repr__s3BII II OO  LL   r$c*[U[5(ayURUR:H=(aY URUR:H=(a9 URUR:H=(a UR UR :H$[ $r;)rr3rCr r(r0NotImplementedrBothers r"__eq___ServerMode.__eq__sq e[ ) ) UZZ'.MMU^^3.&&%*=*==.JJ%++-   r$c X:X+$r;r&rgs r"__ne___ServerMode.__ne__s   r$c`URURURURS.$)zUReturn value of object for pickling. Needed explicitly because __slots__() defined. )rCr r(r0)r>r?r@rArIs r" __getstate___ServerMode.__getstate__s, KK!11\\   r$cUSUl[URUl[US5Ul[ US5Ul[US5Ulg)zRestore from pickling.rCr r(r0N) r>r<r=r#r?r-r@r1rA)rBvalues r" __setstate___ServerMode.__setstate__sQFm *4;;7,U:->?6u_7MN&uW~6 r$cU$r;r&rB selections r"__call___ServerMode.__call__sr$)r9r8r6r5r7Nr+N) rCr,r Optional[_TagSets]r(r,r0Optional[_Hedge]returnNoner}str)r}zdict[str, Any])r}r,)r}_TagSets)r}r|rhrr}bool)rrzMapping[str, Any]r}r~rwrr}r)rH __module__ __qualname____firstlineno____doc__ __slots__rDpropertyrJrMrRrCr r(r0r_rcrirlrorsrx__static_attributes__r&r$r"r3r3ms .WI (,"& . .% . .  .  .''""  BB*$$. 6 6 !  7r$r3cR^\rSrSrSrSrSU4SjjrS SjrS SjrS Sjr Sr U=r $) Primaryi a/Primary read preference. * When directly connected to one mongod queries are allowed if the server is standalone or a replica set primary. * When connected to a mongos queries are sent to the primary of a shard. * When connected to a replica set queries are sent to the primary of the replica set. r&c,>[TU][5 gr;)superrD_PRIMARY)rBrGs r"rDPrimary.__init__s "r$cUR$z*Apply this read preference to a Selection.)primary_selectionrvs r"rxPrimary.__call__s***r$cg)Nz Primary()r&rIs r"rcPrimary.__repr__sr$c^[U[5(aUR[:H$[$r;)rr3rCrrfrgs r"riPrimary.__eq__ s$ e[ ) )::) )r$r}r~rrr) rHrrrrrrDrxrcrir __classcell__rGs@r"rr s(I#+r$rcV^\rSrSrSrSrSSU4SjjjrSSjrSrU=r $) PrimaryPreferredi&a@PrimaryPreferred read preference. * When directly connected to one mongod queries are allowed to standalone servers, to a replica set primary, or to replica set secondaries. * When connected to a mongos queries are sent to the primary of a shard if available, otherwise a shard secondary. * When connected to a replica set queries are sent to the primary if available, otherwise a secondary. .. note:: When a :class:`~pymongo.mongo_client.MongoClient` is first created reads will be routed to an available secondary until the primary of the replica set is discovered. :param tag_sets: The :attr:`~tag_sets` to use if the primary is not available. :param max_staleness: (integer, in seconds) The maximum estimated length of time a replica set secondary can fall behind the primary in replication before it will no longer be selected for operations. Default -1, meaning no maximum. If it is set, it must be at least 90 seconds. :param hedge: The :attr:`~hedge` to use if the primary is not available. .. versionchanged:: 3.11 Added ``hedge`` parameter. r&c0>[TU][XU5 gr;)rrD_PRIMARY_PREFERREDrBr r(r0rGs r"rDPrimaryPreferred.__init__Cs +XeLr$cUR(a UR$[UR[R "UR U55$z(Apply this read preference to Selection.)rrr r r selectr(rvs r"rxPrimaryPreferred.__call__KsB   .. .6 6==d>P>PR[\ r$rzr r{r(r,r0r|r}r~r rHrrrrrrDrxrrrs@r"rr&sZ4I(,"& M$MM M  MMr$rcV^\rSrSrSrSrSSU4SjjjrSSjrSrU=r $) SecondaryiUaSecondary read preference. * When directly connected to one mongod queries are allowed to standalone servers, to a replica set primary, or to replica set secondaries. * When connected to a mongos queries are distributed among shard secondaries. An error is raised if no secondaries are available. * When connected to a replica set queries are distributed among secondaries. An error is raised if no secondaries are available. :param tag_sets: The :attr:`~tag_sets` for this read preference. :param max_staleness: (integer, in seconds) The maximum estimated length of time a replica set secondary can fall behind the primary in replication before it will no longer be selected for operations. Default -1, meaning no maximum. If it is set, it must be at least 90 seconds. :param hedge: The :attr:`~hedge` for this read preference. .. versionchanged:: 3.11 Added ``hedge`` parameter. r&c0>[TU][XU5 gr;)rrD _SECONDARYrs r"rDSecondary.__init__ms XeDr$cl[UR[R"URU55$r)r r r rr(rvs r"rxSecondary.__call__us,2 MM299$:L:LiX  r$rzrrrrs@r"rrUsZ*I(,"& E$EE E  EE  r$rcV^\rSrSrSrSrSSU4SjjjrSSjrSrU=r $) SecondaryPreferredi|aCSecondaryPreferred read preference. * When directly connected to one mongod queries are allowed to standalone servers, to a replica set primary, or to replica set secondaries. * When connected to a mongos queries are distributed among shard secondaries, or the shard primary if no secondary is available. * When connected to a replica set queries are distributed among secondaries, or the primary if no secondary is available. .. note:: When a :class:`~pymongo.mongo_client.MongoClient` is first created reads will be routed to the primary of the replica set until an available secondary is discovered. :param tag_sets: The :attr:`~tag_sets` for this read preference. :param max_staleness: (integer, in seconds) The maximum estimated length of time a replica set secondary can fall behind the primary in replication before it will no longer be selected for operations. Default -1, meaning no maximum. If it is set, it must be at least 90 seconds. :param hedge: The :attr:`~hedge` for this read preference. .. versionchanged:: 3.11 Added ``hedge`` parameter. r&c0>[TU][XU5 gr;)rrD_SECONDARY_PREFERREDrs r"rDSecondaryPreferred.__init__s -xNr$c[UR[R"URU55nU(aU$UR $r)r r r rr(r)rBrw secondariess r"rxSecondaryPreferred.__call__s@9 MM299$:L:LiX   .. .r$rzrrrrs@r"rr|sZ2I(,"& O$OO O  OO / /r$rcV^\rSrSrSrSrSSU4SjjjrSSjrSrU=r $) Nearestia(Nearest read preference. * When directly connected to one mongod queries are allowed to standalone servers, to a replica set primary, or to replica set secondaries. * When connected to a mongos queries are distributed among all members of a shard. * When connected to a replica set queries are distributed among all members. :param tag_sets: The :attr:`~tag_sets` for this read preference. :param max_staleness: (integer, in seconds) The maximum estimated length of time a replica set secondary can fall behind the primary in replication before it will no longer be selected for operations. Default -1, meaning no maximum. If it is set, it must be at least 90 seconds. :param hedge: The :attr:`~hedge` for this read preference. .. versionchanged:: 3.11 Added ``hedge`` parameter. r&c0>[TU][XU5 gr;)rrD_NEARESTrs r"rDNearest.__init__s 8EBr$cl[UR[R"URU55$r)r r r rr(rvs r"rxNearest.__call__s,/ MM299$:L:LiX  r$rzrrrrs@r"rrsZ*I(,"& C$CC C  CC  r$rcN\rSrSrSrSrS SjrS SjrS SjrSSjr SSjr S r g ) _AggWritePrefizAgg $out/$merge write preference. * If there are readable servers and there is any pre-5.0 server, use primary read preference. * Otherwise use `pref` read preference. :param pref: The read preference to use on MongoDB 5.0+. )prefeffective_prefc:Xl[RUlgr;)rReadPreferencePRIMARYr)rBrs r"rD_AggWritePref.__init__s +9+A+Ar$cURnUR[R5(a#U(aUS:a[RUlgUR Ulg)N )common_wire_versionhas_readable_serverrPRIMARY_PREFERREDrrr)rBtopology_description common_wvs r"selection_hook_AggWritePref.selection_hooksH(<< 4 4^5U5U V VB"0"8"8D "&))D r$c$URU5$r)rrvs r"rx_AggWritePref.__call__s""9--r$c$SUR<S3$)Nz_AggWritePref(pref=))rrIs r"rc_AggWritePref.__repr__s$TYYM33r$c.[URU5$r;)getattrr)rBrJs r" __getattr___AggWritePref.__getattr__st**D11r$)rrN)rr3)rrr}r~rr)rJrr}r) rHrrrrrrDrrxrcrrr&r$r"rrs(+IB ,.4 2r$rcU[:Xa/US0/4;a [S5eUS:wa [S5e[5$[U"X5$)Nz4Read preference primary cannot be combined with tagsr+zCRead preference primary cannot be combined with maxStalenessSeconds)rr r_ALL_READ_PREFERENCES)rCr r(s r"make_read_preferencersX x D2$< '$%[\ \ B $U y  &x ??r$)rr SECONDARYSECONDARY_PREFERREDNEARESTc^\rSrSrSr\"5r\"5r\ "5r \ "5r \ "5rSrg)ria)An enum that defines some commonly used read preference modes. Apps can also create a custom read preference, for example:: Nearest(tag_sets=[{"node":"analytics"}]) See :doc:`/examples/high_availability` for code examples. A read preference is used in three cases: :class:`~pymongo.mongo_client.MongoClient` connected to a single mongod: - ``PRIMARY``: Queries are allowed if the server is standalone or a replica set primary. - All other modes allow queries to standalone servers, to a replica set primary, or to replica set secondaries. :class:`~pymongo.mongo_client.MongoClient` initialized with the ``replicaSet`` option: - ``PRIMARY``: Read from the primary. This is the default, and provides the strongest consistency. If no primary is available, raise :class:`~pymongo.errors.AutoReconnect`. - ``PRIMARY_PREFERRED``: Read from the primary if available, or if there is none, read from a secondary. - ``SECONDARY``: Read from a secondary. If no secondary is available, raise :class:`~pymongo.errors.AutoReconnect`. - ``SECONDARY_PREFERRED``: Read from a secondary if available, otherwise from the primary. - ``NEAREST``: Read from any member. :class:`~pymongo.mongo_client.MongoClient` connected to a mongos, with a sharded cluster of replica sets: - ``PRIMARY``: Read from the primary of the shard, or raise :class:`~pymongo.errors.OperationFailure` if there is none. This is the default. - ``PRIMARY_PREFERRED``: Read from the primary of the shard, or if there is none, read from a secondary of the shard. - ``SECONDARY``: Read from a secondary of the shard, or raise :class:`~pymongo.errors.OperationFailure` if there is none. - ``SECONDARY_PREFERRED``: Read from a secondary of the shard if available, otherwise from the shard primary. - ``NEAREST``: Read from any shard member. r&N)rHrrrrrrrrrrrrrrrr&r$r"rrs14liG(* I,.iGr$rc,[RU5$)z2Get the read preference mode from mongos/uri name.)r<index)rJs r"read_pref_mode_from_namerSs   t $$r$cL\rSrSr%SrS\S'S SjrS SjrS SjrS Sjr S r g ) MovingAverageiXz0Tracks an exponentially-weighted moving average.Optional[float]averagecSUlgr;rrIs r"rDMovingAverage.__init__]  r$cUS:a[SU35eURcXlgSUR-SU--Ulg)Nrzduration cannot be negative g?g?)rr)rBsamples r" add_sampleMovingAverage.add_sample`sF A:;F8DE E << !L-f rsJ #BB+- 2@      c  GCH% &.T ZZzk8,{,^$ $ N-/-/`$ k$ N%2%2P!"2I?QSZ[CE @  @+ @