Spec-Zone.ru › Django 3.1

Менеджеры

class Manager

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

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

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

По умолчанию Django добавляет Manager с именем 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 для получения класса модели, к которому они привязаны.

Модификация начального набора результатов менеджера

Базовый набор результатов менеджера 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() вернёт все книги в базе данных.

Вы можете переопределить базовый набор результатов менеджера 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 вернёт неполные результаты.

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

Хотя большинство методов стандартного 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 имеет смысл на уровне менеджера; например, мы намеренно предотвращаем копирование метода 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 CustomManager(models.Manager):
    def manager_only_method(self):
        return

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

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

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

MyManager = CustomManager.from_queryset(CustomQuerySet)

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

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

Вот как 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/3.1/topics/db/managers/

Spec-Zone.ru

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