| 1 |
from django.db.models.query import QuerySet, EmptyQuerySet |
|---|
| 2 |
from django.dispatch import dispatcher |
|---|
| 3 |
from django.db.models import signals |
|---|
| 4 |
from django.db.models.fields import FieldDoesNotExist |
|---|
| 5 |
|
|---|
| 6 |
# Size of each "chunk" for get_iterator calls. |
|---|
| 7 |
# Larger values are slightly faster at the expense of more storage space. |
|---|
| 8 |
GET_ITERATOR_CHUNK_SIZE = 100 |
|---|
| 9 |
|
|---|
| 10 |
def ensure_default_manager(sender): |
|---|
| 11 |
cls = sender |
|---|
| 12 |
if not hasattr(cls, '_default_manager'): |
|---|
| 13 |
# Create the default manager, if needed. |
|---|
| 14 |
try: |
|---|
| 15 |
cls._meta.get_field('objects') |
|---|
| 16 |
raise ValueError, "Model %s must specify a custom Manager, because it has a field named 'objects'" % cls.__name__ |
|---|
| 17 |
except FieldDoesNotExist: |
|---|
| 18 |
pass |
|---|
| 19 |
cls.add_to_class('objects', Manager()) |
|---|
| 20 |
|
|---|
| 21 |
dispatcher.connect(ensure_default_manager, signal=signals.class_prepared) |
|---|
| 22 |
|
|---|
| 23 |
class Manager(object): |
|---|
| 24 |
# Tracks each time a Manager instance is created. Used to retain order. |
|---|
| 25 |
creation_counter = 0 |
|---|
| 26 |
|
|---|
| 27 |
def __init__(self): |
|---|
| 28 |
super(Manager, self).__init__() |
|---|
| 29 |
# Increase the creation counter, and save our local copy. |
|---|
| 30 |
self.creation_counter = Manager.creation_counter |
|---|
| 31 |
Manager.creation_counter += 1 |
|---|
| 32 |
self.model = None |
|---|
| 33 |
|
|---|
| 34 |
def contribute_to_class(self, model, name): |
|---|
| 35 |
# TODO: Use weakref because of possible memory leak / circular reference. |
|---|
| 36 |
self.model = model |
|---|
| 37 |
setattr(model, name, ManagerDescriptor(self)) |
|---|
| 38 |
if not hasattr(model, '_default_manager') or self.creation_counter < model._default_manager.creation_counter: |
|---|
| 39 |
model._default_manager = self |
|---|
| 40 |
|
|---|
| 41 |
####################### |
|---|
| 42 |
# PROXIES TO QUERYSET # |
|---|
| 43 |
####################### |
|---|
| 44 |
|
|---|
| 45 |
def get_empty_query_set(self): |
|---|
| 46 |
return EmptyQuerySet(self.model) |
|---|
| 47 |
|
|---|
| 48 |
def get_query_set(self): |
|---|
| 49 |
"""Returns a new QuerySet object. Subclasses can override this method |
|---|
| 50 |
to easily customise the behaviour of the Manager. |
|---|
| 51 |
""" |
|---|
| 52 |
return QuerySet(self.model) |
|---|
| 53 |
|
|---|
| 54 |
def none(self): |
|---|
| 55 |
return self.get_empty_query_set() |
|---|
| 56 |
|
|---|
| 57 |
def all(self): |
|---|
| 58 |
return self.get_query_set() |
|---|
| 59 |
|
|---|
| 60 |
def count(self): |
|---|
| 61 |
return self.get_query_set().count() |
|---|
| 62 |
|
|---|
| 63 |
def dates(self, *args, **kwargs): |
|---|
| 64 |
return self.get_query_set().dates(*args, **kwargs) |
|---|
| 65 |
|
|---|
| 66 |
def distinct(self, *args, **kwargs): |
|---|
| 67 |
return self.get_query_set().distinct(*args, **kwargs) |
|---|
| 68 |
|
|---|
| 69 |
def extra(self, *args, **kwargs): |
|---|
| 70 |
return self.get_query_set().extra(*args, **kwargs) |
|---|
| 71 |
|
|---|
| 72 |
def get(self, *args, **kwargs): |
|---|
| 73 |
return self.get_query_set().get(*args, **kwargs) |
|---|
| 74 |
|
|---|
| 75 |
def get_or_create(self, **kwargs): |
|---|
| 76 |
return self.get_query_set().get_or_create(**kwargs) |
|---|
| 77 |
|
|---|
| 78 |
def create(self, **kwargs): |
|---|
| 79 |
return self.get_query_set().create(**kwargs) |
|---|
| 80 |
|
|---|
| 81 |
def filter(self, *args, **kwargs): |
|---|
| 82 |
return self.get_query_set().filter(*args, **kwargs) |
|---|
| 83 |
|
|---|
| 84 |
def complex_filter(self, *args, **kwargs): |
|---|
| 85 |
return self.get_query_set().complex_filter(*args, **kwargs) |
|---|
| 86 |
|
|---|
| 87 |
def exclude(self, *args, **kwargs): |
|---|
| 88 |
return self.get_query_set().exclude(*args, **kwargs) |
|---|
| 89 |
|
|---|
| 90 |
def in_bulk(self, *args, **kwargs): |
|---|
| 91 |
return self.get_query_set().in_bulk(*args, **kwargs) |
|---|
| 92 |
|
|---|
| 93 |
def iterator(self, *args, **kwargs): |
|---|
| 94 |
return self.get_query_set().iterator(*args, **kwargs) |
|---|
| 95 |
|
|---|
| 96 |
def latest(self, *args, **kwargs): |
|---|
| 97 |
return self.get_query_set().latest(*args, **kwargs) |
|---|
| 98 |
|
|---|
| 99 |
def order_by(self, *args, **kwargs): |
|---|
| 100 |
return self.get_query_set().order_by(*args, **kwargs) |
|---|
| 101 |
|
|---|
| 102 |
def select_related(self, *args, **kwargs): |
|---|
| 103 |
return self.get_query_set().select_related(*args, **kwargs) |
|---|
| 104 |
|
|---|
| 105 |
def values(self, *args, **kwargs): |
|---|
| 106 |
return self.get_query_set().values(*args, **kwargs) |
|---|
| 107 |
|
|---|
| 108 |
class ManagerDescriptor(object): |
|---|
| 109 |
# This class ensures managers aren't accessible via model instances. |
|---|
| 110 |
# For example, Poll.objects works, but poll_obj.objects raises AttributeError. |
|---|
| 111 |
def __init__(self, manager): |
|---|
| 112 |
self.manager = manager |
|---|
| 113 |
|
|---|
| 114 |
def __get__(self, instance, type=None): |
|---|
| 115 |
if instance != None: |
|---|
| 116 |
raise AttributeError, "Manager isn't accessible via %s instances" % type.__name__ |
|---|
| 117 |
return self.manager |
|---|