Source code for mongokit.collection

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (c) 2009-2011, Nicolas Clairon
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in the
#       documentation and/or other materials provided with the distribution.
#     * Neither the name of the University of California, Berkeley nor the
#       names of its contributors may be used to endorse or promote products
#       derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from pymongo.collection import Collection as PymongoCollection
from .mongo_exceptions import MultipleResultsFound
from .cursor import Cursor

from warnings import warn


[docs]class Collection(PymongoCollection): def __init__(self, *args, **kwargs): self._documents = {} self._collections = {} super(Collection, self).__init__(*args, **kwargs) self._registered_documents = self.database.connection._registered_documents def __getattr__(self, key): if key in self._registered_documents: if not key in self._documents: self._documents[key] = self._registered_documents[key](collection=self) if hasattr(self._documents[key], "i18n") and self._documents[key].i18n: # It seems that if we want i18n, we have to call twice the constructor. # Why on earth ? I don't know and I don't have the time to investigate yet. self._documents[key]() if self._documents[key].indexes: warn('%s: Be careful, index generation is not automatic anymore.' 'You have to generate your index youself' % self._documents[key]._obj_class.__name__, DeprecationWarning) #self._documents[key].generate_index(self) return self._documents[key] else: newkey = u"%s.%s" % (self.name, key) if not newkey in self._collections: self._collections[newkey] = Collection(self.database, newkey) return self._collections[newkey] def __call__(self, *args, **kwargs): if "." not in self.__name: raise TypeError("'Collection' object is not callable. If you " "meant to call the '%s' method on a 'Database' " "object it is failing because no such method " "exists." % self.__name) name = self.__name.split(".")[-1] raise TypeError("'Collection' object is not callable. " "If you meant to call the '%s' method on a 'Collection' " "object it is failing because no such method exists.\n" "If '%s' is a Document then you may have forgotten to " "register it to the connection." % (name, name))
[docs] def find(self, *args, **kwargs): if not 'slave_okay' in kwargs and hasattr(self, 'slave_okay'): kwargs['slave_okay'] = self.slave_okay if not 'read_preference' in kwargs and hasattr(self, 'read_preference'): kwargs['read_preference'] = self.read_preference if not 'tag_sets' in kwargs and hasattr(self, 'tag_sets'): kwargs['tag_sets'] = self.tag_sets if not 'secondary_acceptable_latency_ms' in kwargs and\ hasattr(self, 'secondary_acceptable_latency_ms'): kwargs['secondary_acceptable_latency_ms'] = ( self.secondary_acceptable_latency_ms ) return Cursor(self, *args, **kwargs)
find.__doc__ = PymongoCollection.find.__doc__ + """ added by mongokit:: - `wrap` (optional): a class object used to wrap documents in the query result """
[docs] def find_and_modify(self, *args, **kwargs): obj_class = kwargs.pop('wrap', None) doc = super(Collection, self).find_and_modify(*args, **kwargs) if doc and obj_class: doc = self.collection[obj_class.__name__](doc) doc.collection = self return doc
find_and_modify.__doc__ = PymongoCollection.find_and_modify.__doc__ + """ added by mongokit:: - `wrap` (optional): a class object used to wrap documents in the query result """
[docs] def get_from_id(self, id): """ return the document which has the id """ return self.find_one({"_id": id})
[docs] def one(self, *args, **kwargs): bson_obj = self.find(*args, **kwargs) count = bson_obj.count() if count > 1: raise MultipleResultsFound("%s results found" % count) elif count == 1: return bson_obj.next()
[docs] def find_random(self): """ return one random document from the collection """ import random max = self.count() if max: num = random.randint(0, max-1) return self.find().skip(num).next()
[docs] def find_fulltext(self, search, **kwargs): """ Executes a full-text search. Additional parameters may be passed as keyword arguments. """ return self.database.command("text", self.name, search=search, **kwargs)