o ?8\5@sdZddlZddlmZddlmZddlmZmZmZm Z ddl m Z m Z m Z dZdd ZGd d d eZGd d d eZGdddeeZGdddeZeddZGdddeZeZddZdS)z(Tools for specifying BSON codec options.N)abstractmethod) namedtuple)ABCabcabstractproperty string_type)ALL_UUID_REPRESENTATIONS PYTHON_LEGACYUUID_REPRESENTATION_NAMESecCst|dd}|tkS)z9Determine if a document_class is a RawBSONDocument class. _type_markerN)getattr_RAW_BSON_DOCUMENT_MARKER)document_classmarkerrD/var/www/html/env/lib/python3.10/site-packages/bson/codec_options.py_raw_document_class s rc@(eZdZdZeddZeddZdS) 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. cCdS)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. NcCst|pg|_||_i|_i|_|jdurt|std||jD]4}d}t|tr9| |d}|j |j|j <t|t rGd}|j |j|j<|sVtdtjt jtj|fq"dS)Nz%fallback_encoder %r is not a callableFTz5Expected an instance of %s, %s, or %s, got %r instead)list_TypeRegistry__type_codecs_fallback_encoder _encoder_map _decoder_mapcallable TypeError isinstancer_validate_type_encoderrrr#r%r$rr&)r type_codecsfallback_encodercodecis_valid_codecrrr__init__ws6     zTypeRegistry.__init__cCs:ddlm}|D]}t|j|rd||f}t|qdS)Nr)_BUILT_IN_TYPESzYTypeEncoders cannot change how built-in types are encoded (encoder %s transforms type %s))bsonr6 issubclassrr.)rr3r6pytypeerr_msgrrrr0s  z#TypeRegistry._validate_type_encodercCsd|jj|j|jfS)Nz'%s(type_codecs=%r, fallback_encoder=%r)) __class__rr)r*rrrr__repr__s zTypeRegistry.__repr__cCs6t|t|s tS|j|jko|j|jko|j|jkS)N)r/typeNotImplementedr,r+r*)rotherrrr__eq__s   zTypeRegistry.__eq__)NN)rrr r!r5r0r<r@rrrrr']s   r' CodecOptionsrtz_awareuuid_representationunicode_decode_error_handlertzinfo type_registryc@s>eZdZdZededddfddZddZd d Zd d Z dS) rAa 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.PYTHON_LEGACY`. - `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. FstrictNc Cst|tjst|stdt|tstd|tvrtdt|t dfs*td|dur>t|t j s8td|s>td|pBt }t|t sLtdt |||||||fS)Nztdocument_class must be dict, bson.son.SON, bson.raw_bson.RawBSONDocument, or a sublass of collections.MutableMappingztz_aware must be True or FalsezMuuid_representation must be a value from bson.binary.ALL_UUID_REPRESENTATIONSz5unicode_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)r8rMutableMappingrr.r/boolr ValueErrorrdatetimerFr'tuple__new__)clsrrCrDrErFrGrrrrNs6     zCodecOptions.__new__cCsD|jturdnt|j}t|j|j}d||j||j|j|j fS)z;Representation of the arguments used to create this object.dictztdocument_class=%s, tz_aware=%r, uuid_representation=%s, unicode_decode_error_handler=%r, tzinfo=%r, type_registry=%r) rrPreprr getrDrCrErFrG)rdocument_class_repr uuid_rep_reprrrr_arguments_reprszCodecOptions._arguments_reprcCsd|jj|fS)Nz%s(%s))r;rrUrrrrr<#szCodecOptions.__repr__c KsNt|d|j|d|j|d|j|d|j|d|j|d|jS)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 rrCrDrErFrG)rArRrrCrDrErFrG)rkwargsrrr with_options&s     zCodecOptions.with_options) rrr r!rPr rNrUr<rWrrrrrAsC " c CsPt|dtj|dtj|dtj|dtj|dtj|dtjdS)zParse BSON codec options.rrCuuidrepresentationrErFrGrB) rArRDEFAULT_CODEC_OPTIONSrrCrDrErFrG)optionsrrr_parse_codec_options@s& r[)r!rLrr collectionsrbson.py3compatrrr bson.binaryrr r rrrr#r&objectr' _options_baserArYr[rrrrs(  J