U dC&@s4UdZddlmZddlZddlZddlZddlmZmZddl m Z m Z m Z m Z mZmZmZmZmZmZmZmZmZmZmZddlmZddlmZddlmZdd lm Z m!Z!m"Z"dd l#m$Z$dd l%m&Z&dd l'm(Z(m)Z)dd l*m+Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1ddl2m3Z3m4Z4ddl5m6Z6ddl7m8Z8m9Z9m:Z:e rPddl;md<dZ?de?Z@de>d<dZAdZBdZCdZDdZEdZFdZGd ZHd ZId!ZJd"ZKd#ZLd$ZMd%ZNdZOdZPdZQd&e>d'<dZRd&e>d(<dZSd&e>d)<d*ZTd+ZUd+ZVd,ZWd-e>d.<d/ZXd-e>d0<d1ZYd2ZZd3d4d5d6d7Z[d3d4d5d8d9Z\d3d:d;d<d=d>Z]ej^ej_ej`ejaejbd?Zcd3d:d@dAdBdCZdd3d:ddAdDdEZed3d:ddAdFdGZfd3d:ddAdHdIZgd3d:dJdAdKdLZhd3d:d&dAdMdNZid3d:d&dAdOdPZjd3d:d3dAdQdRZkd3d:dJdAdSdTZld3d:dUdAdVdWZmd:d:dUdAdXdYZnd3d:dZdAd[d\Zod3d:dZdAd]d^Zpd3d:d_dAd`daZqd3d:dZdAdbdcZrd:d:d_dAdddeZsd:d:d_dAdfdgZtd3d:ddAdhdiZud:d:djdkdldmZvd:d:djdkdndoZwd3d:d3dAdpdqZxd:d:ddkdrdsZyd3d:dtdudvdwZze{dxdydzd{d|gZ|d3d:d}dAd~dZ}d3d:ddAddZ~d:d:ddAddZd3d:ddAddZd:d:ddAddZd:d:ddAddZd3d:ddAddZd3d:ddAddZd3d:dJdAddZd:d:ddAddZd:d:ddAddZd:d:ddAddZdddddZd:ddddZe{dddgZd:d3d3dkddZd:d:ddkddZd:d:ddAddZd:d:ddAddZddgiZde>d<eexe}eke(esedeqedepeqefejeuelewezelededederesedededehehelededenege)ekegetd%Zde>d<edeeedegehedeeyejeqed Zde>d<e~eeve/eeleleeed Zde>d<ddiZde>d<iZde>d<eeeD],\ZZeD]Zeekr:eeee<q:q.eZde>d<eedddddddgZde>d<e{dgZd3d:ddAddτZd3d:ddAddфZddd@ddӜddՄZdd3d:d֜dd؄Zdd3d:d֜ddڄZe{ddddddgZGdddZGdddeee fZdS)z9Functions and classes common to multiple pymongo modules.) annotationsN) OrderedDictabc) TYPE_CHECKINGAnyCallableDictIteratorListMappingMutableMappingNoReturnOptionalSequenceTupleTypeUnionoverload) unquote_plus)SON)UuidRepresentation) CodecOptionsDatetimeConversion TypeRegistry)RawBSONDocument) MECHANISMS)validate_compressorsvalidate_zlib_compression_level) DriverInfoConfigurationError)_validate_event_listeners) ReadConcern) _MONGOS_MODES _ServerMode) ServerApi)DEFAULT_WRITE_CONCERN WriteConcernvalidate_boolean) ClientSessionzSequence[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'ZmongodbstrzTuple[str, int])nodereturncCsZ|}d}|d}|dkr<|d|t||dd}}|drR|dd}||fS)z5Split a host:port string into (host, int(port)) pair.ii:Nr1[)rfindr, startswith)r>hostportidxrH2/tmp/pip-unpacked-wheel-oblwsawz/pymongo/common.pypartition_nodes "  rJcCst|\}}||fS)z6Split and normalize a node name from a hello response.)rJlower)r>rErFrHrHrI clean_nodes rLrr )keydummyr?cCstd|dS)z1Raise ConfigurationError with the given key name.zUnknown option Nr)rMrNrHrHrIraise_config_errorsrO) unspecifiedstandardZ pythonLegacyZ javaLegacyZ csharpLegacybool)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'rU) isinstancer= ValueErrorr(rSrTrHrHrIvalidate_boolean_or_strings  r[cCs\t|tr|St|trHz t|WStk rFtd|dYnXtd|ddS)zDValidates that 'value' is an integer (or basestring representation).rWz must be an integerWrong type for z, value must be an integerNrXr,r=rY TypeErrorrZrHrHrIvalidate_integers   r_cCs&t||}|dkr"td|d|S)zFValidate that 'value' is a positive integer, which does not include 0.rrWz must be a positive integerr_rYrSrTvalrHrHrIvalidate_positive_integers rccCs&t||}|dkr"td|d|S)z1Validate that 'value' is a positive integer or 0.rrWz must be a non negative integerr`rarHrHrIvalidate_non_negative_integers rdz Optional[str]cCs&|dkr |St||}t||S)z1Validates that 'value' is file-like and readable.N)validate_stringopencloserZrHrHrIvalidate_readables   rhcCs|dkr |St||S)z4Validate that 'value' is a positive integer or None.NrcrZrHrHrI!validate_positive_integer_or_nonesrjcCs|dkr |St||S)z9Validate that 'value' is a positive integer or 0 or None.N)rdrZrHrHrI%validate_non_negative_integer_or_nonesrkcCs"t|tr|Std|ddS)z/Validates that 'value' is an instance of `str`.r\z", value must be an instance of strN)rXr=r^rZrHrHrIres recCs|dkr |St||S)z@Validates that 'value' is an instance of `basestring` or `None`.N)rerZrHrHrIvalidate_string_or_nonesrlzUnion[int, str]cCsPt|tr|St|tr, did you forget to percent-escape the token with quote_plus?zTauth mechanism properties must be key:value pairs like SERVICE_NAME:mongodb, not {}.zA{} is not a supported auth mechanism property. Must be one of {}.r)rXr=dictrYitemsrRrKrinspect isfunction signaturelen parametersrerr_MECHANISM_PROPSrr[r) rSrTpropsrMrZexpected_paramsmsgoptrbrHrHrI"validate_auth_mechanism_propertiessd              rz2Union[Type[MutableMapping], Type[RawBSONDocument]]cCsbd}zt|tj}Wn,tk r@t|drs  rzOptional[ServerApi]cCs(|dkr |St|ts$t|d|S)z$Validate the server_api keyword arg.Nz! must be an instance of ServerApi)rXr%r^rZrHrHrIvalidate_server_api_or_noneGs  rzOptional[Callable]cCs&|dkr |St|s"t|d|S)z%Validates that 'value' is a callable.Nz must be a callable)callablerYrZrHrHrIvalidate_is_callable_or_nonePs rMapping[str, Any]) replacementr?cCs:td||r6t|ts6tt|}|dr6tddS)z Validate a replacement document.r$z'replacement can not include $ operatorsN)rrXrnextiterrDrY)rfirstrHrHrIvalidate_ok_for_replaceYs    r)updater?cCsHtd||stdt|t }tt|}|rD|dsDtddS)zValidate an update document.rzupdate cannot be emptyrz"update only works with $ operatorsN)rrYrXrrrrD)rZ is_documentrrHrHrIvalidate_ok_for_updatecs   rstrictreplaceignorecCs |tkrtd|tt|S)zAValidate the Unicode decode error handler option of CodecOptions.z@{} is an invalid Unicode decode error handler. Must be one of {})_UNICODE_DECODE_ERROR_HANDLERSrYrrr}rHrHrI%validate_unicode_decode_error_handlerssrzOptional[datetime.tzinfo]cCs$|dk r t|tjs td||S)zValidate the tzinfo optionNz)%s must be an instance of datetime.tzinfo)rXdatetimetzinfor^r}rHrHrIvalidate_tzinfo~s r Optional[Any]cCs4|dkr |Sddlm}t||s0t|d|S)rNr)AutoEncryptionOptsz* must be an instance of AutoEncryptionOpts)Zpymongo.encryption_optionsrrXr^)rSrTrrHrHrI%validate_auto_encryption_opts_or_nones   rzOptional[DatetimeConversion]cCsX|dkrtjSt|tr4|r,tt|St|St|trFt|St|ddS)z%Validate a DatetimeConversion string.Nz5 must be a str or int representing DatetimeConversion)rZDATETIMErXr=isdigitr,r^rZrHrHrIvalidate_datetime_conversions   rtlssslzDict[str, List[str]]URI_OPTIONS_ALIAS_MAP)%appnameZ authmechanismauthmechanismpropertiesZ authsourceZ compressorsconnecttimeoutmsZdirectconnectionheartbeatfrequencymsjournalZlocalthresholdms maxidletimemsZ maxconnectingZ maxpoolsizemaxstalenesssecondsZreadconcernlevelZreadpreferenceZreadpreferencetagsZ replicasetZ retryreadsZ retrywritesZ loadbalancedserverselectiontimeoutmssockettimeoutmsrZtlsallowinvalidcertificatesZtlsallowinvalidhostnamesZ tlscafileZtlscertificatekeyfileZtlscertificatekeyfilepasswordZtlsdisableocspendpointcheckZ tlsinsecurew wtimeoutmsZzlibcompressionlevelZsrvservicenameZ srvmaxhostsZ timeoutmsz$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]cCs,t||\}}|tkr$td|||fS)z,Validate optional authentication parameters.zUnknown authentication option: )validate _AUTH_OPTIONSr )rSrTrKrHrHrIvalidate_auth_option#srcCs&|}t|t}|||}||fS)zGeneric validation function.)rKrgetrO)rSrTrK validatorrHrHrIr+s  rzMutableMapping[str, Any])optionswarnr?c sttr6t}ddddd}dddfdd }n$i}ddddd}ddddd}D]v\}}||}zt|t}|||}Wn>tttfk r} z|rt t | nW5d } ~ XYqbX||||<qb|S) aValidate each entry in options and raise a warning if it is not valid. Returns a copy of options with invalid entries removed. :Parameters: - `opts`: A dict containing MongoDB URI options. - `warn` (optional): If ``True`` then warnings will be logged and invalid options will be ignored. Otherwise, invalid options will cause errors. r=)xr?cSs|SNrHrrHrHrIget_normed_keyCsz-get_validated_options..get_normed_keycs |Sr) cased_keyrrrHrIget_setter_keyFsz-get_validated_options..get_setter_keycSs|Sr)rKrrHrHrIrLscSs|SrrHrrHrHrIrOsN) rX_CaseInsensitiveDictionaryrrrrOrYr^r warningsrr=) rrZvalidated_optionsrrrrTZ normed_keyrexcrHrrIget_validated_options3s$  r)encrypted_fieldsrr?cCs|dd|dS)NZ escCollectionenxcol_.z.escrrrrHrHrI_esc_coll_nameasrcCs|dd|dS)NZecocCollectionrz.ecocrrrHrHrI_ecoc_coll_nameesrrZwtimeoutrrjrc@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'r"r) codec_optionsr write_concern read_concernr?cCsjt|tstd||_t|ts0td|||_t|tsHtd||_t|t s`td||_ dS)NzDcodec_options must be an instance of bson.codec_options.CodecOptionszV{!r} 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) rXrr^_BaseObject__codec_optionsr$r_BaseObject__read_preferencer'_BaseObject__write_concernr"_BaseObject__read_concern)selfrrrrrHrHrI__init__ts$    zBaseObject.__init__r?cCs|jS)zdRead only access to the :class:`~bson.codec_options.CodecOptions` of this instance. )rrrHrHrIrszBaseObject.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. )rrrHrHrIrszBaseObject.write_concernzOptional[ClientSession])sessionr?cCs|r|jrtS|jS)zBRead only access to the write concern of this instance or session.)Zin_transactionr&rrrrHrHrI_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. )rrrHrHrIrszBaseObject.read_preferencecCs|r|p|jS|jS)zDRead only access to the read preference of this instance or session.)Z_txn_read_preferencerr rHrHrI_read_preference_forszBaseObject._read_preference_forcCs|jS)zRead only access to the :class:`~pymongo.read_concern.ReadConcern` of this instance. .. versionadded:: 3.2 )rrrHrHrIrszBaseObject.read_concernN) __name__ __module__ __qualname____doc__rpropertyrrr rr rrHrHrHrIrms 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)rrrrHrHrIrsz#_CaseInsensitiveDictionary.__init__r=rR)rMr?cCs||jkSr)rKrrrMrHrHrI __contains__sz'_CaseInsensitiveDictionary.__contains__r,rcCs t|jSr)rrrrHrHrI__len__sz"_CaseInsensitiveDictionary.__len__z Iterator[str]cCsdd|jDS)Ncss|] }|VqdSrrH).0rMrHrHrI sz6_CaseInsensitiveDictionary.__iter__..)rrrHrHrI__iter__sz#_CaseInsensitiveDictionary.__iter__cstfddDS)Ncsi|]}j|j|qSrH)rr)rkrrHrI sz7_CaseInsensitiveDictionary.__repr__..)r=rrHrrI__repr__sz#_CaseInsensitiveDictionary.__repr__r)rMrTr?cCs |}||j|<||j|<dSrrKrr)rrMrTlc_keyrHrHrI __setitem__s z&_CaseInsensitiveDictionary.__setitem__cCs|j|Sr)rrKrrHrHrI __getitem__sz&_CaseInsensitiveDictionary.__getitem__cCs|}|j|=|j|=dSrr)rrMrrHrHrI __delitem__sz&_CaseInsensitiveDictionary.__delitem__)otherr?cCsHt|tjstSt|t|kr$dS|D]}||||kr(dSq(dS)NFT)rXrr NotImplementedrrr#rMrHrHrI__eq__s z!_CaseInsensitiveDictionary.__eq__Nr)rMdefaultr?cCs|j||Sr)rrrKrrMr'rHrHrIrsz_CaseInsensitiveDictionary.get)rMrrr?cOs*|}|j|d|jj|f||Sr)rKrpopr)rrMrrrrHrHrIr)sz_CaseInsensitiveDictionary.poprcCs"|j\}}|j|}||fSr)rpopitemrr))rrrrTrHrHrIr*s z"_CaseInsensitiveDictionary.popitemcCs|j|jdSr)rclearrrrHrHrIr+s z _CaseInsensitiveDictionary.clearcCsdSrrHr(rHrHrI setdefaultsz%_CaseInsensitiveDictionary.setdefaultcCsdSrrHr(rHrHrIr,scCs6|}||kr|j|S||j|<||j|<|SdSr)rKrr)rrMr'rrHrHrIr,s    rcCsBt|tr(|D]}|||||<qn|D]}||||<q,dSr)rXrrr%rHrHrIrs  z!_CaseInsensitiveDictionary.updatecCs|j|Sr)rrKrrHrHrIrsz$_CaseInsensitiveDictionary.cased_key)N)N)N)r r rrrrrrr r!r"r&rr)r*r+rr,rrrHrHrHrIrs(  r)T)r __future__rrrr collectionsrrtypingrrrrr r r r r rrrrrr urllib.parserZbsonrZ bson.binaryrZbson.codec_optionsrrrZ bson.raw_bsonrZ pymongo.authrZpymongo.compression_supportrrZpymongo.driver_inforZpymongo.errorsr Zpymongo.monitoringr!Zpymongo.read_concernr"Zpymongo.read_preferencesr#r$Zpymongo.server_apir%Zpymongo.write_concernr&r'r(Zpymongo.client_sessionr)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_CONNECTINGr5r6r7ZLOCAL_THRESHOLD_MSZ RETRY_WRITESZ RETRY_READSr:r<Z_MAX_END_SESSIONSZSRV_SERVICE_NAMErJrLrOZ UNSPECIFIEDZSTANDARDZ PYTHON_LEGACYZ JAVA_LEGACYZ CSHARP_LEGACYrr[r_rcrdrhrjrkrerlrnrorrrurxryrzr{r|r~rrrr frozensetrrrrrrrrrrrrrrrrrrrrrrrrrrrroptnamealiasesaliascopyrrrrrrrrZWRITE_CONCERN_OPTIONSrr=rrHrHrHrIs D                                =            +      .V