97 lines
2.9 KiB
Python
97 lines
2.9 KiB
Python
# Copyright 2009 10gen, Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""Representation of an ObjectId for Mongo."""
|
|
|
|
import random
|
|
import types
|
|
from errors import InvalidId
|
|
|
|
class ObjectId(object):
|
|
"""A Mongo ObjectId.
|
|
"""
|
|
def __init__(self, id=None):
|
|
"""Initialize a new ObjectId.
|
|
|
|
If no value of id is given, create a new (unique) ObjectId. If given id
|
|
is an instance of (string, ObjectId) validate it and use that.
|
|
Otherwise, a TypeError is raised. If given an invalid id, InvalidId is
|
|
raised.
|
|
|
|
:Parameters:
|
|
- `id` (optional): a valid ObjectId
|
|
"""
|
|
if id is None:
|
|
self.__generate()
|
|
else:
|
|
self.__validate(id)
|
|
|
|
def __generate(self):
|
|
"""Generate a new value for this ObjectId.
|
|
"""
|
|
oid = ""
|
|
for _ in range(12):
|
|
oid += chr(random.randint(0, 255))
|
|
|
|
self.__id = oid
|
|
|
|
def __validate(self, oid):
|
|
"""Validate and use the given id for this ObjectId.
|
|
|
|
Raises TypeError if id is not an instance of (str, ObjectId) and
|
|
InvalidId if it is not a valid ObjectId.
|
|
|
|
:Parameters:
|
|
- `oid`: a valid ObjectId
|
|
"""
|
|
if isinstance(oid, ObjectId):
|
|
self.__id = oid.__id
|
|
elif isinstance(oid, types.StringType):
|
|
if len(oid) == 12:
|
|
self.__id = oid
|
|
else:
|
|
raise InvalidId("%s is not a valid ObjectId" % oid)
|
|
else:
|
|
raise TypeError("id must be an instance of (str, ObjectId), not %s" % type(oid))
|
|
|
|
def url_encode(self):
|
|
"""Get a string representation of this ObjectId safe for use in a url.
|
|
|
|
The reverse can be achieved using `url_decode()`.
|
|
"""
|
|
return self.__id.encode("hex")
|
|
|
|
def url_decode(cls, encoded_oid):
|
|
"""Create an ObjectId from an encoded hex string.
|
|
|
|
The reverse can be achieved using `url_encode()`.
|
|
|
|
:Parameters:
|
|
- `encoded_oid`: string encoding of an ObjectId (as created
|
|
by `url_encode()`)
|
|
"""
|
|
return cls(encoded_oid.decode("hex"))
|
|
url_decode = classmethod(url_decode)
|
|
|
|
def __str__(self):
|
|
return self.__id
|
|
|
|
def __repr__(self):
|
|
return "ObjectId(%r)" % self.__id
|
|
|
|
def __cmp__(self, other):
|
|
if isinstance(other, ObjectId):
|
|
return cmp(self.__id, other.__id)
|
|
return NotImplemented
|