3 ]]3|@sdZddlZddlZddlZddlZddlZddlZddlZddlm Z ddl Z ddl m Z m Z m Z mZddlmZmZmZmZmZddlmZddlmZddlmZdd lmZdd lmZdd lm Z dd l!m"Z"dd l#m$Z$ddl%m&Z&m'Z'm(Z(m)Z)m*Z*ddl+m,Z,ddl-m.Z.ddl/m0Z0ej1ej2ej3ej4ej5ej6dZ7e8dddgZ9GdddZ:GdddZ;GdddeZe>Z?eZUd?d@ZVdAdBZWdCdDZXdEdFZYdGdHZZdIdJZ[dKdLZ\dMdNZ]e?fdOdPZ^dS)QaTools for using Python's :mod:`json` module with BSON documents. This module provides two helper methods `dumps` and `loads` that wrap the native :mod:`json` methods and provide explicit BSON conversion to and from JSON. :class:`~bson.json_util.JSONOptions` provides a way to control how JSON is emitted and parsed, with the default being the legacy PyMongo format. :mod:`~bson.json_util` can also generate Canonical or Relaxed `Extended JSON`_ when :const:`CANONICAL_JSON_OPTIONS` or :const:`RELAXED_JSON_OPTIONS` is provided, respectively. .. _Extended JSON: https://github.com/mongodb/specifications/blob/master/source/extended-json.rst Example usage (deserialization): .. doctest:: >>> from bson.json_util import loads >>> loads('[{"foo": [1, 2]}, {"bar": {"hello": "world"}}, {"code": {"$scope": {}, "$code": "function x() { return 1; }"}}, {"bin": {"$type": "80", "$binary": "AQIDBA=="}}]') [{u'foo': [1, 2]}, {u'bar': {u'hello': u'world'}}, {u'code': Code('function x() { return 1; }', {})}, {u'bin': Binary('...', 128)}] Example usage (serialization): .. doctest:: >>> from bson import Binary, Code >>> from bson.json_util import dumps >>> dumps([{'foo': [1, 2]}, ... {'bar': {'hello': 'world'}}, ... {'code': Code("function x() { return 1; }", {})}, ... {'bin': Binary(b"")}]) '[{"foo": [1, 2]}, {"bar": {"hello": "world"}}, {"code": {"$code": "function x() { return 1; }", "$scope": {}}}, {"bin": {"$binary": "AQIDBA==", "$type": "00"}}]' Example usage (with :const:`CANONICAL_JSON_OPTIONS`): .. doctest:: >>> from bson import Binary, Code >>> from bson.json_util import dumps, CANONICAL_JSON_OPTIONS >>> dumps([{'foo': [1, 2]}, ... {'bar': {'hello': 'world'}}, ... {'code': Code("function x() { return 1; }")}, ... {'bin': Binary(b"")}], ... json_options=CANONICAL_JSON_OPTIONS) '[{"foo": [{"$numberInt": "1"}, {"$numberInt": "2"}]}, {"bar": {"hello": "world"}}, {"code": {"$code": "function x() { return 1; }"}}, {"bin": {"$binary": {"base64": "AQIDBA==", "subType": "00"}}}]' Example usage (with :const:`RELAXED_JSON_OPTIONS`): .. doctest:: >>> from bson import Binary, Code >>> from bson.json_util import dumps, RELAXED_JSON_OPTIONS >>> dumps([{'foo': [1, 2]}, ... {'bar': {'hello': 'world'}}, ... {'code': Code("function x() { return 1; }")}, ... {'bin': Binary(b"")}], ... json_options=RELAXED_JSON_OPTIONS) '[{"foo": [1, 2]}, {"bar": {"hello": "world"}}, {"code": {"$code": "function x() { return 1; }"}}, {"bin": {"$binary": {"base64": "AQIDBA==", "subType": "00"}}}]' Alternatively, you can manually pass the `default` to :func:`json.dumps`. It won't handle :class:`~bson.binary.Binary` and :class:`~bson.code.Code` instances (as they are extended strings you can't provide custom defaults), but it will be faster as there is less recursion. .. note:: If your application does not need the flexibility offered by :class:`JSONOptions` and spends a large amount of time in the `json_util` module, look to `python-bsonjs `_ for a nice performance improvement. `python-bsonjs` is a fast BSON to MongoDB Extended JSON converter for Python built on top of `libbson `_. `python-bsonjs` works best with PyMongo when using :class:`~bson.raw_bson.RawBSONDocument`. .. versionchanged:: 2.8 The output format for :class:`~bson.timestamp.Timestamp` has changed from '{"t": , "i": }' to '{"$timestamp": {"t": , "i": }}'. This new format will be decoded to an instance of :class:`~bson.timestamp.Timestamp`. The old format will continue to be decoded to a python dict as before. Encoding to the old format is no longer supported as it was never correct and loses type information. Added support for $numberLong and $undefined - new in MongoDB 2.6 - and parsing $date in ISO-8601 format. .. versionchanged:: 2.7 Preserves order when rendering SON, Timestamp, Code, Binary, and DBRef instances. .. versionchanged:: 2.3 Added dumps and loads helpers to automatically handle conversion to and from json and supports :class:`~bson.binary.Binary` and :class:`~bson.code.Code` N)ConfigurationError) EPOCH_AWARE EPOCH_NAIVERE_TYPESON)Binary JAVA_LEGACY CSHARP_LEGACYOLD_UUID_SUBTYPE UUID_SUBTYPE)Code) CodecOptions)DBRef) Decimal128)Int64)MaxKey)MinKey)ObjectId)PY3 iteritems integer_types string_type text_type)Regex) Timestamp)utc)ilmsuxz$idz$refz$dbc@seZdZdZdZdZdS)DatetimeRepresentationrN)__name__ __module__ __qualname__LEGACY NUMBERLONGISO8601r+r+1/tmp/pip-build-20mum3z4/pymongo/bson/json_util.pyr"s   r"c@seZdZdZdZdZdS)JSONModerr#r$N)r%r&r'r(RELAXED CANONICALr+r+r+r,r-s  r-cs:eZdZdZdejdejffdd ZfddZZ S) JSONOptionsa*Encapsulates JSON options for :func:`dumps` and :func:`loads`. :Parameters: - `strict_number_long`: If ``True``, :class:`~bson.int64.Int64` objects are encoded to MongoDB Extended JSON's *Strict mode* type `NumberLong`, ie ``'{"$numberLong": "" }'``. Otherwise they will be encoded as an `int`. Defaults to ``False``. - `datetime_representation`: The representation to use when encoding instances of :class:`datetime.datetime`. Defaults to :const:`~DatetimeRepresentation.LEGACY`. - `strict_uuid`: If ``True``, :class:`uuid.UUID` object are encoded to MongoDB Extended JSON's *Strict mode* type `Binary`. Otherwise it will be encoded as ``'{"$uuid": "" }'``. Defaults to ``False``. - `json_mode`: The :class:`JSONMode` to use when encoding BSON types to Extended JSON. Defaults to :const:`~JSONMode.LEGACY`. - `document_class`: BSON documents returned by :func:`loads` will be decoded to an instance of this class. Must be a subclass of :class:`collections.MutableMapping`. Defaults to :class:`dict`. - `uuid_representation`: The BSON representation to use when encoding and decoding instances of :class:`uuid.UUID`. Defaults to :const:`~bson.binary.PYTHON_LEGACY`. - `tz_aware`: If ``True``, MongoDB Extended JSON's *Strict mode* type `Date` will be decoded to timezone aware instances of :class:`datetime.datetime`. Otherwise they will be naive. Defaults to ``True``. - `tzinfo`: A :class:`datetime.tzinfo` subclass that specifies the timezone from which :class:`~datetime.datetime` objects should be decoded. Defaults to :const:`~bson.tz_util.utc`. - `args`: arguments to :class:`~bson.codec_options.CodecOptions` - `kwargs`: arguments to :class:`~bson.codec_options.CodecOptions` .. seealso:: The specification for Relaxed and Canonical `Extended JSON`_. .. versionadded:: 3.4 .. versionchanged:: 3.5 Accepts the optional parameter `json_mode`. Fcs|jdd|d<|dr(|jdt|d<|tjtjtjfkrDtdtt|j |f||}|t jt j t j fkrxtd||_ |j t j krd|_tj|_d|_n4|j t j krd|_tj|_d|_n||_||_||_|S)Ntz_awareTtzinfoznJSONOptions.datetime_representation must be one of LEGACY, NUMBERLONG, or ISO8601 from DatetimeRepresentation.zQJSONOptions.json_mode must be one of LEGACY, RELAXED, or CANONICAL from JSONMode.F)getrr"r(r)r*rsuperr0__new__r-r.r/ json_modestrict_number_longdatetime_representation strict_uuid)clsr7r8r9r6argskwargsself) __class__r+r,r5s6    zJSONOptions.__new__cs$d|j|j|j|jtt|jfS)NzSstrict_number_long=%r, datetime_representation=%r, strict_uuid=%r, json_mode=%r, %s)r7r8r9r6r4r0_arguments_repr)r=)r>r+r,r?1s zJSONOptions._arguments_repr) r%r&r'__doc__r"r(r-r5r? __classcell__r+r+)r>r,r0s '!r0)r6T)r7r8r9cOs$|jdt}tjt||f||S)aWHelper function that wraps :func:`json.dumps`. Recursive function that handles all BSON types including :class:`~bson.binary.Binary` and :class:`~bson.code.Code`. :Parameters: - `json_options`: A :class:`JSONOptions` instance used to modify the encoding of MongoDB Extended JSON types. Defaults to :const:`DEFAULT_JSON_OPTIONS`. .. versionchanged:: 3.4 Accepts optional parameter `json_options`. See :class:`JSONOptions`. .. versionchanged:: 2.7 Preserves order when rendering SON, Timestamp, Code, Binary, and DBRef instances. json_options)popDEFAULT_JSON_OPTIONSjsondumps _json_convert)objr;r<rBr+r+r,rFls rFcs.|jdtfdd|d<tj|f||S)aHelper function that wraps :func:`json.loads`. Automatically passes the object_hook for BSON type conversion. Raises ``TypeError``, ``ValueError``, ``KeyError``, or :exc:`~bson.errors.InvalidId` on invalid MongoDB Extended JSON. :Parameters: - `json_options`: A :class:`JSONOptions` instance used to modify the decoding of MongoDB Extended JSON types. Defaults to :const:`DEFAULT_JSON_OPTIONS`. .. versionchanged:: 3.5 Parses Relaxed and Canonical Extended JSON as well as PyMongo's legacy format. Now raises ``TypeError`` or ``ValueError`` when parsing JSON type wrappers with values of the wrong type or any extra keys. .. versionchanged:: 3.4 Accepts optional parameter `json_options`. See :class:`JSONOptions`. rBcs t|S)N)object_pairs_hook)pairs)rBr+r,szloads..rI)rCrDrEloads)rr;r<r+)rBr,rLs rLc st|dst|dr.tfddt|DSt|dr^t|ttf r^tfdd|DSy t|Stk r||SXdS)z]Recursive helper method that converts BSON types so they can be converted into json. ritemsc3s |]\}}|t|fVqdS)N)rG).0kv)rBr+r, sz _json_convert..__iter__c3s|]}t|VqdS)N)rG)rNrP)rBr+r,rQsN) hasattrrr isinstancerbyteslistdefault TypeError)rHrBr+)rBr,rGs  rGcCst|j||S)N) object_hookZdocument_class)rJrBr+r+r,rIsrIcCsRd|krt|Sd|kr t|Sd|kr2t||Sd|krBt|Sd|krRt|Sd|krbt|Sd|krd|kr|t||St||Sd |krt|Sd |krt |Sd |krdSd |krt |Sd |kr|d }t |d|dSd|krt |Sd|krt |Sd|krt|Sd|kr*t|Sd|krkrHt>} t2|| |Sd"|j?iSt|t@rvd#t|iSt|tAr|S|j't(jBkrt|tCrd0|kod1knrd&t%|iSd t%|iS|j't(jkrFt|tDrFtEjF|rd'd(iStEjG|r(|dkrd)nd*} d'| iS|j't(jBkrFd't%tH|iStId+|dS)2Nz$oid)rB)r2rrz%ziz.%03drmz$datez%s%s%sz%Y-%m-%dT%H:%M:%Sz $numberLongrrrrr r!zutf-8z$regexz$optionsz$regularExpressionrprz$minKeyr#z$maxKeyz $timestamprZz$codez$scoperwz$uuidz$numberDecimalr$z $numberIntz $numberDoubleNaNInfinityz -Infinityz%r is not JSON serializable)rrrrxrxlil)JrTrstrrrGrrr8r"r*r2rrr utcoffsetdaysr microsecondsstrftimerrrZ_datetime_to_millisr(r7rrrrqre IGNORECASELOCALE MULTILINEDOTALLUNICODEVERBOSErprrr6r-rrrrtimeincr rrrr{rrUrtrur9r ryr rvrr hexrboolr/rrmathisnanisinfreprrX) rHrBoffZ tz_stringZmillisZfracsecsrqrprzr{Zrepresentationr+r+r,rWs                                rW)_r@rrrErrsysrtZpymongo.errorsrrrrrrZ bson.binaryrrr r r Z bson.coder Zbson.codec_optionsr Z bson.dbrefrZbson.decimal128rZ bson.int64rZ bson.max_keyrZ bson.min_keyrZ bson.objectidrZbson.py3compatrrrrrZ bson.regexrZbson.timestamprZ bson.tz_utilrILMSUXrn frozensetrr"r-r0r(ZLEGACY_JSON_OPTIONSrDr/ZCANONICAL_JSON_OPTIONSr.ZRELAXED_JSON_OPTIONSr*ZSTRICT_JSON_OPTIONSrFrLrGrIrYr^rdr|rarbr]r[rircrhr\rgrjrerkrfr_r`rrWr+r+r+r,js             $+W       ,  ;