i)i:WdZddlmZddlZddlmZddlmZmZm Z m Z m Z ddl m Z ddlmZddlmZmZer dd lmZdd lmZdZd Zd Zd ZdZdZe eefZe e eefZd5dZd6dZ d7dZ!d8dZ"GddZ#Gdd e#Z$Gd!d"e#Z%Gd#d$e#Z&Gd%d&e#Z'Gd'd(e#Z(Gd)d*Z)e$e%e&e'e(fZ* d9d:d-Z+d.Z,Gd/d0Z-d;d2Z.Gd3d4Z/dS)> max_stalenessrstrc d|zS)Nz6maxStalenessSeconds must be a positive integer, not %sr's r$_invalid_max_staleness_msgr,Ps Cm SSr&intc|dkrdSt|tstt||dkrt t||S)zValidate max_staleness.r)rr-r r,r"r+s r$_validate_max_stalenessr0Usdr mS ) )C2=AABBB3MBBCCC r&hedgeOptional[_Hedge]c|dSt|tstd|tjdt d|S)zValidate hedge.Nz hedge must be a dictionary, not The read preference 'hedge' option is deprecated in PyMongo 4.12+ because hedged reads are deprecated in MongoDB version 8.0+. Support for 'hedge' will be removed in PyMongo 5.0.r stacklevel)rdictr warningswarnDeprecationWarning)r1s r$_validate_hedger;csb }t eT " "FD5DDEEE M } Lr&ceZdZdZdZ d'd(dZed)dZed)dZed*dZ ed+dZ ed,dZ ed+dZ ed-dZ ed+dZd)dZd.dZd.dZd*d Zd/d#Zd0d&ZdS)1 _ServerModez$Base class for all read preferences.) __mongos_mode__mode __tag_sets__max_staleness__hedgeNr/moder-rrr'r1r2rNonect||_||_t||_t ||_t||_dSN) _MONGOS_MODES_ServerMode__mongos_mode_ServerMode__moder%_ServerMode__tag_setsr0_ServerMode__max_stalenessr;_ServerMode__hedge)selfrCrr'r1s r$__init__z_ServerMode.__init__xsJ+40 ,X666}EE&u-- r&r(c|jjS)z!The name of this read preference.) __class____name__rMs r$namez_ServerMode.names~&&r&c|jS)z(The mongos mode of this read preference.)rHrRs r$ mongos_modez_ServerMode.mongos_modes !!r&dict[str, Any]cd|ji}|jdigfvr |j|d<|jdkr |j|d<|jdifvr |j|d<|S)zRead preference as a document.rCNr#r/maxStalenessSecondsr1)rHrJrKrL)rMdocs r$documentz_ServerMode.documentsl &t'9: ?4", . ./CK  2 % %)-)=C% & <bz ) )|jrt|jnigS)aWSet ``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 `_ )rJrrRs r$rz_ServerMode.tag_setss"()-AtDO$$$bTAr&c|jS)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. rKrRs r$r'z_ServerMode.max_stalenesss ##r&cV|jtjdtd|jS)am**DEPRECATED** - The read preference 'hedge' option is deprecated in PyMongo 4.12+ because hedged reads are deprecated in MongoDB version 8.0+. Support for 'hedge' will be removed in PyMongo 5.0. 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 Nr4rr5)rLr8r9r:rRs r$r1z_ServerMode.hedges;0 < # ME"     |r&c |jdkrdndS)aThe 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/rr_rRs r$min_wire_versionz_ServerMode.min_wire_versions(B..qqA5r&cZd|j|j|j|jS)Nz1{}(tag_sets={!r}, max_staleness={!r}, hedge={!r}))formatrSrJrKrLrRs r$__repr__z_ServerMode.__repr__s/BII I O  L    r&otherrboolct|tr@|j|jko/|j|jko|j|jko|j|jkSt SrF)rr=rCrr'r1NotImplementedrMrgs r$__eq__z_ServerMode.__eq__sd e[ ) )  UZ'.MU^3.&%*==.J%+-   r&c||k SrFr*rks r$__ne__z_ServerMode.__ne__s5=  r&c8|j|j|j|jdS)zeReturn value of object for pickling. Needed explicitly because __slots__() defined. )rCrr'r1)rIrJrKrLrRs r$ __getstate__z_ServerMode.__getstate__s( K!1\    r&valueMapping[str, Any]c|d|_t|j|_t|d|_t |d|_t|d|_dS)zRestore from pickling.rCrr'r1N) rIrGrHr%rJr0rKr;rL)rMrqs r$ __setstate__z_ServerMode.__setstate__ s\Fm *4;7,U:->??6u_7MNN&uW~66 r& selectionrc|SrFr*rMrus r$__call__z_ServerMode.__call__sr&Nr/N) rCr-rrr'r-r1r2rrDrr()rrV)rr-)rr\)rr2rgrrrh)rqrrrrDrurrr)rQ __module__ __qualname____doc__ __slots__rNpropertyrSrUrZrCrr'r1rcrfrlrnrprtrxr*r&r$r=r=ss..WI (,"& . . . . .'''X'"""X"   X XBBBXB*$$$X$X> 6 6 6X 6    !!!!     7777r&r=c@eZdZdZdZdfd ZddZdd ZddZxZ S)PrimaryaGPrimary 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*rrDcTttdSrF)superrN_PRIMARY)rMrPs r$rNzPrimary.__init__$s! """""r&rurc|jSz*Apply this read preference to a Selection.)primary_selectionrws r$rxzPrimary.__call__'s **r&r(cdS)Nz Primary()r*rRs r$rfzPrimary.__repr__+s{r&rgrrhcZt|tr|jtkStSrF)rr=rCrrjrks r$rlzPrimary.__eq__.s' e[ ) ) *:) )r&rrDr|rzr{) rQr}r~rrrNrxrfrl __classcell__rPs@r$rrsI######++++r&rc8eZdZdZdZ ddfd ZddZxZS)PrimaryPreferredaPrimaryPreferred 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: **DEPRECATED** - The :attr:`~hedge` for this read preference. .. versionchanged:: 3.11 Added ``hedge`` parameter. r*Nr/rrr'r-r1r2rrDcZtt|||dSrF)rrN_PRIMARY_PREFERREDrMrr'r1rPs r$rNzPrimaryPreferred.__init__Qs* +X}eLLLLLr&rurcx|jr|jSt|jt j|j|Sz(Apply this read preference to Selection.)rrr rr selectr'rws r$rxzPrimaryPreferred.__call__YsA   . .6 6=d>PR[\\ r&ryrrr'r-r1r2rrDr|rQr}r~rrrNrxrrs@r$rr4sy4I(,"& MMMMMMMr&rc8eZdZdZdZ ddfd ZddZxZS) SecondaryaSecondary 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: **DEPRECATED** - The :attr:`~hedge` for this read preference. .. versionchanged:: 3.11 Added ``hedge`` parameter. r*Nr/rrr'r-r1r2rrDcZtt|||dSrF)rrN _SECONDARYrs r$rNzSecondary.__init__{s) X}eDDDDDr&rurc\t|jtj|j|Sr)r rr rr'rws r$rxzSecondary.__call__s,2 M29$:LiXX   r&ryrr|rrs@r$rrcsy*I(,"& EEEEEEE        r&rc8eZdZdZdZ ddfd ZddZxZS)SecondaryPreferredaSecondaryPreferred 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: **DEPRECATED** - The :attr:`~hedge` for this read preference. .. versionchanged:: 3.11 Added ``hedge`` parameter. r*Nr/rrr'r-r1r2rrDcZtt|||dSrF)rrN_SECONDARY_PREFERREDrs r$rNzSecondaryPreferred.__init__s* -xNNNNNr&rurcrt|jtj|j|}|r|S|jSr)r rr rr'r)rMru secondariess r$rxzSecondaryPreferred.__call__sB9 M29$:LiXX    / . .r&ryrr|rrs@r$rrsy2I(,"& OOOOOOO / / / / / / / /r&rc8eZdZdZdZ ddfd ZddZxZS)NearestayNearest 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: **DEPRECATED** - The :attr:`~hedge` for this read preference. .. versionchanged:: 3.11 Added ``hedge`` parameter. r*Nr/rrr'r-r1r2rrDcZtt|||dSrF)rrN_NEARESTrs r$rNzNearest.__init__s) 8]EBBBBBr&rurc\t|jtj|j|Sr)r rr rr'rws r$rxzNearest.__call__s,/ M29$:LiXX   r&ryrr|rrs@r$rrsy*I(,"& CCCCCCC        r&rc>eZdZdZdZddZdd Zdd ZddZddZ dS) _AggWritePrefzAgg $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_prefrr=c6||_tj|_dSrF)rReadPreferencePRIMARYr)rMrs r$rNz_AggWritePref.__init__s +9+Ar&topology_descriptionrrrDc|j}|tjr|r|dkrtj|_dS|j|_dS)N )common_wire_versionhas_readable_serverrPRIMARY_PREFERREDrrr)rMr common_wvs r$selection_hookz_AggWritePref.selection_hooksW(< 4 4^5U V V , ,B"0"8D   "&)D   r&rurc,||Sr)rrws r$rxz_AggWritePref.__call__s""9---r&r(cd|jdS)Nz_AggWritePref(pref=))rrRs r$rfz_AggWritePref.__repr__s3TY3333r&rSrc,t|j|SrF)getattrr)rMrSs r$ __getattr__z_AggWritePref.__getattr__st*D111r&N)rr=)rrrrDr|rz)rSr(rr) rQr}r~rrrNrrxrfrr*r&r$rrs+IBBBB , , , ,....4444 222222r&rr/rCc|tkr9|digfvrtd|dkrtdtSt|||S)Nz4Read preference primary cannot be combined with tagsr/zCRead preference primary cannot be combined with maxStalenessSeconds)rr r_ALL_READ_PREFERENCES)rCrr's r$make_read_preferencer sp x D2$< ' '$%[\\ \ B  $U yy  &x ? ??r&)rr SECONDARYSECONDARY_PREFERREDNEARESTcveZdZdZeZeZeZ e Z e Z dS)raAn 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 `Read and Write Settings `_ 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. N)rQr}r~rrrrrrrrrrrr*r&r$rr#sZ44lgiiG((** I,,..giiGGGr&rrSc6t|S)z2Get the read preference mode from mongos/uri name.)rGindex)rSs r$read_pref_mode_from_nameras   t $ $$r&c>eZdZUdZded<d dZdd Zdd Zd d Zd S) MovingAveragez0Tracks an exponentially-weighted moving average.Optional[float]averagerrDcd|_dSrFrrRs r$rNzMovingAverage.__init__k  r&samplefloatc|dkrtd||j ||_dSd|jzd|zz|_dS)Nrzduration cannot be negative g?g?)r"r)rMrs r$ add_samplezMovingAverage.add_samplensR A::DFDDEE E < !DLLL-f rs_ #"""""BBBBBBBBBBBBBB++++++------ A222222@@@@@@      c  GCH% &.TTTT         bbbbbbbbJk8,,,,,{,,,^$ $ $ $ $ $ $ $ N-/-/-/-/-/-/-/-/`$ $ $ $ $ k$ $ $ N%2%2%2%2%2%2%2%2P!"2I?QSZ[CE @ @ @ @ @ ;;;;;;;;|%%%% r&