Ссылка на экземпляр модели ¶

Настройка загрузки моделей ¶

classmethodModel.from_db ( db , field_names , values ) ¶

Метод from_db() можно использовать для настройки создания экземпляров модели при их загрузке из базы данных.

Параметр db содержит псевдоним базы данных, из которой загружен шаблон, field_names содержит имена всех загруженных полей и values содержит значения, загруженные для каждого поля из field_names . Порядок полей field_names такой же, как в values . Если все поля модели присутствуют, values всегда находится в ожидаемом порядке __init__() . Это означает, что экземпляр может быть создан с помощью cls(*values) . Если некоторые поля отложены, они не отображаются в field_names . В этом случае присвойте значение django.db.models.DEFERRED каждому из отсутствующих полей.

Помимо создания новой модели, метод from_db() должен установить флаги adding и db атрибут _state нового экземпляра.

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

from django.db.models import DEFERRED

@classmethod
def from_db(cls, db, field_names, values):
    # Default implementation of from_db() (subject to change and could
    # be replaced with super()).
    if len(values) != len(cls._meta.concrete_fields):
        values = list(values)
        values.reverse()
        values = [
            values.pop() if f.attname in field_names else DEFERRED
            for f in cls._meta.concrete_fields
        ]
    instance = cls(*values)
    instance._state.adding = False
    instance._state.db = db
    # customization to store the original field values on the instance
    instance._loaded_values = dict(zip(field_names, values))
    return instance

def save(self, *args, **kwargs):
    # Check how the current values differ from ._loaded_values. For example,
    # prevent changing the creator_id of the model. (This example doesn't
    # support cases where 'creator_id' is deferred).
    if not self._state.adding and (
            self.creator_id != self._loaded_values['creator_id']):
        raise ValueError("Updating the value of creator isn't allowed")
    super().save(*args, **kwargs)

В приведенном выше примере показана полная from_db() реализация, чтобы прояснить, как это делается. В этом случае можно было бы использовать super() вызов from_db() метода.

Автоматическое увеличение первичных ключей ¶

Если шаблон содержит поле AutoField - первичный ключ с автоматическим увеличением - автоматически увеличивающееся значение будет вычислено и сохранено как атрибут объекта при его первом сохранении с помощью save() :

>>> b2 = Blog(name='Cheddar Talk', tagline='Thoughts on cheese.')
>>> b2.id     # Returns None, because b2 doesn't have an ID yet.
>>> b2.save()
>>> b2.id     # Returns the ID of your new object.

Невозможно узнать будущее значение идентификатора перед вызовом save() , потому что это значение рассчитывается базой данных, а не Django.

Для удобства каждый шаблон по умолчанию имеет AutoField именованное поле id , за исключением случаев, когда вы явно добавляете параметр primary_key=True в одно из полей шаблона. Смотрите документацию AutoField для более подробной информации.

>>> b3 = Blog(id=3, name='Cheddar Talk', tagline='Thoughts on cheese.')
>>> b3.id     # Returns 3.
>>> b3.save()
>>> b3.id     # Returns 3.

b4 = Blog(id=3, name='Not Cheddar', tagline='Anything but cheese.')
b4.save()  # Overrides the previous blog with ID=3!

Что происходит во время регистрации? ¶

Когда вы регистрируете объект, Django выполняет следующие шаги:

1. Передайте сигнал перед записью. Сигнал django.db.models.signals.pre_save отправляется, позволяя любой функции, слушающей этот сигнал, предпринять действия.

2. Подготовка данных. Метод pre_save() каждого поля вызывается для выполнения любого возможного автоматического изменения данных. Например, поля даты / времени переопределяют, pre_save() чтобы реализовать auto_now_add и auto_now .

3. Подготовка данных для базы данных. Метод get_db_prep_save() каждого поля должен предоставлять свое текущее значение в типе данных, который может быть записан в базу данных.

   Большинство полей не требуют подготовки данных. Простые типы данных, такие как целые числа или строки, «готовы к записи» как объект Python. Однако более сложные типы данных часто нуждаются в некоторой модификации.

   Например, поля DateField используют объект Python datetime для хранения своих данных. Базы данных не могут хранить объекты datetime , поэтому значение поля необходимо преобразовать в строку даты в формате ISO, чтобы вставить в базу данных.

4. Вставка данных в базу данных. Предварительно обработанные и подготовленные данные преобразуются в оператор SQL для вставки в базу данных.

5. Выходной сигнал после записи. Сигнал django.db.models.signals.post_save отправляется, позволяя любой функции, слушающей этот сигнал, предпринять действия.

Как Django отличает UPDATE от INSERT ¶

Вы могли заметить, что объекты базы данных Django используют один и тот же метод save() для создания или изменения объектов. Уровень абстракции Django избавляет от необходимости различать SQL INSERT и UPDATE . В частности, при вызове, когда save() атрибут первичного ключа объекта не устанавливает значение default , Django следует следующему алгоритму:

• Если для атрибута первичного ключа объекта установлено значение, эквивалентное True (то есть значение, отличное от None или пустая строка), Django выполняет UPDATE инструкцию (update).
• Если атрибут первичного ключа объекта не определен или если инструкция UPDATE ничего не обновила (например, если первичный ключ установлен на значение, которое не существует в базе данных ), Django выполняет запрос INSERT .

Если атрибут первичного ключа объекта устанавливает значение по умолчанию default , Django выполняет инструкцию, UPDATE если это существующий экземпляр модели и для его первичного ключа установлено значение, существующее в базе данных. , В противном случае Django выполняет инструкцию INSERT .

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

До Django 1.5 Django делал ошибку, SELECT когда был установлен атрибут первичного ключа. Если он SELECT нашел объект, то Django сделает его UPDATE , в противном случае он сделает один INSERT . Этот старый алгоритм произвел дополнительный запрос по делу UPDATE . В некоторых случаях база данных может не сообщать, что строка была обновлена, даже если есть строка базы данных, которая соответствует первичному ключу объекта. Примером может служить возвращаемый триггер PostgreSQL . В таких случаях можно вернуться к предыдущему алгоритму, установив для параметра значение .ON UPDATE NULL select_on_save True

Обновление атрибутов на основе существующих полей ¶

Иногда вам нужно выполнить простую арифметическую задачу с полем, например, увеличить или уменьшить текущее значение. Один из способов добиться этого - выполнить арифметические операции в Python, например:

>>> product = Product.objects.get(name='Venezuelan Beaver Cheese')
>>> product.number_sold += 1
>>> product.save()

Если number_sold существующее значение в базе данных равно 10, значение 11 будет записано как новое значение в базе данных.

Этот процесс можно упрочить, избегая конфликта конкуренции , и сделать его немного быстрее, выражая обновление относительно существующего значения, а не явно назначая новое значение. Django предоставляет некоторые средства для достижения такого рода относительного обновления. Используя des , предыдущий пример формулируется следующим образом:expressions F expressions F

>>> from django.db.models import F
>>> product = Product.objects.get(name='Venezuelan Beaver Cheese')
>>> product.number_sold = F('number_sold') + 1
>>> product.save()

Для получения дополнительных сведений см. Документацию и их использование в запросах на обновление .expressions F

Указание полей для сохранения ¶

Передавая список имен полей в параметре update_fields из save() , только поля в этом списке будут обновлены. Это может быть полезно, когда необходимо обновить небольшое подмножество полей объекта. Можно ожидать небольшого увеличения производительности, если не обновлять все поля модели в базе данных. Например :

product.name = 'Name changed again'
product.save(update_fields=['name'])

Параметр update_fields может быть любым повторяемым объектом, содержащим строки. Если последний пуст, запись не производится. Значение None вызывает обновление всех полей.

Использование update_fields принудительного обновления.

При сохранении модели, полученной отложенной загрузкой модели ( only() или defer() ), обновляются только поля, загруженные из базы данных. В этом случае эффект аналогичен update_fields автоматическому. Если вы назначаете или изменяете какое-либо из значений отложенного поля, это поле добавляется к полям, которые нужно обновить.

__str__() ¶

Model.__str__() ¶

Метод __str__() вызывается всякий раз, когда str() вызывается для объекта. Django использует его str(obj) несколько раз. В частности, для отображения объекта на сайте администрирования Django и для создания значения, вставленного в шаблон при отображении объекта. Поэтому важно всегда возвращать полезное и понятное представление модели в ответ на метод __str__() .

Например :

from django.db import models

class Person(models.Model):
    first_name = models.CharField(max_length=50)
    last_name = models.CharField(max_length=50)

    def __str__(self):
        return '%s %s' % (self.first_name, self.last_name)

__eq__() ¶

Model.__eq__() ¶

Метод равенства определяется таким образом, что экземпляры с одинаковым значением первичного ключа и одним и тем же конкретным классом считаются равными, за исключением экземпляров, значение первичного ключа None которых всегда равно только самим себе. , Для прокси-моделей конкретный класс определяется как первый не-прокси-родитель модели; для всех остальных моделей это просто класс модели.

Например :

from django.db import models

class MyModel(models.Model):
    id = models.AutoField(primary_key=True)

class MyProxyModel(MyModel):
    class Meta:
        proxy = True

class MultitableInherited(MyModel):
    pass

# Primary keys compared
MyModel(id=1) == MyModel(id=1)
MyModel(id=1) != MyModel(id=2)
# Primary keys are None
MyModel(id=None) != MyModel(id=None)
# Same instance
instance = MyModel(id=None)
instance == instance
# Proxy model
MyModel(id=1) == MyProxyModel(id=1)
# Multi-table inheritance
MyModel(id=1) != MultitableInherited(id=1)

__hash__() ¶

Model.__hash__() ¶

Метод __hash__ основан на значении первичного ключа экземпляра. Это на практике hash(obj.pk) . Если у экземпляра нет значения первичного ключа, генерируется исключение TypeError (в противном случае метод __hash__() вернет другое значение до и после сохранения экземпляра, в то время как изменение значения __hash__() экземпляра запрещено в Python).

get_absolute_url() ¶

Model.get_absolute_url() ¶

Определите метод, get_absolute_url() чтобы сообщить Django, как вычислять канонический URL-адрес объекта. Для вызывающей стороны этот метод должен возвращать строку, которую можно использовать для ссылки на объект через HTTP.

Например :

def get_absolute_url(self):
    return "/people/%i/" % self.id

Хотя этот код правильный и простой, возможно, это не самый переносимый способ написать такой метод. Функция reverse() - обычно лучший подход.

Например :

def get_absolute_url(self):
    from django.urls import reverse
    return reverse('people.views.details', args=[str(self.id)])

Одно из мест, которое использует Django, get_absolute_url() - это приложение администратора. Если объект определяет этот метод, на странице редактирования объекта будет ссылка «Просмотр на сайте», которая приведет вас прямо к общедоступной странице отображения объекта, как показано значком get_absolute_url() .

Аналогичным образом, некоторые другие части Django, такие как система каналов синдикации , используют, get_absolute_url() если они определены. Если имеет смысл иметь уникальный URL-адрес для каждого экземпляра модели, вам следует определить get_absolute_url() .

def get_absolute_url(self):
    return '/%s/' % self.name

Использование get_absolute_url() в шаблонах считается хорошей практикой вместо закрепления URL-адресов объектов в фиксированных строках. Например, этот код шаблона плохой:

<!-- BAD template code. Avoid! -->
<a href="/people/{{ object.id }}/">{{ object.name }}</a>

Этот код шаблона намного лучше:

<a href="{{ object.get_absolute_url }}">{{ object.name }}</a>

Логика здесь в том, что если вы измените структуру URL-адресов своих объектов, даже если это была небольшая проверка орфографии, неприемлемо найти все места, где URL-адрес находится в вопрос можно было написать. Он определяется только один раз, get_absolute_url() и все остальные места в коде могут ссылаться на этот метод.

_state ¶

Model._state¶

Атрибут _state относится к объекту, ModelState который следует жизненному циклу экземпляра модели.

У объекта ModelState есть два атрибута adding : флаг, действительный, True если модель не была сохранена в базе данных, и db строка, относящаяся к псевдониму базы данных, из которого экземпляр был загружен или сохранен. ,

Новые созданные экземпляры имеют adding=True и db=None , потому что они собираются регистрироваться. Экземпляры , извлеченные из QuerySet будут иметь adding=False и db набор для псевдонима соответствующей базы данных.