Исключение FieldError

Исключение FieldError в Django возникает, когда в запросе используется поле, которое не существует в модели, или когда синтаксис поиска по полю содержит ошибку. Это исключение является подклассом django.core.exceptions.FieldError. Обычно оно возникает при выполнении методов filter, exclude, get, order_by и других, которые работают с полями модели. Также эта ошибка может появиться при использовании агрегаций или аннотаций с неправильными именами полей.

Синтаксис

class FieldError(Exception):
	pass

Причины возникновения

Основные причины возникновения FieldError:

1. Обращение к несуществующему полю модели
2. Неправильный синтаксис операторов поиска
3. Ошибки в именах полей при аннотациях
4. Использование поля из связанной модели без правильного синтаксиса

Пример . С несуществующим полем

Рассмотрим модель Article и попытку получить статьи по полю, которого нет в модели:

from django.db import models
from django.core.exceptions import FieldError

class Article(models.Model):
	title = models.CharField(max_length=100)
	content = models.TextField()
	published_at = models.DateTimeField()

# Попытка фильтрации по несуществующему полю
try:
	articles = Article.objects.filter(author='John')
except FieldError as e:
	print(e)

Результат выполнения кода:

"Cannot resolve keyword 'author' into field. Choices are: content, id, published_at, title"

Пример . С неправильным оператором поиска

Ошибка возникает также при использовании несуществующего оператора поиска:

from django.db import models
from django.core.exceptions import FieldError

class Category(models.Model):
	name = models.CharField(max_length=100)

class Article(models.Model):
	title = models.CharField(max_length=100)
	category = models.ForeignKey(Category, on_delete=models.CASCADE)

# Попытка использовать несуществующий оператор поиска
try:
	articles = Article.objects.filter(title__unknown='test')
except FieldError as e:
	print(e)

Результат выполнения кода:

"Unsupported lookup 'unknown' for CharField or join on the field not permitted"

Пример . С аннотацией

Ошибка может возникнуть при использовании аннотации с неправильным именем поля:

from django.db import models
from django.db.models import Count
from django.core.exceptions import FieldError

class Author(models.Model):
	name = models.CharField(max_length=100)

class Article(models.Model):
	title = models.CharField(max_length=100)
	author = models.ForeignKey(Author, on_delete=models.CASCADE)

# Попытка аннотировать по несуществующему полю
try:
	authors = Author.objects.annotate(
		articles_count=Count('articles__unknown_field')
	)
except FieldError as e:
	print(e)

Результат выполнения кода:

"Cannot resolve keyword 'unknown_field' into field. Join on 'articles' not permitted"

Пример . С порядком сортировки

Ошибка также появляется при сортировке по несуществующему полю:

from django.db import models
from django.core.exceptions import FieldError

class Profile(models.Model):
	user_name = models.CharField(max_length=100)
	age = models.IntegerField()

# Попытка сортировки по несуществующему полю
try:
	profiles = Profile.objects.order_by('email')
except FieldError as e:
	print(e)

Результат выполнения кода:

"Cannot resolve keyword 'email' into field. Choices are: age, id, user_name"

Как избежать ошибки

Для предотвращения FieldError рекомендуется:

from django.db import models

class Article(models.Model):
	title = models.CharField(max_length=100)
	content = models.TextField()
	status = models.CharField(max_length=20)

# Правильно: проверка существования поля
# Используйте правильные имена полей
articles = Article.objects.filter(status='published')

# Правильно: проверка существования оператора поиска
# Используйте правильные операторы
articles = Article.objects.filter(title__icontains='python')

# Правильно: использование правильных имен в аннотациях
from django.db.models import Count
from myapp.models import Category, Article

categories = Category.objects.annotate(
	article_count=Count('article')
)

Результат выполнения кода:

"Все запросы выполнены без ошибок FieldError"

Смотрите также

исключение FieldDoesNotExist,
которое возникает при попытке получить поле модели
исключение DoesNotExist,
которое возникает, когда запись не найдена в базе данных
исключение ObjectDoesNotExist,
которое является базовым для ошибок отсутствия объектов
исключение ValidationError,
которое возникает при проверке данных в формах