-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
dbref.py
61 lines (49 loc) · 2.01 KB
/
dbref.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# 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.
"""Tools for manipulating DBRefs (references to Mongo objects)."""
import types
from objectid import ObjectId
class DBRef(object):
"""A reference to an object stored in a Mongo database.
"""
def __init__(self, collection, id):
"""Initialize a new DBRef.
Raises TypeError if collection is not an instance of (str, unicode) or
id is not an instance of ObjectId.
:Parameters:
- `collection`: the collection the object is stored in
- `id`: the value of the object's _id field
"""
if not isinstance(collection, types.StringTypes):
raise TypeError("collection must be an instance of (str, unicode)")
if not isinstance(id, ObjectId):
raise TypeError("id must be an instance of ObjectId")
if isinstance(collection, types.StringType):
collection = unicode(collection, "utf-8")
self.__collection = collection
self.__id = id
def collection(self):
"""Get this DBRef's collection as unicode.
"""
return self.__collection
def id(self):
"""Get this DBRef's _id as an ObjectId.
"""
return self.__id
def __repr__(self):
return "DBRef(" + repr(self.collection()) + ", " + repr(self.id()) + ")"
def __cmp__(self, other):
if isinstance(other, DBRef):
return cmp([self.collection(), self.id()], [other.collection(), other.id()])
return NotImplemented