h7dZddlZddlZddlmZddlmZddlmZmZm Z m Z ddl m Z m Z mZdZdZGd d eZGd d eZGd deeZGddeZeddZGddeZee j0ZdZy)z(Tools for specifying BSON codec options.N)abstractmethod) namedtuple)ABCabcabstractproperty string_type)UuidRepresentationALL_UUID_REPRESENTATIONSUUID_REPRESENTATION_NAMESec.t|dd}|tk(S)z9Determine if a document_class is a RawBSONDocument class. _type_markerN)getattr_RAW_BSON_DOCUMENT_MARKER)document_classmarkers U/var/www/html/ranktracker/api/venv/lib/python3.12/site-packages/bson/codec_options.py_raw_document_classr!s ^^T :F . ..c0eZdZdZedZedZy) 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. cy)z>> from bson.codec_options import TypeRegistry >>> type_registry = TypeRegistry([Codec1, Codec2, Codec3, ...], ... fallback_encoder) See :ref:`custom-type-type-registry` documentation for an example. :Parameters: - `type_codecs` (optional): 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. - `fallback_encoder` (optional): 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. Nc Dt|xsg|_||_i|_i|_|jt |st d|z|jD]}d}t|tr6|j|d}|j|j|j<t|tr%d}|j|j|j<|rt dtjdtjdt jd|d y) 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!rr(r,r*r"r.)r type_codecsfallback_encodercodecis_valid_codecs r__init__zTypeRegistry.__init__xs!+"34!1  ! ! -,- G$!&'''' 4E"N%-++E2!%7<7M7M!!%"3"34%-!%5:5I5I!!%//2!#,,k.B.B!**E344 4rcrddlm}|D],}t|j|sd|d|d}t |y)Nr)_BUILT_IN_TYPESzCTypeEncoders cannot change how built-in types are encoded (encoder z transforms type ))bsonrA issubclassrr8)rr=rApytypeerr_msgs rr:z#TypeRegistry._validate_type_encoders?(% )F%++V4"6+ ((  )rch|jjd|jd|jdS)Nz (type_codecs=z, fallback_encoder=rB) __class__r"r3r4rs r__repr__zTypeRegistry.__repr__s* NN # #T%7%7  " "$ %rct|t|stS|j|jk(xr4|j|jk(xr|j |j k(S)N)r9typeNotImplementedr6r5r4)rothers r__eq__zTypeRegistry.__eq__sd%d,! !""e&8&88D""e&8&88D''5+B+BB Er)NN)r"r#r$r%r?r:rIrNrrrr0r0^s244)% Err0 CodecOptionsrtz_awareuuid_representationunicode_decode_error_handlertzinfo type_registryc<eZdZdZedddddfdZdZdZdZd Z y) rOa Encapsulates 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.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 :class:`~bson.binary.UUIDLegacy` for examples using the `uuid_representation` option. :Parameters: - `document_class`: BSON documents returned in queries will be decoded to an instance of this class. Must be a subclass of :class:`~collections.MutableMapping`. Defaults to :class:`dict`. - `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``. - `uuid_representation`: The BSON representation to use when encoding and decoding instances of :class:`~uuid.UUID`. Defaults to :data:`~bson.binary.UuidRepresentation.PYTHON_LEGACY`. New applications should consider setting this to :data:`~bson.binary.UuidRepresentation.STANDARD` for cross language compatibility. See :ref:`handling-uuid-data-example` for details. - `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', and 'ignore'. Defaults to 'strict'. - `tzinfo`: A :class:`~datetime.tzinfo` subclass that specifies the timezone to/from which :class:`~datetime.datetime` objects should be encoded/decoded. - `type_registry`: Instance of :class:`TypeRegistry` used to customize encoding and decoding behavior. .. 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. FNstrictc t|tjst|s t dt |t s t d|tj}n|tvr tdt |tdfs td|2t |tjs t d|s td|xs t}t |ts t dtj!|||||||fS)Nztdocument_class must be dict, bson.son.SON, bson.raw_bson.RawBSONDocument, or a sublass of collections.MutableMappingztz_aware must be True or FalsezGuuid_representation must be a value from bson.binary.UuidRepresentationz5unicode_decode_error_handler must be a string or Nonez-tzinfo must be an instance of datetime.tzinfoz8cannot specify tzinfo without also setting tz_aware=Truez1type_registry must be an instance of TypeRegistry)rDrMutableMappingrr8r9boolr PYTHON_LEGACYr ValueErrorrdatetimerTr0tuple__new__)clsrrQrRrSrTrUs rr_zCodecOptions.__new__s$ >3+=+=>#N3DE E(D)<= =  &"4"B"B  (@ @CD D6d8KL'( (  fhoo6CEE NPP&7 -6OP P}} .(,?. GH Hrc  |jturdnt|j}tj|j |j }d|d|j d|d|jd|jd|j S)z;Representation of the arguments used to create this object.dictzdocument_class=z , tz_aware=z, uuid_representation=z, unicode_decode_error_handler=z , tzinfo=z, type_registry=) rrbreprr getrRrQrSrTrU)rdocument_class_repr uuid_rep_reprs r_arguments_reprzCodecOptions._arguments_reprsz))T1Fd))* 255d6N6N6:6N6NP %dmm]22DKK## % &rc|j|j|j|j|j|j dS)z7Dictionary of the arguments used to create this object.rPrPrs r _options_dictzCodecOptions._options_dict*s@#11 #'#;#;,0,M,Mkk!// 1 1rcV|jjd|jdS)N(rB)rHr"rgrs rrIzCodecOptions.__repr__5s >>22D4H4H4JKKrc Z|j}|j|tdi|S)ahMake 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 r)riupdaterO)rkwargsoptss r with_optionszCodecOptions.with_options8s,!!# F#d##r) r"r#r$r%rbr_rgrirIrprrrrOrOs8DL%)$(-54 #HJ& 1L$r)rRc nt|jdtj|jdtj|jd|jdtj |jdtj |jdtjS)zParse BSON codec options.rrQuuidrepresentationrSrTrUrP)rOrdDEFAULT_CODEC_OPTIONSrrQrSrTrU)optionss r_parse_codec_optionsruMs {{ 3BBD -668#KK(<=%,[[ * ! > >&@{{8%:%A%ABkk 2@@B C Cr)r%r]warningsrr collectionsrbson.py3compatrrr bson.binaryr r r rrrr(r.objectr0 _options_baserOr[rsrurrrr|s/"BB44  /  # ( # (  [  GE6GET@A X$=X$v%*88: Cr