3 ]]$@sdZddlZddlZddlZddlZddlZddlZddlZddlm Z ddl m Z ddl m Z mZmZmZddlmZdZdd Zd d ZGd d d eZdS)zXTools for working with MongoDB `ObjectIds `_. N) SystemRandom) InvalidId)PY3bytes_from_hex string_type text_type)utcicCstd|dS)NzS%r is not a valid ObjectId, it must be a 12-byte input or a 24-character hex string)r)oidr 0/tmp/pip-build-20mum3z4/pymongo/bson/objectid.py_raise_invalid_id%sr cCs tjdS)z+Get the 5-byte random field of an ObjectId.)osurandomr r r r _random_bytes+src@seZdZdZejZejde Z e j Z eZd,ZdZd-ddZedd Zed d Zed d ZddZddZeddZeddZddZddZddZddZddZ d d!Z!d"d#Z"d$d%Z#d&d'Z$d(d)Z%d*d+Z&dS).ObjectIdzA MongoDB ObjectId. r__idNcCs>|dkr|jn(t|tr0t|dkr0||_n |j|dS)aInitialize a new ObjectId. An ObjectId is a 12-byte unique identifier consisting of: - a 4-byte value representing the seconds since the Unix epoch, - a 5-byte random value, - a 3-byte counter, starting with a random value. By default, ``ObjectId()`` creates a new unique identifier. The optional parameter `oid` can be an :class:`ObjectId`, or any 12 :class:`bytes` or, in Python 2, any 12-character :class:`str`. For example, the 12 bytes b'foo-bar-quux' do not follow the ObjectId specification but they are acceptable input:: >>> ObjectId(b'foo-bar-quux') ObjectId('666f6f2d6261722d71757578') `oid` can also be a :class:`unicode` or :class:`str` of 24 hex digits:: >>> ObjectId('0123456789ab0123456789ab') ObjectId('0123456789ab0123456789ab') >>> >>> # A u-prefixed unicode literal: >>> ObjectId(u'0123456789ab0123456789ab') ObjectId('0123456789ab0123456789ab') Raises :class:`~bson.errors.InvalidId` if `oid` is not 12 bytes nor 24 hex digits, or :class:`TypeError` if `oid` is not an accepted type. :Parameters: - `oid` (optional): a valid ObjectId. .. mongodoc:: objectids .. versionchanged:: 3.8 :class:`~bson.objectid.ObjectId` now implements the `ObjectID specification version 0.2 `_. N )_ObjectId__generate isinstancebyteslen _ObjectId__id_ObjectId__validate)selfr r r r __init__?s * zObjectId.__init__cCsB|jdk r||j}tj|j}tjdt|d}||S)a^Create a dummy ObjectId instance with a specific generation time. This method is useful for doing range queries on a field containing :class:`ObjectId` instances. .. warning:: It is not safe to insert a document containing an ObjectId generated using this method. This method deliberately eliminates the uniqueness guarantee that ObjectIds generally provide. ObjectIds generated with this method should be used exclusively in queries. `generation_time` will be converted to UTC. Naive datetime instances will be treated as though they already contain UTC. An example using this helper to get documents where ``"_id"`` was generated before January 1, 2010 would be: >>> gen_time = datetime.datetime(2010, 1, 1) >>> dummy_id = ObjectId.from_datetime(gen_time) >>> result = collection.find({"_id": {"$lt": dummy_id}}) :Parameters: - `generation_time`: :class:`~datetime.datetime` to be used as the generation time for the resulting ObjectId. Nz>Is) utcoffsetcalendartimegm timetuplestructpackint)clsgeneration_time timestampr r r r from_datetimeps   zObjectId.from_datetimec Cs2|sdSy t|dSttfk r,dSXdS)zChecks if a `oid` string is valid or not. :Parameters: - `oid`: the object id to validate .. versionadded:: 2.3 FTN)rr TypeError)r$r r r r is_valids zObjectId.is_validcCs&tj}||jkr ||_t|_|jS)z:Generate a 5-byte random number once per process. )rgetpid_pidr_ObjectId__random)r$pidr r r _randoms  zObjectId._randomc Csjtjdttj}|tj7}tj4|tjdtjdd7}tjdtdt_WdQRX||_ dS)z0Generate a new value for this ObjectId. z>IN) r!r"r#timerr. _inc_lock_inc_MAX_COUNTER_VALUEr)rr r r r Z __generates  zObjectId.__generatec Cst|tr|j|_nht|trft|dkr\yt||_Wqdttfk rXt |YqdXq|t |ntdt j t |fdS)a;Validate and use the given id for this ObjectId. Raises TypeError if id is not an instance of (:class:`basestring` (:class:`str` or :class:`bytes` in python 3), ObjectId) and InvalidId if it is not a valid ObjectId. :Parameters: - `oid`: a valid ObjectId z7id must be an instance of (bytes, %s, ObjectId), not %sN) rrbinaryrrrrr( ValueErrorr r__name__type)rr r r r Z __validates     zObjectId.__validatecCs|jS)z812-byte binary representation of this ObjectId. )r)rr r r r6szObjectId.binarycCs(tjd|jddd}tjj|tS)a A :class:`datetime.datetime` instance representing the time of generation for this :class:`ObjectId`. The :class:`datetime.datetime` is timezone aware, and represents the generation time in UTC. It is precise to the second. z>Irr0)r!unpackrdatetime fromtimestampr)rr&r r r r%s zObjectId.generation_timecCs|jS)zdreturn value of object for pickling. needed explicitly because __slots__() defined. )r)rr r r __getstate__szObjectId.__getstate__cCs>t|tr|d}n|}tr4t|tr4|jd|_n||_dS)z)explicit state set from pickling rzlatin-1N)rdictrrencoder)rvaluer r r r __setstate__s   zObjectId.__setstate__cCs trtj|jjStj|jS)N)rbinasciihexlifyrdecode)rr r r __str__szObjectId.__str__cCsdt|fS)NzObjectId('%s'))str)rr r r __repr__szObjectId.__repr__cCst|tr|j|jkStS)N)rrrr6NotImplemented)rotherr r r __eq__ s  zObjectId.__eq__cCst|tr|j|jkStS)N)rrrr6rH)rrIr r r __ne__s  zObjectId.__ne__cCst|tr|j|jkStS)N)rrrr6rH)rrIr r r __lt__s  zObjectId.__lt__cCst|tr|j|jkStS)N)rrrr6rH)rrIr r r __le__s  zObjectId.__le__cCst|tr|j|jkStS)N)rrrr6rH)rrIr r r __gt__s  zObjectId.__gt__cCst|tr|j|jkStS)N)rrrr6rH)rrIr r r __ge__$s  zObjectId.__ge__cCs t|jS)z,Get a hash value for this :class:`ObjectId`.)hashr)rr r r __hash__)szObjectId.__hash__)r)N)'r8 __module__ __qualname____doc__rr*r+rrandintr4r3 threadingLockr2rr, __slots__Z _type_markerr classmethodr'r)r.rrpropertyr6r%r=rArErGrJrKrLrMrNrOrQr r r r r0s4 1 #    r)rTrBrr;rr!rVr1randomrZ bson.errorsrZbson.py3compatrrrrZ bson.tz_utilrr4r robjectrr r r r s