U d#@sdZddlZddlZddlZddlZddlZddlZddlZddlm Z ddl m Z m Z m Z mZmZddlmZddlmZdZee dd d Zed d d ZGdddZdS)z)Tools for working with MongoDB ObjectIds.N) SystemRandom)AnyNoReturnOptionalTypeUnion InvalidId)utcioidreturncCstd|dS)NzS%r is not a valid ObjectId, it must be a 12-byte input or a 24-character hex stringr)r r1/tmp/pip-unpacked-wheel-oblwsawz/bson/objectid.py_raise_invalid_id!s rr cCs tdS)z+Get the 5-byte random field of an ObjectId.)osurandomrrrr _random_bytes(src@seZdZdZeZede Z e Z eZdZdZd2eeedefddddZeedejdd d d Zeedeed d dZeedddZddddZeddddZ e!edddZ"e!ejdddZ#edddZ$eddddZ%eddd Z&edd!d"Z'eed#d$d%Z(eed#d&d'Z)eed#d(d)Z*eed#d*d+Z+eed#d,d-Z,eed#d.d/Z-e.dd0d1Z/dS)3ObjectIdzA MongoDB ObjectId.r)Z__idNr cCs>|dkr|n(t|tr0t|dkr0||_n ||dS)ayInitialize 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`. 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:`str` of 24 hex digits:: >>> ObjectId('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. .. seealso:: The MongoDB documentation on `ObjectIds `_. .. versionchanged:: 3.8 :class:`~bson.objectid.ObjectId` now implements the `ObjectID specification version 0.2 `_. N )_ObjectId__generate isinstancebyteslen _ObjectId__id_ObjectId__validateselfr rrr__init__;s & zObjectId.__init__)clsgeneration_timer cCsB|}|dk r||}t|}tdt|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. N>Is) utcoffsetcalendartimegm timetuplestructpackint)r"r#offset timestampr rrr from_datetimehs zObjectId.from_datetime)r"r r c Cs6|sdSzt|WdSttfk r0YdSXdS)zChecks if a `oid` string is valid or not. :Parameters: - `oid`: the object id to validate .. versionadded:: 2.3 FTN)rr TypeError)r"r rrris_valids zObjectId.is_validrcCs&t}||jkr ||_t|_|jS)z1Generate a 5-byte random number once per process.)rgetpid_pidr_ObjectId__random)r"pidrrr_randoms  zObjectId._randomc Csjtdtt}|t7}tj4|tdtjdd7}tjdtdt_W5QRX||_ dS)z'Generate a new value for this ObjectId.r$N) r)r*r+timerr5 _inc_lock_inc_MAX_COUNTER_VALUErrrrrZ __generates  zObjectId.__generatec Cs~t|tr|j|_nft|trht|dkr^zt||_Wqftt fk rZt |YqfXqzt |ntdt |dS)aValidate and use the given id for this ObjectId. Raises TypeError if id is not an instance of :class:`str`, :class:`bytes`, or ObjectId. Raises InvalidId if it is not a valid ObjectId. :Parameters: - `oid`: a valid ObjectId z6id must be an instance of (bytes, str, ObjectId), not N) rrbinaryrstrrrfromhexr/ ValueErrorrtyperrrrZ __validates     zObjectId.__validatecCs|jS)z/12-byte binary representation of this ObjectId.rr rrrr=szObjectId.binarycCs(td|jddd}tj|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. r$rr7)r)unpackrdatetime fromtimestampr )r r-rrrr#s zObjectId.generation_timecCs|jS)zdReturn value of object for pickling. needed explicitly because __slots__() defined. rBrCrrr __getstate__szObjectId.__getstate__)valuer cCs:t|tr|d}n|}t|tr0|d|_n||_dS)z Explicit state set from picklingrzlatin-1N)rdictr>encoder)r rHr rrr __setstate__s    zObjectId.__setstate__cCst|jSN)binasciihexlifyrdecoderCrrr__str__szObjectId.__str__cCsdt|dS)Nz ObjectId('z'))r>rCrrr__repr__szObjectId.__repr__)otherr cCst|tr|j|jkStSrLrrrr=NotImplementedr rRrrr__eq__s  zObjectId.__eq__cCst|tr|j|jkStSrLrSrUrrr__ne__s  zObjectId.__ne__cCst|tr|j|jkStSrLrSrUrrr__lt__s  zObjectId.__lt__cCst|tr|j|jkStSrLrSrUrrr__le__s  zObjectId.__le__cCst|tr|j|jkStSrLrSrUrrr__gt__ s  zObjectId.__gt__cCst|tr|j|jkStSrLrSrUrrr__ge__s  zObjectId.__ge__cCs t|jS)z,Get a hash value for this :class:`ObjectId`.)hashrrCrrr__hash__szObjectId.__hash__)N)0__name__ __module__ __qualname____doc__rr1r2rrandintr;r: threadingLockr9rr3 __slots__Z _type_markerrrr>rr! classmethodrrEr.rboolr0r5rrpropertyr=r#rGrKrPrQrVrWrXrYrZr[r+r]rrrrr-s> -" r)rarMr&rErr)rcr8randomrtypingrrrrrZ bson.errorsr Z bson.tz_utilr r;r>rrrrrrrrs