| 1 |
import copy |
|---|
| 2 |
|
|---|
| 3 |
from django.db.models.query import QuerySet, EmptyQuerySet, insert_query |
|---|
| 4 |
from django.db.models import signals |
|---|
| 5 |
from django.db.models.fields import FieldDoesNotExist |
|---|
| 6 |
|
|---|
| 7 |
def ensure_default_manager(sender, **kwargs): |
|---|
| 8 |
cls = sender |
|---|
| 9 |
if not getattr(cls, '_default_manager', None) and not cls._meta.abstract: |
|---|
| 10 |
# Create the default manager, if needed. |
|---|
| 11 |
try: |
|---|
| 12 |
cls._meta.get_field('objects') |
|---|
| 13 |
raise ValueError, "Model %s must specify a custom Manager, because it has a field named 'objects'" % cls.__name__ |
|---|
| 14 |
except FieldDoesNotExist: |
|---|
| 15 |
pass |
|---|
| 16 |
cls.add_to_class('objects', Manager()) |
|---|
| 17 |
|
|---|
| 18 |
signals.class_prepared.connect(ensure_default_manager) |
|---|
| 19 |
|
|---|
| 20 |
class Manager(object): |
|---|
| 21 |
# Tracks each time a Manager instance is created. Used to retain order. |
|---|
| 22 |
creation_counter = 0 |
|---|
| 23 |
|
|---|
| 24 |
def __init__(self): |
|---|
| 25 |
super(Manager, self).__init__() |
|---|
| 26 |
self._set_creation_counter() |
|---|
| 27 |
self.model = None |
|---|
| 28 |
self._inherited = False |
|---|
| 29 |
|
|---|
| 30 |
def contribute_to_class(self, model, name): |
|---|
| 31 |
# TODO: Use weakref because of possible memory leak / circular reference. |
|---|
| 32 |
self.model = model |
|---|
| 33 |
setattr(model, name, ManagerDescriptor(self)) |
|---|
| 34 |
if not getattr(model, '_default_manager', None) or self.creation_counter < model._default_manager.creation_counter: |
|---|
| 35 |
model._default_manager = self |
|---|
| 36 |
if model._meta.abstract or self._inherited: |
|---|
| 37 |
model._meta.abstract_managers.append((self.creation_counter, name, |
|---|
| 38 |
self)) |
|---|
| 39 |
|
|---|
| 40 |
def _set_creation_counter(self): |
|---|
| 41 |
""" |
|---|
| 42 |
Sets the creation counter value for this instance and increments the |
|---|
| 43 |
class-level copy. |
|---|
| 44 |
""" |
|---|
| 45 |
self.creation_counter = Manager.creation_counter |
|---|
| 46 |
Manager.creation_counter += 1 |
|---|
| 47 |
|
|---|
| 48 |
def _copy_to_model(self, model): |
|---|
| 49 |
""" |
|---|
| 50 |
Makes a copy of the manager and assigns it to 'model', which should be |
|---|
| 51 |
a child of the existing model (used when inheriting a manager from an |
|---|
| 52 |
abstract base class). |
|---|
| 53 |
""" |
|---|
| 54 |
assert issubclass(model, self.model) |
|---|
| 55 |
mgr = copy.copy(self) |
|---|
| 56 |
mgr._set_creation_counter() |
|---|
| 57 |
mgr.model = model |
|---|
| 58 |
mgr._inherited = True |
|---|
| 59 |
return mgr |
|---|
| 60 |
|
|---|
| 61 |
####################### |
|---|
| 62 |
# PROXIES TO QUERYSET # |
|---|
| 63 |
####################### |
|---|
| 64 |
|
|---|
| 65 |
def get_empty_query_set(self): |
|---|
| 66 |
return EmptyQuerySet(self.model) |
|---|
| 67 |
|
|---|
| 68 |
def get_query_set(self): |
|---|
| 69 |
"""Returns a new QuerySet object. Subclasses can override this method |
|---|
| 70 |
to easily customize the behavior of the Manager. |
|---|
| 71 |
""" |
|---|
| 72 |
return QuerySet(self.model) |
|---|
| 73 |
|
|---|
| 74 |
def none(self): |
|---|
| 75 |
return self.get_empty_query_set() |
|---|
| 76 |
|
|---|
| 77 |
def all(self): |
|---|
| 78 |
return self.get_query_set() |
|---|
| 79 |
|
|---|
| 80 |
def count(self): |
|---|
| 81 |
return self.get_query_set().count() |
|---|
| 82 |
|
|---|
| 83 |
def dates(self, *args, **kwargs): |
|---|
| 84 |
return self.get_query_set().dates(*args, **kwargs) |
|---|
| 85 |
|
|---|
| 86 |
def distinct(self, *args, **kwargs): |
|---|
| 87 |
return self.get_query_set().distinct(*args, **kwargs) |
|---|
| 88 |
|
|---|
| 89 |
def extra(self, *args, **kwargs): |
|---|
| 90 |
return self.get_query_set().extra(*args, **kwargs) |
|---|
| 91 |
|
|---|
| 92 |
def get(self, *args, **kwargs): |
|---|
| 93 |
return self.get_query_set().get(*args, **kwargs) |
|---|
| 94 |
|
|---|
| 95 |
def get_or_create(self, **kwargs): |
|---|
| 96 |
return self.get_query_set().get_or_create(**kwargs) |
|---|
| 97 |
|
|---|
| 98 |
def create(self, **kwargs): |
|---|
| 99 |
return self.get_query_set().create(**kwargs) |
|---|
| 100 |
|
|---|
| 101 |
def filter(self, *args, **kwargs): |
|---|
| 102 |
return self.get_query_set().filter(*args, **kwargs) |
|---|
| 103 |
|
|---|
| 104 |
def complex_filter(self, *args, **kwargs): |
|---|
| 105 |
return self.get_query_set().complex_filter(*args, **kwargs) |
|---|
| 106 |
|
|---|
| 107 |
def exclude(self, *args, **kwargs): |
|---|
| 108 |
return self.get_query_set().exclude(*args, **kwargs) |
|---|
| 109 |
|
|---|
| 110 |
def in_bulk(self, *args, **kwargs): |
|---|
| 111 |
return self.get_query_set().in_bulk(*args, **kwargs) |
|---|
| 112 |
|
|---|
| 113 |
def iterator(self, *args, **kwargs): |
|---|
| 114 |
return self.get_query_set().iterator(*args, **kwargs) |
|---|
| 115 |
|
|---|
| 116 |
def latest(self, *args, **kwargs): |
|---|
| 117 |
return self.get_query_set().latest(*args, **kwargs) |
|---|
| 118 |
|
|---|
| 119 |
def order_by(self, *args, **kwargs): |
|---|
| 120 |
return self.get_query_set().order_by(*args, **kwargs) |
|---|
| 121 |
|
|---|
| 122 |
def select_related(self, *args, **kwargs): |
|---|
| 123 |
return self.get_query_set().select_related(*args, **kwargs) |
|---|
| 124 |
|
|---|
| 125 |
def values(self, *args, **kwargs): |
|---|
| 126 |
return self.get_query_set().values(*args, **kwargs) |
|---|
| 127 |
|
|---|
| 128 |
def values_list(self, *args, **kwargs): |
|---|
| 129 |
return self.get_query_set().values_list(*args, **kwargs) |
|---|
| 130 |
|
|---|
| 131 |
def update(self, *args, **kwargs): |
|---|
| 132 |
return self.get_query_set().update(*args, **kwargs) |
|---|
| 133 |
|
|---|
| 134 |
def reverse(self, *args, **kwargs): |
|---|
| 135 |
return self.get_query_set().reverse(*args, **kwargs) |
|---|
| 136 |
|
|---|
| 137 |
def _insert(self, values, **kwargs): |
|---|
| 138 |
return insert_query(self.model, values, **kwargs) |
|---|
| 139 |
|
|---|
| 140 |
def _update(self, values, **kwargs): |
|---|
| 141 |
return self.get_query_set()._update(values, **kwargs) |
|---|
| 142 |
|
|---|
| 143 |
class ManagerDescriptor(object): |
|---|
| 144 |
# This class ensures managers aren't accessible via model instances. |
|---|
| 145 |
# For example, Poll.objects works, but poll_obj.objects raises AttributeError. |
|---|
| 146 |
def __init__(self, manager): |
|---|
| 147 |
self.manager = manager |
|---|
| 148 |
|
|---|
| 149 |
def __get__(self, instance, type=None): |
|---|
| 150 |
if instance != None: |
|---|
| 151 |
raise AttributeError, "Manager isn't accessible via %s instances" % type.__name__ |
|---|
| 152 |
return self.manager |
|---|
| 153 |
|
|---|
| 154 |
class EmptyManager(Manager): |
|---|
| 155 |
def get_query_set(self): |
|---|
| 156 |
return self.get_empty_query_set() |
|---|