3 ]]n@@sdZddlmZmZddlmZddlmZddlm Z m Z dZ dZ dZ dZd Zd/ZddZddZddZGdddeZGdddeZGdddeZGdddeZGdddeZGdd d eZeeeeefZd1d!d"Zd2ZGd(d)d)eZd*d+ZGd,d-d-eZ d.S)3zBUtilities for choosing which member of a replica set to read from.)abc integer_types)max_staleness_selectors)ConfigurationError) member_with_tags_server_selector#secondary_with_tags_server_selectorprimaryprimaryPreferred secondarysecondaryPreferrednearestcCsj|dkr |St|ts$td|ft|dkr>td|fx&|D]}t|tjsDtd|fqDW|S)z3Validate tag sets for a MongoReplicaSetClient. Nz#Tag sets %r invalid, must be a listrzETag sets %r invalid, must be None or contain at least one set of tagszqTag set %r invalid, must be an instance of dict, bson.son.SON or other type that inherits from collection.Mapping) isinstancelist TypeErrorlen ValueErrorrMapping)tag_setstagsr;/tmp/pip-build-20mum3z4/pymongo/pymongo/read_preferences.py_validate_tag_sets(s      rcCsd|S)Nz6maxStalenessSeconds must be a positive integer, not %sr) max_stalenessrrr_invalid_max_staleness_msg@srcCs:|dkr dSt|ts"tt||dkr6tt||S)zValidate max_staleness.rrr)rrrrr)rrrr_validate_max_stalenessFs   rc@seZdZdZd"Zd$dd Zed d Zed d ZeddZ eddZ eddZ eddZ eddZ ddZddZddZddZd d!ZdS)% _ServerModez)Base class for all read preferences. __mongos_mode__mode __tag_sets__max_stalenessNrcCs(t||_||_t||_t||_dS)N) _MONGOS_MODES_ServerMode__mongos_mode_ServerMode__moder_ServerMode__tag_setsr_ServerMode__max_staleness)selfmoderrrrr__init__Zs  z_ServerMode.__init__cCs|jjS)z*The name of this read preference. ) __class____name__)r*rrrname`sz_ServerMode.namecCs|jS)z1The mongos mode of this read preference. )r&)r*rrr mongos_modefsz_ServerMode.mongos_modecCs<d|ji}|jdigfkr$|j|d<|jdkr8|j|d<|S)z'Read preference as a document. r+NrrZmaxStalenessSecondsr)r&r(r))r*docrrrdocumentls     z_ServerMode.documentcCs|jS)z3The mode of this read preference instance. )r')r*rrrr+wsz_ServerMode.modecCs|jrt|jSigS)a{Set ``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." MongoReplicaSetClient tries each set of tags in turn until it finds a set of tags with at least one matching member. .. seealso:: `Data-Center Awareness `_ )r(r)r*rrrr}s z_ServerMode.tag_setscCs|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.)r))r*rrrrsz_ServerMode.max_stalenesscCs|jdkrdSdS)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`. rrr)r))r*rrrmin_wire_versions z_ServerMode.min_wire_versioncCsd|j|j|jfS)Nz!%s(tag_sets=%r, max_staleness=%r))r/r(r))r*rrr__repr__sz_ServerMode.__repr__cCs2t|tr.|j|jko,|j|jko,|j|jkStS)N)rr r+rrNotImplemented)r*otherrrr__eq__s     z_ServerMode.__eq__cCs ||k S)Nr)r*r7rrr__ne__sz_ServerMode.__ne__cCs|j|j|jdS)zeReturn value of object for pickling. Needed explicitly because __slots__() defined. )r+rr)r'r(r))r*rrr __getstate__sz_ServerMode.__getstate__cCs6|d|_t|j|_t|d|_t|d|_dS)zRestore from pickling.r+rrN)r'r%r&rr(rr))r*valuerrr __setstate__s  z_ServerMode.__setstate__)r!r"r#r$r)Nr)r. __module__ __qualname____doc__ __slots__r,propertyr/r0r2r+rrr4r5r8r9r:r<rrrrr Ts        r cs<eZdZdZfZfddZddZddZdd ZZ 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. cstt|jtdS)N)superrBr,_PRIMARY)r*)r-rrr,szPrimary.__init__cCs|jS)z*Apply this read preference to a Selection.)primary_selection)r* selectionrrr__call__szPrimary.__call__cCsdS)Nz Primary()r)r*rrrr5szPrimary.__repr__cCst|tr|jtkStS)N)rr r+rDr6)r*r7rrrr8s  zPrimary.__eq__) r.r=r>r?r@r,rGr5r8 __classcell__rr)r-rrBs  rBcs.eZdZdZfZd fdd ZddZZS) PrimaryPreferredaQPrimaryPreferred 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. :Parameters: - `tag_sets`: The :attr:`~tag_sets` to use if the primary is not available. - `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. Nrcstt|jt||dS)N)rCrIr,_PRIMARY_PREFERRED)r*rr)r-rrr,s zPrimaryPreferred.__init__cCs&|jr |jSt|jtj|j|SdS)z(Apply this read preference to Selection.N)r rErrrselectr)r*rFrrrrGs zPrimaryPreferred.__call__r)Nr)r.r=r>r?r@r,rGrHrr)r-rrIsrIcs.eZdZdZfZd fdd ZddZZS) Secondarya]Secondary 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. :Parameters: - `tag_sets`: The :attr:`~tag_sets` for this read preference. - `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. Nrcstt|jt||dS)N)rCrLr, _SECONDARY)r*rr)r-rrr,szSecondary.__init__cCst|jtj|j|S)z(Apply this read preference to Selection.)rrrrKr)r*rFrrrrGszSecondary.__call__r)Nr)r.r=r>r?r@r,rGrHrr)r-rrLsrLcs.eZdZdZfZd fdd ZddZZS) SecondaryPreferreda^SecondaryPreferred 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. :Parameters: - `tag_sets`: The :attr:`~tag_sets` for this read preference. - `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. Nrcstt|jt||dS)N)rCrNr,_SECONDARY_PREFERRED)r*rr)r-rrr,6s zSecondaryPreferred.__init__cCs(t|jtj|j|}|r|S|jSdS)z(Apply this read preference to Selection.N)rrrrKrrE)r*rFZ secondariesrrrrG;s zSecondaryPreferred.__call__r)Nr)r.r=r>r?r@r,rGrHrr)r-rrN!srNcs.eZdZdZfZd fdd ZddZZS) NearestaNearest 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. :Parameters: - `tag_sets`: The :attr:`~tag_sets` for this read preference. - `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. Nrcstt|jt||dS)N)rCrPr,_NEAREST)r*rr)r-rrr,]szNearest.__init__cCst|jtj|j|S)z(Apply this read preference to Selection.)rrrrKr)r*rFrrrrG`szNearest.__call__r)Nr)r.r=r>r?r@r,rGrHrr)r-rrPHsrPcCsB|tkr4|digfkrtd|dkr.tdtSt|||S)Nz4Read preference primary cannot be combined with tagsrzCRead preference primary cannot be combined with maxStalenessSecondsr)rDrrB_ALL_READ_PREFERENCES)r+rrrrrmake_read_preferencelsrSPRIMARYPRIMARY_PREFERRED SECONDARYSECONDARY_PREFERREDNEARESTc@s.eZdZdZeZeZeZ e Z e Z dS)ReadPreferenceaDAn enum that defines the read preference modes supported by PyMongo. 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. N)r.r=r>r?rBrTrIrUrLrVrNrWrPrXrrrrrYs 1rYcCs tj|S)z7Get the read preference mode from mongos/uri name. )r%index)r/rrrread_pref_mode_from_namesr[c@s0eZdZdZddZddZddZdd Zd S) MovingAveragez0Tracks an exponentially-weighted moving average.cCs d|_dS)N)average)r*rrrr,szMovingAverage.__init__cCs6|dkr dS|jdkr||_nd|jd||_dS)Nrg?g?)r])r*samplerrr add_samples  zMovingAverage.add_samplecCs|jS)z6Get the calculated average, or None if no samples yet.)r])r*rrrgetszMovingAverage.getcCs d|_dS)N)r])r*rrrresetszMovingAverage.resetN)r.r=r>r?r,r_r`rarrrrr\s  r\N)r r rrrr)r)rTrUrVrWrX)!r?Zbson.py3compatrrZpymongorZpymongo.errorsrZpymongo.server_selectorsrrrDrJrMrOrQr%rrrobjectr rBrIrLrNrPrRrSZ_MODESrYr[r\rrrrsD  k& '   9