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

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

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. Подать сигнал предварительного сохранения. pre_save Посылается сигнал, что позволяет любые функции прослушивания для этого сигнала , чтобы сделать что - то.

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

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

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

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

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

5. Подать сигнал после сохранения. post_save Посылается сигнал, что позволяет любые функции прослушивания для этого сигнала , чтобы сделать что - то.

Как Django знает, что нужно ОБНОВИТЬ против ВСТАВКИ ¶

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

update_fieldsАргумент может быть любой Iterable , содержащие строки. Пустая 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будет поднято a (в противном случае __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установить на псевдоним связанной базы данных.