Модель _meta API

class Options [source]

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

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

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

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

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

Options.get_field(field_name) [source]

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

Имя поля field_name может быть именем поля в модели, полем в абстрактной или наследуемой модели, или полем, определённым в другой модели, которая указывает на эту модель. В последнем случае имя field_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'

Устаревшее начиная с версии 1.8: Options.get_field() ранее принимал параметр many_to_many, который можно было установить в False, чтобы избежать поиска ManyToManyField. Старое поведение сохранено для обратной совместимости; однако, параметр и это поведение устарели.

Если вы хотите отфильтровать ManyToManyFields, вы можете проверить атрибут Field.many_to_many после вызова get_field().

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

Options.get_fields(include_parents=True, include_hidden=False) [source]

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

include_parents

True по умолчанию. Рекурсивно включает поля, определённые в родительских классах. Если установлено в False, get_fields() будет искать только поля, объявленные непосредственно в текущей модели. Поля из моделей, которые непосредственно наследуются от абстрактных моделей или прокси-классов, считаются локальными, а не родительскими.

include_hidden

False по умолчанию. Если установлено в True, get_fields() будет включать поля, используемые для поддержки функциональности других полей. Это также включает любые поля, которые имеют related_name (такие как ManyToManyField или ForeignKey), которые начинаются с “+”.

>>> 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>)

Миграция из старого API

В рамках формализации API Model._meta (из класса django.db.models.options.Options) ряд методов и свойств были устаревши и будут удалены в Django 1.10.

Эти старые API можно воспроизвести, либо:

• вызвав Options.get_field(), или;
• вызвав Options.get_fields() для получения списка всех полей, а затем отфильтровав этот список с помощью атрибутов поля, которые описывают (или извлекают, в случае вариантов _with_model ) свойства необходимых полей.

Хотя возможно сделать строго эквивалентные замены старых методов, это может не быть лучшим подходом. Потратив время на рефакторинг любых циклов по полям, чтобы лучше использовать новый API — и, возможно, включить поля, которые ранее были исключены — почти наверняка приведет к улучшению кода.

Предполагая, что у вас есть модель с именем MyModel, следующие замены можно сделать, чтобы преобразовать ваш код в новый API:

• MyModel._meta.get_field(name):

  f = MyModel._meta.get_field(name)
  

  а затем проверить, если:

  • f.auto_created == False, так как новый API get_field() найдёт «обратные» связи), и:
  • f.is_relation and f.related_model is None, так как новый API get_field() найдёт GenericForeignKey связи;

• MyModel._meta.get_field_by_name(name):

  get_field_by_name() возвращало четыре значения: (field, model, direct,  m2m):

  • field можно найти, используя MyModel._meta.get_field(name)
  • model можно найти через атрибут model поля.

  • direct можно найти, используя: not field.auto_created or field.concrete

    Проверка auto_created исключает все «прямые» и «обратные» связи, созданные Django, но также включает AutoField и OneToOneField в прокси-моделях. Мы избегаем фильтрации этих атрибутов, используя атрибут concrete.

  • m2m можно найти через атрибут many_to_many поля.

• MyModel._meta.get_fields_with_model():

  [
      (f, f.model if f.model != MyModel else None)
      for f in MyModel._meta.get_fields()
      if not f.is_relation
          or f.one_to_one
          or (f.many_to_one and f.related_model)
  ]
  

• MyModel._meta.get_concrete_fields_with_model():

  [
      (f, f.model if f.model != MyModel else None)
      for f in MyModel._meta.get_fields()
      if f.concrete and (
          not f.is_relation
          or f.one_to_one
          or (f.many_to_one and f.related_model)
      )
  ]
  

• MyModel._meta.get_m2m_with_model():

  [
      (f, f.model if f.model != MyModel else None)
      for f in MyModel._meta.get_fields()
      if f.many_to_many and not f.auto_created
  ]
  

• MyModel._meta.get_all_related_objects():

  [
      f for f in MyModel._meta.get_fields()
      if (f.one_to_many or f.one_to_one)
      and f.auto_created and not f.concrete
  ]
  

• MyModel._meta.get_all_related_objects_with_model():

  [
      (f, f.model if f.model != MyModel else None)
      for f in MyModel._meta.get_fields()
      if (f.one_to_many or f.one_to_one)
      and f.auto_created and not f.concrete
  ]
  

• MyModel._meta.get_all_related_many_to_many_objects():

  [
      f for f in MyModel._meta.get_fields(include_hidden=True)
      if f.many_to_many and f.auto_created
  ]
  

• MyModel._meta.get_all_related_m2m_objects_with_model():

  [
      (f, f.model if f.model != MyModel else None)
      for f in MyModel._meta.get_fields(include_hidden=True)
      if f.many_to_many and f.auto_created
  ]
  

• MyModel._meta.get_all_field_names():

  from itertools import chain
  list(set(chain.from_iterable(
      (field.name, field.attname) if hasattr(field, 'attname') else (field.name,)
      for field in MyModel._meta.get_fields()
      # For complete backwards compatibility, you may want to exclude
      # GenericForeignKey from the results.
      if not (field.many_to_one and field.related_model is None)
  )))
  

  Это обеспечивает полную обратную совместимость, гарантируя, что включены и имена полей, и имена атрибутов ForeignKeys, но поля, связанные с GenericForeignKeys, не включены. Более простой вариант:

  [f.name for f in MyModel._meta.get_fields()]
  

  Хотя это не 100% обратная совместимость, это может быть достаточно в многих ситуациях.