o 'hM@slUdZddlmZddlZddlZddlZddlmZddl m Z m Z m Z m Z mZmZmZmZmZmZmZmZddlmZmZmZddlmZdZd$d dZGdddejZGdddejZ Gdddee Z!eee e!fZ"e e ge fZ#GdddZ$Gddde%ej&Z'GdddeZ(e rGdddeee eZ)nGddde(Z)e)Z*de+d<d%d"d#Z,dS)&z(Tools for specifying BSON codec options.) annotationsN)MutableMapping) TYPE_CHECKINGAnyCallableGenericIterableMapping NamedTupleOptionalTupleTypeUnioncast)ALL_UUID_REPRESENTATIONSUUID_REPRESENTATION_NAMESUuidRepresentation) _DocumentTypeedocument_classrreturnboolcCst|dd}|tkS)z9Determine if a document_class is a RawBSONDocument class. _type_markerN)getattr_RAW_BSON_DOCUMENT_MARKER)rmarkerrN/var/www/html/olx_land/venv/lib/python3.10/site-packages/bson/codec_options.py_raw_document_class/s rc@0eZdZdZejd ddZejd ddZd S) TypeEncoderaPBase class for defining type codec classes which describe how a custom type can be transformed to one of the types BSON understands. Codec classes must implement the ``python_type`` attribute, and the ``transform_python`` method to support encoding. See :ref:`custom-type-type-codec` documentation for an example. rrcCdS)zeZdZdZ  ddd d Zdd dZdddZdddZdS) TypeRegistryaEncapsulates type codecs used in encoding and / or decoding BSON, as well as the fallback encoder. Type registries cannot be modified after instantiation. ``TypeRegistry`` can be initialized with an iterable of type codecs, and a callable for the fallback encoder:: >>> from bson.codec_options import TypeRegistry >>> type_registry = TypeRegistry([Codec1, Codec2, Codec3, ...], ... fallback_encoder) See :ref:`custom-type-type-registry` documentation for an example. :param type_codecs: iterable of type codec instances. If ``type_codecs`` contains multiple codecs that transform a single python or BSON type, the transformation specified by the type codec occurring last prevails. A TypeError will be raised if one or more type codecs modify the encoding behavior of a built-in :mod:`bson` type. :param fallback_encoder: callable that accepts a single, unencodable python value and transforms it into a type that :mod:`bson` can encode. See :ref:`fallback-encoder-callable` documentation for an example. N type_codecsOptional[Iterable[_Codec]]fallback_encoderOptional[_Fallback]rNonec Cst|pg|_||_i|_i|_|jdurt|std||jD];}d}t|tr9| |d}|j |j|j <t|t rGd}|j |j|j<|s]tdtjdt jdtjd|d q"dS) Nz%fallback_encoder %r is not a callableFTzExpected an instance of z, z, or z, got z instead)list_TypeRegistry__type_codecs_fallback_encoder _encoder_map _decoder_mapcallable TypeError isinstancer _validate_type_encoderr(r$r3r5r4r+r6)r#r8r:codecis_valid_codecrrr__init__s,      "zTypeRegistry.__init__rF_CodeccCsFddlm}|D]}ttt|j|r d|d|d}t|qdS)Nr)_BUILT_IN_TYPESzCTypeEncoders cannot change how built-in types are encoded (encoder z transforms type ))bsonrJ issubclassrr6r$rC)r#rFrJpytypeerr_msgrrrrEs z#TypeRegistry._validate_type_encoderstrcCsd|jj|j|jS)Nz+{}(type_codecs={!r}, fallback_encoder={!r}))format __class__r+r>r?r"rrr__repr__s zTypeRegistry.__repr__otherrcCs6t|t|s tS|j|jko|j|jko|j|jkSN)rDtypeNotImplementedrAr@r?)r#rTrrr__eq__s   zTypeRegistry.__eq__)NN)r8r9r:r;rr<)rFrIrr<rrP)rTrrr)r+r,r-r.rHrErSrXrrrrr7ms  r7c@s&eZdZdZdZ dZ dZ dZdS)DatetimeConversionz$Options for decoding BSON datetimes.N)r+r,r-r.DATETIMEDATETIME_CLAMP DATETIME_MS DATETIME_AUTOrrrrrZs rZc@sFeZdZUded<ded<ded<ded<d ed <d ed <d ed<dS)_BaseCodecOptionszType[Mapping[str, Any]]rrtz_awareintuuid_representationrPunicode_decode_error_handlerOptional[datetime.tzinfo]tzinfor7 type_registryOptional[DatetimeConversion]datetime_conversionN)r+r,r-__annotations__rrrrrcs  rcc@seZdZUded<ded<ded<ded<d ed <d ed <d ed<       d0d1ddZd2ddZd3ddZd4d!d"Zed5d%d&Z d6d(d)Z d7d*d+Z ded,<d-ed.<d/S)8 CodecOptionszType[_DocumentType]rrrdrerf Optional[str]rgrhrir7rj Optional[int]rl.cls!Type[CodecOptions[_DocumentType]]Optional[Type[_DocumentType]]Optional[TypeRegistry]rCodecOptions[_DocumentType]cCdSrUr)rqrrdrfrgrirjrlrrr__new__s CodecOptions.__new__kwargsrCodecOptions[Any]cKrvrUrr#ryrrr with_optionsCodecOptions.with_optionsrPcCrvrUrr"rrr_arguments_reprr}CodecOptions._arguments_reprdict[Any, Any]cCrvrUrr"rrr _options_dict r}CodecOptions._options_dictobj Iterable[Any]cCrvrUr)rqrrrr_makeszCodecOptions._makedict[str, Any]cCrvrUrr"rrr_asdictr}zCodecOptions._asdictcKrvrUrr{rrr_replacer}zCodecOptions._replace_sourcez Tuple[str]_fieldsN).......)rqrrrrsrdrrfrprgrorirhrjrtrlrprru)ryrrrzrY)rr)rrrrurr)ryrrru) r+r,r-rmrwr|rr classmethodrrrrrrrrns2       rncsfeZdZdZfddZddejdddejfd%ddZ d&ddZ d'ddZ d&dd Z d(d#d$Z ZS))rnz:Encapsulates options used encoding and / or decoding BSON.cstdS)aEncapsulates options used encoding and / or decoding BSON. The `document_class` option is used to define a custom type for use decoding BSON documents. Access to the underlying raw BSON bytes for a document is available using the :class:`~bson.raw_bson.RawBSONDocument` type:: >>> from bson.raw_bson import RawBSONDocument >>> from bson.codec_options import CodecOptions >>> codec_options = CodecOptions(document_class=RawBSONDocument) >>> coll = db.get_collection('test', codec_options=codec_options) >>> doc = coll.find_one() >>> doc.raw '\x16\x00\x00\x00\x07_id\x00[0\x165\x91\x10\xea\x14\xe8\xc5\x8b\x93\x00' The document class can be any type that inherits from :class:`~collections.abc.MutableMapping`:: >>> class AttributeDict(dict): ... # A dict that supports attribute access. ... def __getattr__(self, key): ... return self[key] ... def __setattr__(self, key, value): ... self[key] = value ... >>> codec_options = CodecOptions(document_class=AttributeDict) >>> coll = db.get_collection('test', codec_options=codec_options) >>> doc = coll.find_one() >>> doc._id ObjectId('5b3016359110ea14e8c58b93') See :doc:`/examples/datetimes` for examples using the `tz_aware` and `tzinfo` options. See :doc:`/examples/uuid` for examples using the `uuid_representation` option. :param document_class: BSON documents returned in queries will be decoded to an instance of this class. Must be a subclass of :class:`~collections.abc.MutableMapping`. Defaults to :class:`dict`. :param tz_aware: If ``True``, BSON datetimes will be decoded to timezone aware instances of :class:`~datetime.datetime`. Otherwise they will be naive. Defaults to ``False``. :param uuid_representation: The BSON representation to use when encoding and decoding instances of :class:`~uuid.UUID`. Defaults to :data:`~bson.binary.UuidRepresentation.UNSPECIFIED`. New applications should consider setting this to :data:`~bson.binary.UuidRepresentation.STANDARD` for cross language compatibility. See :ref:`handling-uuid-data-example` for details. :param unicode_decode_error_handler: The error handler to apply when a Unicode-related error occurs during BSON decoding that would otherwise raise :exc:`UnicodeDecodeError`. Valid options include 'strict', 'replace', 'backslashreplace', 'surrogateescape', and 'ignore'. Defaults to 'strict'. :param tzinfo: A :class:`~datetime.tzinfo` subclass that specifies the timezone to/from which :class:`~datetime.datetime` objects should be encoded/decoded. :param type_registry: Instance of :class:`TypeRegistry` used to customize encoding and decoding behavior. :param datetime_conversion: Specifies how UTC datetimes should be decoded within BSON. Valid options include 'datetime_ms' to return as a DatetimeMS, 'datetime' to return as a datetime.datetime and raising a ValueError for out-of-range values, 'datetime_auto' to return DatetimeMS objects when the underlying datetime is out-of-range and 'datetime_clamp' to clamp to the minimum and maximum possible datetimes. Defaults to 'datetime'. .. versionchanged:: 4.0 The default for `uuid_representation` was changed from :const:`~bson.binary.UuidRepresentation.PYTHON_LEGACY` to :const:`~bson.binary.UuidRepresentation.UNSPECIFIED`. .. versionadded:: 3.8 `type_registry` attribute. .. warning:: Care must be taken when changing `unicode_decode_error_handler` from its default value ('strict'). The 'replace' and 'ignore' modes should not be used when documents retrieved from the server will be modified in the client application and stored back to the server. N)superrH)r#argsryrRrrrH sRzCodecOptions.__init__NFstrictrqType[CodecOptions]r!Optional[Type[Mapping[str, Any]]]rdrrfrprgrPrirhrjrtrlrkrc Cs|pt}d} zt|t} Wnty!t|drt|jt} Ynw| s,t|s,tdt|ts8td||t vr@t dt|t sNt dt ||durgt|t jsatdt ||sgt d|pkt}t|tsztd t |t||||||||fS) NF __origin__zydocument_class must be dict, bson.son.SON, bson.raw_bson.RawBSONDocument, or a subclass of collections.abc.MutableMappingz.tz_aware must be True or False, was: tz_aware=zGuuid_representation must be a value from bson.binary.UuidRepresentationz3unicode_decode_error_handler must be a string, not z3tzinfo must be an instance of datetime.tzinfo, not z8cannot specify tzinfo without also setting tz_aware=Truez7type_registry must be an instance of TypeRegistry, not )dictrM_MutableMappingrChasattrrrrDrr ValueErrorrPrVdatetimerir7tuplerw) rqrrdrfrgrirjrl doc_class is_mappingrrrrwts\             rxc CsH|jturdnt|j}t|j|j}d||j||j|j |j |j S)z;Representation of the arguments used to create this object.rzdocument_class={}, tz_aware={!r}, uuid_representation={}, unicode_decode_error_handler={!r}, tzinfo={!r}, type_registry={!r}, datetime_conversion={!s}) rrreprrgetrfrQrdrgrirjrl)r#document_class_repr uuid_rep_reprrrrrs rrcCs"|j|j|j|j|j|j|jdS)z7Dictionary of the arguments used to create this object.rrdrfrgrirjrlrr"rrrrsrcCs|jjd|dS)N(rK)rRr+rr"rrrrSszCodecOptions.__repr__ryrcKs |}||tdi|S)aMake a copy of this CodecOptions, overriding some options:: >>> from bson.codec_options import DEFAULT_CODEC_OPTIONS >>> DEFAULT_CODEC_OPTIONS.tz_aware False >>> options = DEFAULT_CODEC_OPTIONS.with_options(tz_aware=True) >>> options.tz_aware True .. versionadded:: 3.5 Nr)rupdatern)r#ryoptsrrrr|s r~)rqrrrrdrrfrprgrPrirhrjrtrlrkrrnrYr)ryrrrn)r+r,r-r.rHr UNSPECIFIEDrZr_rwrrrSr| __classcell__rrrrrns V ?  zCodecOptions[dict[str, Any]]DEFAULT_CODEC_OPTIONSoptionsrzcCsJi}t|hd@D]}|dkr|||d<q ||||<q tdi|S)zParse BSON codec options.>rirdrjruuidrepresentationrlrgrrfNr)setrn)rrykrrr_parse_codec_optionss  r)rrrr)rrrrz)-r. __future__rr/renumcollections.abcrrtypingrrrrrr r r r r rr bson.binaryrrr bson.typingsrrrABCr r3r6rI _Fallbackr7reEnumrZrcrnrrmrrrrrs2  8  R# /P