U du<@sb UdZddlZddlZddlZddlZddlZddlZddlZddlm Z ddlm Z ddl mZddlmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$ddl%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-ddl.m/Z/dd l0m1Z1m2Z2m3Z3m4Z4dd l5m6Z6m7Z7m8Z8m9Z9m:Z:m;Z;dd lm?Z?dd l@mAZAmBZBmCZCddlDmEZEddlFmGZGddlHmIZIddlJmKZKddlLmMZMddlNmOZOmPZPddlQmRZRerddlSmTZTmUZUzddlVmWZWdZXWneYk rdZXYnXdddddddd d!d"d#d$d%d&d'd(d)d*d+d,d-d.d/d0d1d2d3d4d5d6d7d8d9d:d;dd?d@dAdBdCdDdEdFdGdHdIdJdKdLdMdNdOdPdQdRdSdTg bson `bson.int64.Int64` int64 both float number (real) both str string both list array both dict / `SON` object both datetime.datetime [#dt]_ [#dt2]_ date both `bson.regex.Regex` regex both compiled re [#re]_ regex py -> bson `bson.binary.Binary` binary both `bson.objectid.ObjectId` oid both `bson.dbref.DBRef` dbref both None undefined bson -> py `bson.code.Code` code both str symbol bson -> py bytes [#bytes]_ binary both ======================================= ============= =================== .. [#int] A Python int will be saved as a BSON int32 or BSON int64 depending on its size. A BSON int32 will always decode to a Python int. A BSON int64 will always decode to a :class:`~bson.int64.Int64`. .. [#dt] datetime.datetime instances will be rounded to the nearest millisecond when saved .. [#dt2] all datetime.datetime instances are treated as *naive*. clients should always use UTC. .. [#re] :class:`~bson.regex.Regex` instances and regular expression objects from ``re.compile()`` are both saved as BSON regular expressions. BSON regular expressions are decoded as :class:`~bson.regex.Regex` instances. .. [#bytes] The bytes type is encoded as BSON binary with subtype 0. It will be decoded back to bytes. N) utf_8_decode) utf_8_encode)abc)IO TYPE_CHECKINGAnyBinaryIOCallableDict GeneratorIteratorListMappingMutableMappingNoReturnOptionalSequenceTupleTypeTypeVarUnioncastoverload)ALL_UUID_SUBTYPES CSHARP_LEGACY JAVA_LEGACYOLD_UUID_SUBTYPESTANDARD UUID_SUBTYPEBinaryUuidRepresentation)Code)DEFAULT_CODEC_OPTIONS CodecOptionsDatetimeConversion_raw_document_class) EPOCH_AWARE EPOCH_NAIVE DatetimeMS_datetime_to_millis_millis_to_datetimeutc)DBRef) Decimal128) InvalidBSONInvalidDocumentInvalidStringData)Int64MaxKeyMinKeyObjectId)Regex)RE_TYPESON) Timestamp) _DocumentType_ReadableBuffer)_cbsonTFrrrrrrrr r!r"r#r,r-r.r/r0r1r3r5r7r8r9r:r;r+r&r'BSONNUMBSONSTRBSONOBJBSONARRBSONBINBSONUNDBSONOIDBSONBOOBSONDATBSONNULBSONRGXBSONREFBSONCODBSONSYMBSONCWSBSONINTBSONTIMBSONLONBSONDECBSONMINBSONMAXget_data_and_view gen_list_nameencodedecode decode_all decode_iterdecode_file_iteris_validBSONhas_cr$r(     zrcCsd|fSrur|rr|r|r}rrcCs t|fSrur4rr|r|r}rrcCs t|fSrur2rr|r|r}rr.r)rsr{rrr raw_arrayrtcCst|||||Sru)r>_element_to_dict)rsr{rrrrr|r|r}rsrc Cs||}|d7}t||||\}}|r`|ttkr`t||t|\}} |||| d| dfSzt|||||||\} }Wntk rt||YnX|jj r|jj t | } | dk r| | } || |fS)z Decode a single key, value pair.rN) rordrBrlenrrrrrrr) rsr{rrrrr~r_rrrr|r|r}rs,  _T)bound)rsrrrrrrtc Cs"t|\}}t|||||||dS)Nr)rTr)rsrrrrrr{r|r|r} _raw_to_dict4s r)rsr{rrrrrrtc CsX|dkr|}|d}||krDt||||||d\}} }| ||<q||krTtd|S)z#Decode a BSON document into result.Nrrbad object or element length)rrr.) rsr{rrrrrrkeyrr|r|r}r;s   r)rsrrtcCst|\}}z>t|jr&|||WSt|dt|\}}t||d||WStk r`Yn4tk rt \}}}tt | |YnXdS)z'Decode a BSON string to document_class.rrN) rTr%rrrrr. Exceptionsysexc_inforwith_traceback)rsrr{rr exc_valueexc_tbr|r|r} _bson_to_dictRs  rccs |]}t|ddVqdS)utf8N)rrV).0ir|r|r} ksr)rtccs2tEdHtd}tt|ddVqdS)zGenerate "keys" for encoded lists in the sequence b"0", b"1", b"2", ... The first 1000 keys are returned from a pre-built cache. All subsequent keys are generated on the fly. Nrrr) _LIST_NAMES itertoolscountrnextrV)counterr|r|r}rUns  )stringrtcCsxt|trTd|krtdzt|dd|dWStk rPtd|YqtXn d|krdtdt|ddSdS)z8Make a 'C' string, checking for embedded NUL characters.rz;BSON keys / regex patterns must not contain a NUL characterNT,strings in documents must be valid UTF-8: %rrr)rvrwr/r UnicodeErrorr0 _utf_8_encoderr|r|r}_make_c_string_check|s   rcCsXt|trDzt|dd|dWStk r@td|YqTXnt|ddSdS)zMake a 'C' string.NTrrr)rvrwrrr0rrr|r|r}_make_c_strings   rcCs d|krtdt|ddS)z*Make a 'C' string suitable for a BSON key.rz*BSON keys must not contain a NUL characterrr)r/rrr|r|r} _make_namesr)namerrrrtcCsd|t|S)zEncode a float.r^) _PACK_FLOATrrrrr|r|r} _encode_floatsrcCsd|tt|d|S)zEncode a python bytes.rbr) _PACK_INTrrr|r|r} _encode_bytessr)rr check_keysrrtcsTt|rd||jSdfdd|D}d|tt|d|dS)zEncode a mapping type.r`rcsg|]\}}t||qSr|)_element_to_bson)rrvalrrr|r} sz#_encode_mapping..rr)r%rawjoinitemsrrrrrrrsr|rr}_encode_mappingsr cCstd|d}t|d}|td|j||7}|td|j||7}|jdk rb|td|j||7}|jD]\}}|t||||7}ql|d7}t t|||||d<t |S) zEncode bson.dbref.DBRef.r`srs$refs$idNs$dbr) rxr_name_value_to_bsonridZdatabaseZ_DBRef__kwargsr rrrw)rrrrbufbeginrrr|r|r} _encode_dbrefs  rcsBtdfdd|D}d|tt|d|dS)zEncode a list/tuple.rcsg|]}tt|qSr|)r r)ritemrlnamerr|r}rsz _encode_list..rarr)rUr rrr r|rr} _encode_listsrcCs,t|d}d|tt|d|dS)zEncode a python str.rr_rr)rrr)rrrrZbvaluer|r|r} _encode_texts rcCs8|j}|dkrtt||}d|tt|||S)zEncode bson.binary.Binary.rrb)rrr_PACK_LENGTH_SUBTYPE)rrrrrr|r|r}_encode_binarysr)rrrrrtcCs"|j}tj||d}t||||S)zEncode uuid.UUID.)r)rrZ from_uuidr)rrrrrZbinvalr|r|r} _encode_uuidsr)rrrrrtcCsd||jS)zEncode bson.objectid.ObjectId.rd)binary)rrrrr|r|r}_encode_objectidsrcCsd||rdpdS)z%Encode a python boolean (True/False).rer^rr|rr|r|r} _encode_boolsrcCst|}d|t|SzEncode datetime.datetime.rf)r) _PACK_LONGrrrrZmillisr|r|r}_encode_datetimesr cCst|}d|t|Sr)intrrr|r|r}_encode_datetime_mssr")rrrrrtcCsd|S)zEncode python None.rgr|rrrrr|r|r} _encode_nonesr$cCs|j}|tjkr&d|t|jdS|dkrDd|t|jdSd}|tj@rZ|d7}|tj@rl|d7}|tj@r~|d7}|tj@r|d 7}|tj@r|d 7}|tj @r|d 7}|d7}d|t|j|Sd S) z*Encode a python regex or bson.regex.Regex.rhsurrrilmsuxN) flagsreUNICODErr IGNORECASELOCALE MULTILINEDOTALLVERBOSE)rrrrr+Zsflagsr|r|r} _encode_regexs(       r3cCsnt|}t|}|jdkr.d|t||St|jd|d}td|t|}d||t|||S)zEncode bson.code.Code.NrjFrrl)rrrr _dict_to_bson)rrrrZcstringZcstrlenrZ full_lengthr|r|r} _encode_codes r5cCs^d|krdkr(nnd|t|Szd|t|WStjk rXtdYnXdS)zEncode a python int.iirmro&BSON can only handle up to 8-byte intsN)rrrr OverflowErrorrr|r|r} _encode_ints r8cCsd|t|j|jS)z Encode bson.timestamp.Timestamp.rn)_PACK_TIMESTAMPrtimerr|r|r}_encode_timestamp*sr;cCs6zd|t|WStjk r0tdYnXdS)zEncode a bson.int64.Int64.ror6N)rrrr7rr|r|r} _encode_long/sr<cCsd||jS)z"Encode bson.decimal128.Decimal128.rp)bidrr|r|r}_encode_decimal1287sr>cCsd|S)zEncode bson.min_key.MinKey.rqr|r#r|r|r}_encode_minkey<sr?cCsd|S)zEncode bson.max_key.MaxKey.rrr|r#r|r|r}_encode_maxkeyAsr@) r dccs|] }|VqdSrur|)rtr|r|r}rvs)rrrrin_custom_callin_fallback_callrtc Csfd}ztt|||||WStk r0Yn$tk rRt|tsJd}YnXt|dd}t|tr|tkrt|}|tt|<|||||S|s|jj r|jj t|} | dk rt || |||ddSt D]8} |st|| rt| }|tt|<|||||Sq|jj } |s<| dk rd|kr>|td|d|||D](\}}|rZ|dkrF|t||||qFWn"tk rt d|YnXd |}t t |d|dS)zEncode a document to BSON.Z_ids_idz)encoder expected a mapping type but got: rrr) r%rrwrrr r rAttributeError TypeErrorr rr)rVrrrWelementsrrencodedr|r|r}r4s    r4z1codec_options must be an instance of CodecOptions)documentr codec_optionsrtcCst|tstt|||S)aEncode a document to BSON. A document can be any mapping type (like :class:`dict`). Raises :class:`TypeError` if `document` is not a mapping type, or contains keys that are not instances of :class:`str`. Raises :class:`~bson.errors.InvalidDocument` if `document` cannot be converted to :class:`BSON`. :Parameters: - `document`: mapping type representing a document - `check_keys` (optional): check if keys start with '$' or contain '.', raising :class:`~bson.errors.InvalidDocument` in either case - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. .. versionadded:: 3.9 )rvr#_CODEC_OPTIONS_TYPE_ERRORr4)r\rr]r|r|r}rVs r=)rsr]rtcCsdSrur|rsr]r|r|r}rWsCodecOptions[_DocumentType]r<cCsdSrur|r_r|r|r}rWsz%Optional[CodecOptions[_DocumentType]]cCs |pt}t|tstt||S)aDecode BSON to a document. By default, returns a BSON document represented as a Python :class:`dict`. To use a different :class:`MutableMapping` class, configure a :class:`~bson.codec_options.CodecOptions`:: >>> import collections # From Python standard library. >>> import bson >>> from bson.codec_options import CodecOptions >>> data = bson.encode({'a': 1}) >>> decoded_doc = bson.decode(data) >>> options = CodecOptions(document_class=collections.OrderedDict) >>> decoded_doc = bson.decode(data, codec_options=options) >>> type(decoded_doc) :Parameters: - `data`: the BSON to decode. Any bytes-like object that implements the buffer protocol. - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. .. versionadded:: 3.9 )r"rvr#r^r)rsr]rr|r|r}rWs zList[_DocumentType]c Cst|\}}t|}g}d}|d}t|j}z||krt||d}|||krZtd||d} || dkrztd|r||||| d|n|t|||d| |||7}q0|WStk rYn6tk rt \} } } tt |  | YnXdS)z)Decode a BSON data to multiple documents.rrzinvalid object sizerrN) rTrr%rrr.rrrrrrr) rsrr{Zdata_lenZdocsrrZuse_rawrrrrrr|r|r} _decode_all1s0       razList[Dict[str, Any]]cCsdSrur|r_r|r|r}rXUscCsdSrur|r_r|r|r}rXZsz0Union[List[Dict[str, Any]], List[_DocumentType]]cCs*|dkrt|tSt|ts tt||S)aEDecode BSON data to multiple documents. `data` must be a bytes-like object implementing the buffer protocol that provides concatenated, valid, BSON-encoded documents. :Parameters: - `data`: BSON data - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. .. versionchanged:: 3.9 Supports bytes-like objects that implement the buffer protocol. .. versionchanged:: 3.0 Removed `compile_re` option: PyMongo now always represents BSON regular expressions as :class:`~bson.regex.Regex` objects. Use :meth:`~bson.regex.Regex.try_compile` to attempt to convert from a BSON regular expression to a Python regular expression object. Replaced `as_class`, `tz_aware`, and `uuid_subtype` options with `codec_options`. N)rar"rvr#r^r_r|r|r}rXas   )rawdocfieldsr]rtcCsvt|jri}n|}|D]P\}}||krh||dkrRt|j||||<qpt||||||<q |||<q |S)Nr)r%rr rr_decode_selective)rbrcr]rVrrr|r|r}rds   rd)r{rtcCsd}t||t|\}}|d7}g}|j}||dkr||dkrL|d7}q6|d7}t|||\}}|||||||7}q*||krtdd|S)Nrrrrr)rrrr.r )r{rrrbuffersrrr|r|r}_array_of_documents_to_buffers    rf)r\rtcCsP|d}|sdSdD]4}||}|s*qt|}|rB|g||<qg||<qdS)z=Convert raw array of documents to a stream of BSON documents.cursorN)Z firstBatchZ nextBatch)rrf)r\rgrbatchrsr|r|r}&_convert_raw_document_lists_to_streamss   ri)rsr]rcrtcCsZ|jjst||S|s(t||jddSddlm}|j|dd}t||}t|||gS)aDecode BSON data to a single document while using user-provided custom decoding logic. `data` must be a string representing a valid, BSON-encoded document. :Parameters: - `data`: BSON data - `codec_options`: An instance of :class:`~bson.codec_options.CodecOptions` with user-specified type decoders. If no decoders are found, this method is the same as ``decode_all``. - `fields`: Map of document namespaces where data that needs to be custom decoded lives or None. For example, to custom decode a list of objects in 'field1.subfield1', the specified value should be ``{'field1': {'subfield1': 1}}``. If ``fields`` is an empty map or None, this method is the same as ``decode_all``. :Returns: - `document_list`: Single-member list containing the decoded document. .. versionadded:: 3.8 N)rr)RawBSONDocument)rr)rrrXZ with_optionsZ bson.raw_bsonrjrrd)rsr]rcrjZinternal_codec_options_docr|r|r}_decode_all_selectives    rlzIterator[Dict[str, Any]]cCsdSrur|r_r|r|r}rYszIterator[_DocumentType]cCsdSrur|r_r|r|r}rYsz8Union[Iterator[Dict[str, Any]], Iterator[_DocumentType]]ccsf|pt}t|tstd}t|d}||krbt||d}||||}||7}t||Vq&dS)aDecode BSON data to multiple documents as a generator. Works similarly to the decode_all function, but yields one document at a time. `data` must be a string of concatenated, valid, BSON-encoded documents. :Parameters: - `data`: BSON data - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. .. versionchanged:: 3.0 Replaced `as_class`, `tz_aware`, and `uuid_subtype` options with `codec_options`. .. versionadded:: 2.8 rrN)r"rvr#r^rrr)rsr]rrrrrZr|r|r}rYs  )file_objr]rtcCsdSrur|rmr]r|r|r}rZscCsdSrur|rnr|r|r}rZ"sccsf|pt}|d}|sqbnt|dkr.tdt|ddd}||td|}t||VqdS)a)Decode bson data from a file to multiple documents as a generator. Works similarly to the decode_all function, but reads from the file object in chunks and parses bson in chunks, yielding one document at a time. :Parameters: - `file_obj`: A file object containing BSON data. - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. .. versionchanged:: 3.0 Replaced `as_class`, `tz_aware`, and `uuid_subtype` options with `codec_options`. .. versionadded:: 2.8 rzcut off in middle of objsizerN)r"readrr.rmaxr)rmr]rZ size_datarrZr|r|r}rZ)s  )bsonrtcCs>t|tstdzt|tWdStk r8YdSXdS)aCheck that the given string represents valid :class:`BSON` data. Raises :class:`TypeError` if `bson` is not an instance of :class:`bytes`. Returns ``True`` if `bson` is valid :class:`BSON`, ``False`` otherwise. :Parameters: - `bson`: the data to be validated z4BSON data must be an instance of a subclass of bytesTFN)rvrwrYrr"r)rqr|r|r}r[Is  c@sPeZdZdZedefedeee fe e ddddZ efdddd d Z d S) r\zBSON (Binary JSON) data. .. warning:: Using this class to encode and decode BSON adds a performance cost. For better performance use the module level functions :func:`encode` and :func:`decode` instead. F)clsr\rr]rtcCs|t|||S)a@Encode a document to a new :class:`BSON` instance. A document can be any mapping type (like :class:`dict`). Raises :class:`TypeError` if `document` is not a mapping type, or contains keys that are not instances of :class:`str'. Raises :class:`~bson.errors.InvalidDocument` if `document` cannot be converted to :class:`BSON`. :Parameters: - `document`: mapping type representing a document - `check_keys` (optional): check if keys start with '$' or contain '.', raising :class:`~bson.errors.InvalidDocument` in either case - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. .. versionchanged:: 3.0 Replaced `uuid_subtype` option with `codec_options`. )rV)rrr\rr]r|r|r}rVesz BSON.encoder`r<)r]rtcCs t||S)a3Decode this BSON data. By default, returns a BSON document represented as a Python :class:`dict`. To use a different :class:`MutableMapping` class, configure a :class:`~bson.codec_options.CodecOptions`:: >>> import collections # From Python standard library. >>> import bson >>> from bson.codec_options import CodecOptions >>> data = bson.BSON.encode({'a': 1}) >>> decoded_doc = bson.BSON(data).decode() >>> options = CodecOptions(document_class=collections.OrderedDict) >>> decoded_doc = bson.BSON(data).decode(codec_options=options) >>> type(decoded_doc) :Parameters: - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. .. versionchanged:: 3.0 Removed `compile_re` option: PyMongo now always represents BSON regular expressions as :class:`~bson.regex.Regex` objects. Use :meth:`~bson.regex.Regex.try_compile` to attempt to convert from a BSON regular expression to a Python regular expression object. Replaced `as_class`, `tz_aware`, and `uuid_subtype` options with `codec_options`. )rW)selfr]r|r|r}rWsz BSON.decodeN)__name__ __module__ __qualname____doc__ classmethodr"rrrrboolr#rVrWr|r|r|r}r\]s cCstS)zIs the C extension installed?)_USE_Cr|r|r|r}r]scCstjrtjdS)z!Releases the ObjectID lock child.N)r7Z _inc_locklockedreleaser|r|r|r} _after_forks r}register_at_fork)after_in_child)F)F)F)NF)FF)T)N)N)N)N)N)N)N)N)rwdatetimerosr,rruuidcodecsrrrr collectionsr_abctypingrrrrr r r r r rrrrrrrrrrrZ bson.binaryrrrrrrrr Z bson.coder!Zbson.codec_optionsr"r#r$r%Zbson.datetime_msr&r'r(r)r*r+Z bson.dbrefr,Zbson.decimal128r-Z bson.errorsr.r/r0Z bson.int64r1Z bson.max_keyr3Z bson.min_keyr5Z bson.objectidr7Z bson.regexr8Zbson.sonr9r:Zbson.timestampr;Z bson.typingsr<r=rqr>rz ImportError__all__r?r@rArBrCrDrErFrGrHrIrJrKrLrMrNrOrPrQrRrSStruct unpack_fromrunpackZ _UNPACK_INTrrrrryrTr!rrrrfloatrrrrrUUIDrrryrrrrrrrrrrr__annotations__rrrrrpackrrrrr9tuplerangerrwrUrrrrrr rrrrrrrr r"r$r3r5r8r;r<r>r?r@dictlistrrLrNrOr rr4rYr^rVrWrarXrdrfrirlrYrZr[r\r]r}hasattrr~r|r|r|r}s,)   X(            ?            + &          $              D  "$ ""-$    G