U ~fh"'@s`UdZddlmZddlZddlZddlmZmZddlm Z ddl m Z m Z m Z mZmZmZmZmZmZmZmZmZddlmZddlmZdd lmZdd lmZmZm Z dd l!m"Z"dd l#m$Z$m%Z%dd l&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-ddl.m/Z/m0Z0ddl1m2Z2ddl3m4Z4m5Z5m6Z6e rdZ?dZ@dZAdZBdZCd ZDd ZEd!ZFd"ZGd#ZHd$ZId%ZJdZKdZLdZMd&e:d'<dZNd&e:d(<dZOd&e:d)<d*ZPd+ZQd+ZRd,ZSd-e:d.<d/ZTd-e:d0<d1ZUd2ZVd3ZWd4d5d6d7d8ZXd4d5d6d9d:ZYdd4d;dd?ZZej[ej\ej]ej^ej_d@Z`d4dAdBdCdDdEZad4dAddCdFdGZbd4dAddCdHdIZcd4dAddCdJdKZdd4dAdLdCdMdNZed4dAd&dCdOdPZfd4dAd&dCdQdRZgd4dAd4dCdSdTZhd4dAdLdCdUdVZid4dAdWdCdXdYZjdAdAdWdCdZd[Zkd4dAd\dCd]d^Zld4dAd\dCd_d`Zmd4dAdadCdbdcZnd4dAd\dCdddeZodAdAdadCdfdgZpdAdAdadCdhdiZqd4dAddCdjdkZrdAdAdldmdndoZsdAdAdldmdpdqZtd4dAd4dCdrdsZudAdAddmdtduZvd4dAdvdwdxdyZwexdzd{d|d}d~dgZyd4dAddCddZzd4dAddCddZ{dAdAddCddZ|d4dAddCddZ}dAdAd;dCddZ~dAdAddCddZd4dAddCddZd4dAddCddZd4dAdLdCddZdAdAddCddZdAdAddCddZdAdAddCddZdddddZdAddddZexdddgZdAd4d4dmddZdAdAddmddZdAdAddCddZdAdAddCddZd4d4d4dCddZddgiZde:d<eeuezehe$epeaeneaemenecegereieteweieaeaeaeoepeaeaeaeeeeeieaeaekede%ehedeqed&Zde:d<eaeeeaedeeeaeevegened Zde:d<e{e|ese+eeieieee}d Zde:d<ddiZde:d<iZde:d<eeeD],\ZZeD]ZeekrBeeee<qBq6eZde:d<eedddddddgZde:d<exdgZd4dAddCddӄZdd4ddLdd՜ddׄZd4dAddCddلZdddBddۜdd݄Zdd4dAdޜddZdd4dAdޜddZexddddddgZGdddZGdddeee fZdBdddZdS)z9Functions and classes common to multiple pymongo modules.) annotationsN) OrderedDictabc)get_close_matches) TYPE_CHECKINGAnyCallableIteratorMappingMutableMappingNoReturnOptionalSequenceTypeUnionoverload) unquote_plus)SON)UuidRepresentation) CodecOptionsDatetimeConversion TypeRegistry)RawBSONDocument)validate_compressorsvalidate_zlib_compression_level) DriverInfo)ConfigurationError)_validate_event_listeners) ReadConcern) _MONGOS_MODES _ServerMode) ServerApi)DEFAULT_WRITE_CONCERN WriteConcernvalidate_boolean)_AgnosticClientSessionzSequence[Type] ORDERED_TYPESiintMAX_MESSAGE_SIZEiz3.6 g?<g4@dz Optional[int]MAX_IDLE_TIME_MSMAX_IDLE_TIME_SECWAIT_QUEUE_TIMEOUTT);z Sequence[int]COMMAND_NOT_FOUND_CODES) i@i@UNAUTHORIZED_CODESi'Zmongodbautostrztuple[str, int])nodereturncCsZ|}d}|d}|dkr<|d|t||dd}}|drR|dd}||fS)z5Split a host:port string into (host, int(port)) pair.ii:Nr-[)rfindr( startswith)r;hostportidxrE2/tmp/pip-unpacked-wheel-36gvocj8/pymongo/common.pypartition_nodes "  rGcCst|\}}||fS)z6Split and normalize a node name from a hello response.)rGlower)r;rBrCrErErF clean_nodes rIzOptional[list]r )key suggestionsr<cCs2d|d}|r&|dd|d7}t|dS)z1Raise ConfigurationError with the given key name.Unknown option: .z Did you mean one of (, z:) or maybe a camelCase version of one? Refer to docstring.N)joinr)rJrKmsgrErErFraise_config_errors rQ) unspecifiedstandardZ pythonLegacyZ javaLegacyZ csharpLegacyrbool)optionvaluer<cCs4t|tr*|dkr"td|d|dkSt||S)z8Validates that value is True, False, 'true', or 'false'.)truefalse The value of z must be 'true' or 'false'rW) isinstancer: ValueErrorr$rUrVrErErFvalidate_boolean_or_strings  r]cCs^t|tr|St|trJz t|WStk rHtd|ddYnXtd|ddS)zDValidates that 'value' is an integer (or basestring representation).rYz must be an integerNWrong type for z, value must be an integerrZr(r:r[ TypeErrorr\rErErFvalidate_integers   racCs&t||}|dkr"td|d|S)zFValidate that 'value' is a positive integer, which does not include 0.rrYz must be a positive integerrar[rUrVvalrErErFvalidate_positive_integers recCs&t||}|dkr"td|d|S)z1Validate that 'value' is a positive integer or 0.rrYz must be a non negative integerrbrcrErErFvalidate_non_negative_integers rfz Optional[str]cCs&|dkr |St||}t||S)z1Validates that 'value' is file-like and readable.N)validate_stringopencloser\rErErFvalidate_readables   rjcCs|dkr |St||S)z4Validate that 'value' is a positive integer or None.Nrer\rErErF!validate_positive_integer_or_nonesrlcCs|dkr |St||S)z9Validate that 'value' is a positive integer or 0 or None.N)rfr\rErErF%validate_non_negative_integer_or_nonesrmcCs"t|tr|Std|ddS)z/Validates that 'value' is an instance of `str`.r^z", value must be an instance of strN)rZr:r`r\rErErFrgs rgcCs|dkr |St||S)z@Validates that 'value' is an instance of `basestring` or `None`.N)rgr\rErErFvalidate_string_or_nonesrnzUnion[int, str]cCsPt|tr|St|trz-1rkr\rErErFvalidate_max_stalenessbsr~r )dummyrVr<cCst|tst|d|S)zValidate a read preference.z is not a read preference.)rZr r`rrVrErErFvalidate_read_preferencejs rcCs|tkrt|d|S)zValidate read preference mode for a MongoClient. .. versionchanged:: 3.5 Returns the original ``value`` instead of the validated read preference mode. z is not a valid read preference)rr[rrErErFvalidate_read_preference_modeqsrcCs.ddlm}||kr*t|dt||S)z&Validate the authMechanism URI option.r) MECHANISMSz must be in )Zpymongo.auth_sharedrr[tuple)rUrVrrErErFvalidate_auth_mechanism}s rcCs<z t|WStk r6t|dttdYnXdS)zz< is not a supported auth mechanism property. Must be one of rMr)rZr:dictr[itemsrTrHrZpymongo.auth_oidc_sharedrtypergrr partition_MECHANISM_PROPSrr])rUrVpropsrJropt_rdrErErF"validate_auth_mechanism_propertiessH              rz2Union[Type[MutableMapping], Type[RawBSONDocument]]cCsbd}zt|tj}Wn,tk r@t|drpollstreamr9=z7 is invalid. Must be one of "auto", "stream", or "poll")r[r\rErErFvalidate_server_monitoring_modes rtlssslzdict[str, list[str]]URI_OPTIONS_ALIAS_MAP)&appnameZ authmechanismauthmechanismpropertiesZ authsourceZ compressorsconnecttimeoutmsZdirectconnectionheartbeatfrequencymsjournalZlocalthresholdms maxidletimemsZ maxconnectingZ maxpoolsizemaxstalenesssecondsZreadconcernlevelZreadpreferenceZreadpreferencetagsZ replicasetZ retryreadsZ retrywritesZ loadbalancedserverselectiontimeoutmssockettimeoutmsrZtlsallowinvalidcertificatesZtlsallowinvalidhostnamesZ tlscafileZtlscertificatekeyfileZtlscertificatekeyfilepasswordZtlsdisableocspendpointcheckZ tlsinsecurew wtimeoutmsZzlibcompressionlevelZsrvservicenameZ srvmaxhostsZ timeoutmsZservermonitoringmodez$dict[str, Callable[[Any, Any], Any]]URI_OPTIONS_VALIDATOR_MAP) connectZdriverZ server_apifsyncZ minpoolsizeZ tlscrlfileZtz_awareZunicode_decode_error_handlerZuuidrepresentationZwaitqueuemultiplewaitqueuetimeoutmsZdatetime_conversionNONSPEC_OPTIONS_VALIDATOR_MAP) Zdocument_classZ type_registryread_preferenceZevent_listenersrusernamepasswordZserver_selectorZauto_encryption_optsZauthoidcallowedhosts KW_VALIDATORSzdict[str, str]INTERNAL_URI_OPTION_NAME_MAPzdict[str, tuple[str, str]]URI_OPTIONS_DEPRECATION_MAP VALIDATORSrrrrrrrz list[str]TIMEOUT_OPTIONSrtuple[str, Any]cCs2t||\}}|tkr*td|dt||fS)z,Validate optional authentication parameters.rLz . Must be in )validate _AUTH_OPTIONSr)rUrVrHrErErFvalidate_auth_option(srr)rJ validators normed_keyr<cCsD|p|}z ||WStk r>t||dd}t||YnXdS)Ng?)cutoff)rrrQ)rJrrrKrErErF_get_validator0s  rcCs$t|t|d}|||}||fS)zGeneric validation function.r)rrrH)rUrV validatorrErErFr;s rzMutableMapping[str, Any])optionswarnr<c sttr6t}ddddd}dddfdd }n$i}ddddd}ddddd}D]|\}}||}zt|t|d }|||} WnBtttfk r} z|rtj t | d d nW5d } ~ XYqbX| |||<qb|S) aaValidate each entry in options and raise a warning if it is not valid. Returns a copy of options with invalid entries removed. :param opts: A dict containing MongoDB URI options. :param warn: If ``True`` then warnings will be logged and invalid options will be ignored. Otherwise, invalid options will cause errors. r:)xr<cSs|SNrErrErErFget_normed_keyQsz-get_validated_options..get_normed_keycs |Sr) cased_keyrrrErFget_setter_keyTsz-get_validated_options..get_setter_keycSs|Sr)rHrrErErFrZscSs|SrrErrErErFr]srr') stacklevelN) rZ_CaseInsensitiveDictionaryrrrr[r`rwarningsrr:) rrZvalidated_optionsrrrrVrrZ validatedexcrErrFget_validated_optionsBs$ r)encrypted_fieldsrr<cCs|dd|dS)NZ escCollectionenxcol_.z.escgetrrrErErF_esc_coll_nameosrcCs|dd|dS)NZecocCollectionrz.ecocrrrErErF_ecoc_coll_namessrrZwtimeoutrrjrc@seZdZdZdddddddd Zedd d d Zedd d dZdddddZedd ddZ dddddZ edd ddZ dS) BaseObjectzA base class that provides attributes and methods common to multiple pymongo classes. SHOULD NOT BE USED BY DEVELOPERS EXTERNAL TO MONGODB. rr r#rr) codec_optionsr write_concern read_concernr<cCsjt|tstd||_t|ts0t|d||_t|tsHtd||_t|ts`td||_ dS)NzDcodec_options must be an instance of bson.codec_options.CodecOptionszR is not valid for read_preference. See pymongo.read_preferences for valid options.zGwrite_concern must be an instance of pymongo.write_concern.WriteConcernzDread_concern must be an instance of pymongo.read_concern.ReadConcern) rZrr`_codec_optionsr _read_preferencer#_write_concernr _read_concern)selfr rr r rErErF__init__s     zBaseObject.__init__r<cCs|jS)zdRead only access to the :class:`~bson.codec_options.CodecOptions` of this instance. )r rrErErFr szBaseObject.codec_optionscCs|jS)zRead only access to the :class:`~pymongo.write_concern.WriteConcern` of this instance. .. versionchanged:: 3.0 The :attr:`write_concern` attribute is now read only. )rrrErErFr szBaseObject.write_concernz Optional[_AgnosticClientSession])sessionr<cCs|r|jrtS|jS)zBRead only access to the write concern of this instance or session.)Zin_transactionr"r rrrErErF_write_concern_fors zBaseObject._write_concern_forcCs|jS)zRead only access to the read preference of this instance. .. versionchanged:: 3.0 The :attr:`read_preference` attribute is now read only. )r rrErErFrszBaseObject.read_preferencecCs|r|p|jS|jS)zDRead only access to the read preference of this instance or session.)Z_txn_read_preferencer rrErErF_read_preference_forszBaseObject._read_preference_forcCs|jS)zRead only access to the :class:`~pymongo.read_concern.ReadConcern` of this instance. .. versionadded:: 3.2 )rrrErErFr szBaseObject.read_concernN) __name__ __module__ __qualname____doc__rpropertyr r rrrr rErErErFr{s rc@s>eZdZdddddZddddd Zd d d d Zdd ddZdd ddZddddddZdddddZ dddddZ dddddZ d4dddd d!d"Z ddddd#d$d%Z d&d d'd(Zdd d)d*Zed5dddd d+d,Zedddd d-d,Zd6dddd d.d,Zd/ddd0d1Zdddd2d3ZdS)7rr)argskwargscOs i|_i|_|t||dSr)%_CaseInsensitiveDictionary__casedkeys _CaseInsensitiveDictionary__datarr)rrrrErErFrsz#_CaseInsensitiveDictionary.__init__r:rT)rJr<cCs||jkSr)rHr rrJrErErF __contains__sz'_CaseInsensitiveDictionary.__contains__r(rcCs t|jSr)rr rrErErF__len__sz"_CaseInsensitiveDictionary.__len__z Iterator[str]cCsdd|jDS)Ncss|] }|VqdSrrE).0rJrErErF sz6_CaseInsensitiveDictionary.__iter__..)rrrErErF__iter__sz#_CaseInsensitiveDictionary.__iter__cstfddDS)Ncsi|]}j|j|qSrE)rr )r$krrErF sz7_CaseInsensitiveDictionary.__repr__..)r:rrErrF__repr__sz#_CaseInsensitiveDictionary.__repr__r)rJrVr<cCs |}||j|<||j|<dSrrHrr )rrJrVlc_keyrErErF __setitem__s z&_CaseInsensitiveDictionary.__setitem__cCs|j|Sr)r rHr!rErErF __getitem__sz&_CaseInsensitiveDictionary.__getitem__cCs|}|j|=|j|=dSrr*)rrJr+rErErF __delitem__sz&_CaseInsensitiveDictionary.__delitem__)otherr<cCsHt|tjstSt|t|kr$dS|D]}||||kr(dSq(dS)NFT)rZrr NotImplementedrrr/rJrErErF__eq__s z!_CaseInsensitiveDictionary.__eq__Nr)rJdefaultr<cCs|j||Sr)r rrHrrJr3rErErFrsz_CaseInsensitiveDictionary.get)rJrrr<cOs*|}|j|d|jj|f||Sr)rHrpopr )rrJrrr+rErErFr5sz_CaseInsensitiveDictionary.poprcCs"|j\}}|j|}||fSr)rpopitemr r5)rr+rrVrErErFr6s z"_CaseInsensitiveDictionary.popitemcCs|j|jdSr)rclearr rrErErFr7s z _CaseInsensitiveDictionary.clearcCsdSrrEr4rErErF setdefault sz%_CaseInsensitiveDictionary.setdefaultcCsdSrrEr4rErErFr8scCs6|}||kr|j|S||j|<||j|<|SdSr)rHr r)rrJr3r+rErErFr8s    rcCsBt|tr(|D]}|||||<qn|D]}||||<q,dSr)rZrrr1rErErFrs  z!_CaseInsensitiveDictionary.updatecCs|j|Sr)rrHr!rErErFr%sz$_CaseInsensitiveDictionary.cased_key)N)N)N)rrrrr"r#r&r)r,r-r.r2rr5r6r7rr8rrrErErErFrs(  rrcCs.zddlm}WdStk r(YdSXdS)zIs the C extension installed?r _cmessageTFN)Zpymongor: ImportErrorr9rErErFhas_c)s  r<)N)N)T)r __future__rrr collectionsrrdifflibrtypingrrrr r r r r rrrr urllib.parserZbsonrZ bson.binaryrZbson.codec_optionsrrrZ bson.raw_bsonrZpymongo.compression_supportrrZpymongo.driver_inforZpymongo.errorsrZpymongo.monitoringrZpymongo.read_concernrZpymongo.read_preferencesrr Zpymongo.server_apir!Zpymongo.write_concernr"r#r$Zpymongo.typingsr%r&__annotations__Z MAX_BSON_SIZEr)ZMIN_WIRE_VERSIONZMAX_WIRE_VERSIONZMAX_WRITE_BATCH_SIZEZMIN_SUPPORTED_SERVER_VERSIONZMIN_SUPPORTED_WIRE_VERSIONZMAX_SUPPORTED_WIRE_VERSIONZHEARTBEAT_FREQUENCYZKILL_CURSOR_FREQUENCYZEVENTS_QUEUE_FREQUENCYZSERVER_SELECTION_TIMEOUTZMIN_HEARTBEAT_INTERVALZMIN_SRV_RESCAN_INTERVALZCONNECT_TIMEOUTZ MAX_POOL_SIZEZ MIN_POOL_SIZEZMAX_CONNECTINGr1r2r3ZLOCAL_THRESHOLD_MSZ RETRY_WRITESZ RETRY_READSr6r8Z_MAX_END_SESSIONSZSRV_SERVICE_NAMEZSERVER_MONITORING_MODErGrIrQZ UNSPECIFIEDZSTANDARDZ PYTHON_LEGACYZ JAVA_LEGACYZ CSHARP_LEGACYrr]rarerfrjrlrmrgrnrprqrtrwrzr{r|r}r~rrrrr frozensetrrrrrrrrrrrrrrrrrrrrrrrrrrrrroptnamealiasesaliascopyrrrrrrrrrZWRITE_CONCERN_OPTIONSrr:rr<rErErErFs  8                                 3             ,       -VX