API _meta модели

class Options

API _meta лежит в основе Django ORM. Это позволяет другим частям системы, таким как поиск, запросы, формы и админка, понимать возможности каждой модели. API доступен через атрибут _meta каждого класса модели, который является экземпляром объекта django.db.models.options.Options.

Методы и атрибуты, которые он предоставляет, могут быть использованы для:

  • Получить все экземпляры полей модели
  • Получить один экземпляр поля модели по имени
  • Извлекает все поля, составляющие первичный ключ модели

API доступа к полю

Получение одного экземпляра поля модели по имени

Options.get_field(field_name)

Возвращает экземпляр поля по имени поля.

field_name может быть именем поля в модели, поля в абстрактной или унаследованной модели или поля, определенного в другой модели, которое указывает на модель. В последнем случае field_name будет (в порядке предпочтения) related_query_name, установленным пользователем, related_name, установленным пользователем, или имя, автоматически созданное Django.

Скрытые поля не могут быть получены по имени.

Если поле с заданным именем не найдено, будет вызвано исключение FieldDoesNotExist.

>>> from django.contrib.auth.models import User

# A field on the model
>>> User._meta.get_field("username")
<django.db.models.fields.CharField: username>

# A field from another model that has a relation with the current model
>>> User._meta.get_field("logentry")
<ManyToOneRel: admin.logentry>

# A non existent field
>>> User._meta.get_field("does_not_exist")
Traceback (most recent call last):
    ...
FieldDoesNotExist: User has no field named 'does_not_exist'

Получение всех экземпляров полей модели

Options.get_fields(include_parents=True, include_hidden=False)

Возвращает кортеж полей, связанных с моделью. get_fields() принимает два параметра, которые можно использовать для управления возвращаемыми полями:

include_parents
По умолчанию True. Рекурсивно включает поля, определенные в родительских классах. Если установлено значение False, get_fields() будет искать только поля, объявленные непосредственно в текущей модели. Поля из моделей, которые напрямую наследуются от абстрактных моделей или прокси-классов, считаются локальными, а не родительскими.
include_hidden
по умолчанию используется False. Если задано значение True, get_fields(), будет содержать hidden fields.
>>> from django.contrib.auth.models import User
>>> User._meta.get_fields()
(<ManyToOneRel: admin.logentry>,
 <django.db.models.fields.AutoField: id>,
 <django.db.models.fields.CharField: password>,
 <django.db.models.fields.DateTimeField: last_login>,
 <django.db.models.fields.BooleanField: is_superuser>,
 <django.db.models.fields.CharField: username>,
 <django.db.models.fields.CharField: first_name>,
 <django.db.models.fields.CharField: last_name>,
 <django.db.models.fields.EmailField: email>,
 <django.db.models.fields.BooleanField: is_staff>,
 <django.db.models.fields.BooleanField: is_active>,
 <django.db.models.fields.DateTimeField: date_joined>,
 <django.db.models.fields.related.ManyToManyField: groups>,
 <django.db.models.fields.related.ManyToManyField: user_permissions>)

# Also include hidden fields.
>>> User._meta.get_fields(include_hidden=True)
(<ManyToOneRel: auth.user_groups>,
 <ManyToOneRel: auth.user_user_permissions>,
 <ManyToOneRel: admin.logentry>,
 <django.db.models.fields.AutoField: id>,
 <django.db.models.fields.CharField: password>,
 <django.db.models.fields.DateTimeField: last_login>,
 <django.db.models.fields.BooleanField: is_superuser>,
 <django.db.models.fields.CharField: username>,
 <django.db.models.fields.CharField: first_name>,
 <django.db.models.fields.CharField: last_name>,
 <django.db.models.fields.EmailField: email>,
 <django.db.models.fields.BooleanField: is_staff>,
 <django.db.models.fields.BooleanField: is_active>,
 <django.db.models.fields.DateTimeField: date_joined>,
 <django.db.models.fields.related.ManyToManyField: groups>,
 <django.db.models.fields.related.ManyToManyField: user_permissions>)

Получение полей, составляющих первичный ключ модели

New in Django 5.2.
Options.pk_fields

Возвращает список полей, составляющих первичный ключ модели.

Когда composite primary key определен в модели, он будет содержать все fields, на которые он ссылается.

from django.db import models


class TenantUser(models.Model):
    pk = models.CompositePrimaryKey("tenant_id", "id")
    tenant_id = models.IntegerField()
    id = models.IntegerField()

>>> TenantUser._meta.pk_fields
[
    <django.db.models.fields.IntegerField: tenant_id>,
    <django.db.models.fields.IntegerField: id>
]

В противном случае он будет содержать единственное поле, объявленное как primary key модели.

>>> User._meta.pk_fields
[<django.db.models.fields.AutoField: id>]
Ссылка на ограничения
Справочник по связям между объектами
Вернуться на верх