Spec-Zone.ru › Django 2.2

Менеджеры

class Manager [source]

Интерфейс Manager предоставляет операции запросов к базе данных для моделей Django. Для каждой модели в приложении Django существует хотя бы один Manager.

Способы работы с классами Manager описаны в Создание запросов; в этом документе подробно рассматриваются параметры модели, которые настраивают поведение Manager.

Имена менеджеров

По умолчанию Django добавляет менеджер с именем objects к каждому классу модели Django. Однако, если вы хотите использовать objects в качестве имени поля или имя, отличное от objects для Manager, вы можете переименовать его для каждой модели. Для переименования Manager для данного класса, определите атрибут класса типа models.Manager() в этой модели. Например:

from django.db import models

class Person(models.Model):
    #...
    people = models.Manager()

Используя эту модель, Person.objects будет генерировать исключение AttributeError, но Person.people.all() вернёт список всех объектов Person.

Пользовательские менеджеры

Вы можете использовать пользовательский менеджер Manager в определенной модели, расширив базовый класс Manager и создав экземпляр своего пользовательского менеджера Manager в вашей модели.

Существует две причины для настройки Manager: добавить дополнительные методы Manager и/или изменить начальный QuerySet результат, который возвращает менеджер Manager.

Добавление дополнительных методов менеджера

Добавление дополнительных методов Manager является предпочтительным способом добавления функциональности на уровне таблицы к вашим моделям. (Для функциональности на уровне строки — т.е. функций, которые действуют над одним экземпляром объекта модели — используйте Методы модели, а не пользовательские методы менеджера Manager.)

Пользовательский метод менеджера Manager может возвращать любой тип данных. Не обязательно возвращать QuerySet.

Например, этот пользовательский менеджер Manager предоставляет метод with_counts(), который возвращает список всех объектов OpinionPoll, каждый из которых имеет дополнительный атрибут num_responses, который является результатом агрегированного запроса:

from django.db import models

class PollManager(models.Manager):
    def with_counts(self):
        from django.db import connection
        with connection.cursor() as cursor:
            cursor.execute("""
                SELECT p.id, p.question, p.poll_date, COUNT(*)
                FROM polls_opinionpoll p, polls_response r
                WHERE p.id = r.poll_id
                GROUP BY p.id, p.question, p.poll_date
                ORDER BY p.poll_date DESC""")
            result_list = []
            for row in cursor.fetchall():
                p = self.model(id=row[0], question=row[1], poll_date=row[2])
                p.num_responses = row[3]
                result_list.append(p)
        return result_list

class OpinionPoll(models.Model):
    question = models.CharField(max_length=200)
    poll_date = models.DateField()
    objects = PollManager()

class Response(models.Model):
    poll = models.ForeignKey(OpinionPoll, on_delete=models.CASCADE)
    person_name = models.CharField(max_length=50)
    response = models.TextField()

С этим примером, вы бы использовали OpinionPoll.objects.with_counts() для возвращения этого списка объектов OpinionPoll с атрибутами num_responses.

Ещё один момент, следует отметить в этом примере: методы менеджера Manager могут получить доступ к self.model для получения класса модели, к которой они прикреплены.

Изменение начального QuerySet менеджера

Базовый QuerySet менеджера Manager возвращает все объекты в системе. Например, используя эту модель:

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=50)

…выражение Book.objects.all() вернёт все книги в базе данных.

Вы можете переопределить базовый QuerySet менеджера Manager, переопределив метод Manager.get_queryset() . get_queryset() должен возвращать QuerySet с требуемыми свойствами.

Например, следующая модель имеет два менеджера Manager — один, который возвращает все объекты, и один, который возвращает только книги Роальда Даля:

# First, define the Manager subclass.
class DahlBookManager(models.Manager):
    def get_queryset(self):
        return super().get_queryset().filter(author='Roald Dahl')

# Then hook it into the Book model explicitly.
class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=50)

    objects = models.Manager() # The default manager.
    dahl_objects = DahlBookManager() # The Dahl-specific manager.

С этой моделью Book.objects.all() вернёт все книги в базе данных, а Book.dahl_objects.all() вернёт только те, которые написаны Роальдом Далем.

Конечно, поскольку get_queryset() возвращает объект QuerySet, вы можете использовать filter(), exclude() и все другие методы QuerySet над ним. Таким образом, эти утверждения являются допустимыми:

Book.dahl_objects.all()
Book.dahl_objects.filter(title='Matilda')
Book.dahl_objects.count()

Этот пример также показал ещё один интересный приём: использование нескольких менеджеров для одной модели. Вы можете подключить к модели сколько угодно экземпляров Manager(). Это простой способ определения общих «фильтров» для ваших моделей.

Например:

class AuthorManager(models.Manager):
    def get_queryset(self):
        return super().get_queryset().filter(role='A')

class EditorManager(models.Manager):
    def get_queryset(self):
        return super().get_queryset().filter(role='E')

class Person(models.Model):
    first_name = models.CharField(max_length=50)
    last_name = models.CharField(max_length=50)
    role = models.CharField(max_length=1, choices=[('A', _('Author')), ('E', _('Editor'))])
    people = models.Manager()
    authors = AuthorManager()
    editors = EditorManager()

Этот пример позволяет вам запросить Person.authors.all(), Person.editors.all(), и Person.people.all(), получая предсказуемые результаты.

Менеджеры по умолчанию

Model._default_manager

Если вы используете пользовательские объекты Manager, обратите внимание, что первый Manager Django, который встречается (в порядке их определения в модели), имеет особый статус. Django интерпретирует первый Manager класс в классе как «стандартный» менеджер Manager, и некоторые части Django (включая dumpdata) будут использовать только этот Manager для данной модели. В результате, следует быть внимательным при выборе менеджера по умолчанию, чтобы избежать ситуации, когда переопределение get_queryset() приведёт к невозможности получить доступ к нужным объектам.

Вы можете указать пользовательский менеджер по умолчанию, используя Meta.default_manager_name.

Если вы пишете код, который должен обрабатывать неизвестную модель, например, в стороннем приложении, реализующем обобщённый вид, используйте этот менеджер (или _base_manager), а не предполагайте, что у модели есть менеджер objects.

Базовые менеджеры

Model._base_manager

Использование менеджеров для доступа к связанным объектам

По умолчанию Django использует экземпляр класса менеджера Model._base_manager при доступе к связанным объектам (т. е. choice.question), а не _default_manager связанного объекта. Это необходимо, чтобы Django мог получить связанный объект, даже если он был бы отфильтрован (и, следовательно, был бы недоступен) стандартным менеджером.

Если обычный базовый класс менеджера (django.db.models.Manager) не подходит для вашей ситуации, вы можете указать Django, какой класс использовать, установив Meta.base_manager_name.

Базовые менеджеры не используются при запросе связанных моделей. Например, если модель Question из учебника имела поле deleted и базовый менеджер, который фильтрует экземпляры с deleted=True, набор запросов, такой как Choice.objects.filter(question__name__startswith='What') включал бы связанные варианты удалённых вопросов.

Не удаляйте результаты в этом типе подкласса менеджера

Этот менеджер используется для доступа к объектам, связанным с другими моделями. В этих ситуациях Django должен видеть все объекты для модели, которую он запрашивает, чтобы любой, на который есть ссылка, мог быть получен.

Если вы переопределите метод get_queryset() и отфильтруете какие-либо строки, Django вернёт некорректные результаты. Не делайте этого. Менеджер, который фильтрует результаты в get_queryset() не подходит для использования в качестве базового менеджера.

Вызов пользовательских методов QuerySet из менеджера

Хотя большинство методов стандартного QuerySet доступны напрямую из Manager, это верно только для дополнительных методов, определённых в пользовательском QuerySet, если вы также реализуете их в Manager:

class PersonQuerySet(models.QuerySet):
    def authors(self):
        return self.filter(role='A')

    def editors(self):
        return self.filter(role='E')

class PersonManager(models.Manager):
    def get_queryset(self):
        return PersonQuerySet(self.model, using=self._db)

    def authors(self):
        return self.get_queryset().authors()

    def editors(self):
        return self.get_queryset().editors()

class Person(models.Model):
    first_name = models.CharField(max_length=50)
    last_name = models.CharField(max_length=50)
    role = models.CharField(max_length=1, choices=[('A', _('Author')), ('E', _('Editor'))])
    people = PersonManager()

Это позволяет вызывать как authors() , так и editors() непосредственно из менеджера Person.people.

Создание менеджера с методами QuerySet

Вместо подхода, описанного выше, который требует дублирования методов как в QuerySet, так и в Manager, QuerySet.as_manager() можно использовать для создания экземпляра Manager с копией методов пользовательского менеджера QuerySet:

class Person(models.Model):
    ...
    people = PersonQuerySet.as_manager()

Экземпляр Manager , созданный с помощью QuerySet.as_manager(), будет практически идентичен PersonManager из предыдущего примера.

Не каждый метод QuerySet имеет смысл на уровне Manager. Например, мы намеренно не позволяем копировать метод QuerySet.delete() в класс Manager.

Методы копируются по следующим правилам:

  • Публичные методы копируются по умолчанию.
  • Приватные методы (начинающиеся с нижнего подчеркивания) не копируются по умолчанию.
  • Методы с атрибутом queryset_only установленным в False всегда копируются.
  • Методы с атрибутом queryset_only установленным в True никогда не копируются.

Например:

class CustomQuerySet(models.QuerySet):
    # Available on both Manager and QuerySet.
    def public_method(self):
        return

    # Available only on QuerySet.
    def _private_method(self):
        return

    # Available only on QuerySet.
    def opted_out_public_method(self):
        return
    opted_out_public_method.queryset_only = True

    # Available on both Manager and QuerySet.
    def _opted_in_private_method(self):
        return
    _opted_in_private_method.queryset_only = False

from_queryset()

classmethod from_queryset(queryset_class)

Для расширенного использования вы можете захотеть как пользовательский менеджер Manager, так и пользовательский QuerySet. Вы можете сделать это, вызвав Manager.from_queryset(), который возвращает подкласс вашего базового менеджера Manager с копией пользовательских методов QuerySet:

class BaseManager(models.Manager):
    def manager_only_method(self):
        return

class CustomQuerySet(models.QuerySet):
    def manager_and_queryset_method(self):
        return

class MyModel(models.Model):
    objects = BaseManager.from_queryset(CustomQuerySet)()

Вы также можете сохранить сгенерированный класс в переменную:

CustomManager = BaseManager.from_queryset(CustomQuerySet)

class MyModel(models.Model):
    objects = CustomManager()

Настраиваемые менеджеры и наследование моделей

Вот как Django обрабатывает настраиваемые менеджеры и наследование моделей:

  1. Менеджеры из базовых классов всегда наследуются дочерним классом, используя обычный порядок разрешения имен Python (имена в дочернем классе переопределяют все другие; затем следуют имена в первом родительском классе и так далее).
  2. Если на модели и/или ее родительских классах не объявлены менеджеры, Django автоматически создает менеджер objects.
  3. По умолчанию менеджер класса определяется либо тем, который выбран с помощью Meta.default_manager_name, либо первым объявленным менеджером модели, либо менеджером по умолчанию первой родительской модели.

Эти правила обеспечивают необходимую гибкость, если вы хотите установить набор настраиваемых менеджеров на группу моделей через абстрактный базовый класс, но при этом настроить менеджер по умолчанию. Например, предположим, что у вас есть этот базовый класс:

class AbstractBase(models.Model):
    # ...
    objects = CustomManager()

    class Meta:
        abstract = True

Если вы используете его напрямую в подклассе, objects станет менеджером по умолчанию, если вы не объявите менеджеры в базовом классе:

class ChildA(AbstractBase):
    # ...
    # This class has CustomManager as the default manager.
    pass

Если вы хотите унаследовать от AbstractBase, но предоставить другой менеджер по умолчанию, вы можете указать менеджер по умолчанию в дочернем классе:

class ChildB(AbstractBase):
    # ...
    # An explicit default manager.
    default_manager = OtherManager()

Здесь default_manager является значением по умолчанию. Менеджер objects по-прежнему доступен, так как он унаследован. Просто он не используется в качестве значения по умолчанию.

Наконец, для этого примера предположим, что вы хотите добавить дополнительные менеджеры в дочерний класс, но при этом использовать менеджер по умолчанию из AbstractBase. Вы не можете добавить новый менеджер напрямую в дочерний класс, так как это приведет к переопределению значения по умолчанию, и вам также придется явно включить все менеджеры из абстрактного базового класса. Решение состоит в том, чтобы поместить дополнительные менеджеры в другой базовый класс и добавить его в иерархию наследования *после* значений по умолчанию:

class ExtraManager(models.Model):
    extra_manager = OtherManager()

    class Meta:
        abstract = True

class ChildC(AbstractBase, ExtraManager):
    # ...
    # Default manager is CustomManager, but OtherManager is
    # also available via the "extra_manager" attribute.
    pass

Обратите внимание, что хотя вы можете *определить* настраиваемый менеджер в абстрактной модели, вы не можете *вызвать* какие-либо методы с использованием абстрактной модели. То есть:

ClassA.objects.do_something()

является допустимым, но:

AbstractBase.objects.do_something()

вызовет исключение. Это связано с тем, что менеджеры предназначены для инкапсуляции логики управления коллекциями объектов. Поскольку у вас не может быть коллекции абстрактных объектов, нет смысла управлять ими. Если у вас есть функциональность, которая применяется к абстрактной модели, вы должны поместить эту функциональность в staticmethod или classmethod в абстрактной модели.

Вопросы реализации

Какие бы функции вы ни добавили в свой настраиваемый Manager, должна быть возможность выполнить поверхностную копию экземпляра Manager; т.е., следующий код должен работать:

>>> import copy
>>> manager = MyManager()
>>> my_copy = copy.copy(manager)

Django выполняет поверхностные копии объектов менеджеров во время некоторых запросов; если ваш менеджер не может быть скопирован, эти запросы завершатся сбоем.

Для большинства настраиваемых менеджеров это не будет проблемой. Если вы просто добавляете простые методы в свой Manager, маловероятно, что вы непреднамеренно сделаете экземпляры вашего Manager некопируемыми. Однако, если вы переопределяете __getattr__ или какой-либо другой частный метод вашего объекта Manager, который управляет состоянием объекта, вы должны убедиться, что вы не повлияете на возможность копирования вашего объекта Manager.

© Django Software Foundation and individual contributors
Licensed under the BSD License.
https://docs.djangoproject.com/en/2.2/topics/db/managers/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API