Модель _meta API

class Options [source]

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

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

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

API доступа к полям

Получение отдельного поля модели по имени

Options.get_field(field_name) [source]

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

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

Hidden fields не может быть получен по имени.

Если поле с заданным именем не найдено, будет поднято исключение 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) [source]

Возвращает кортеж полей, связанных с моделью. 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>)

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

Новое в Django 5.2.

Options.pk_fields [source]

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

Когда на модели определён 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>]

© Django Software Foundation and individual contributors
Licensed under the BSD License.
https://docs.djangoproject.com/en/5.2/ref/models/meta/