Django ExceptionsLink to this heading

Django raises some of its own exceptions as well as standard Python exceptions.

Django Core ExceptionsLink to this heading

Django core exception classes are defined in django.core.exceptions.

AppRegistryNotReadyLink to this heading

exception AppRegistryNotReadyLink to this definition

This exception is raised when attempting to use models before the app loading process, which initializes the ORM, is complete.

ObjectDoesNotExistLink to this heading

exception ObjectDoesNotExistLink to this definition

The base class for Model.DoesNotExist exceptions. A try/except for ObjectDoesNotExist will catch DoesNotExist exceptions for all models.

See get().

EmptyResultSetLink to this heading

exception EmptyResultSetLink to this definition

EmptyResultSet may be raised during query generation if a query won't return any results. Most Django projects won't encounter this exception, but it might be useful for implementing custom lookups and expressions.

FieldDoesNotExistLink to this heading

exception FieldDoesNotExistLink to this definition

The FieldDoesNotExist exception is raised by a model's _meta.get_field() method when the requested field does not exist on the model or on the model's parents.

MultipleObjectsReturnedLink to this heading

exception MultipleObjectsReturnedLink to this definition

The base class for Model.MultipleObjectsReturned exceptions. A try/except for MultipleObjectsReturned will catch MultipleObjectsReturned exceptions for all models.

See get().

SuspiciousOperationLink to this heading

exception SuspiciousOperationLink to this definition

The SuspiciousOperation exception is raised when a user has performed an operation that should be considered suspicious from a security perspective, such as tampering with a session cookie. Subclasses of SuspiciousOperation include:

  • DisallowedHost

  • DisallowedModelAdminLookup

  • DisallowedModelAdminToField

  • DisallowedRedirect

  • InvalidSessionKey

  • RequestDataTooBig

  • SuspiciousFileOperation

  • SuspiciousMultipartForm

  • SuspiciousSession

  • TooManyFieldsSent

If a SuspiciousOperation exception reaches the WSGI handler level it is logged at the Error level and results in a HttpResponseBadRequest. See the logging documentation for more information.

PermissionDeniedLink to this heading

exception PermissionDeniedLink to this definition

The PermissionDenied exception is raised when a user does not have permission to perform the action requested.

ViewDoesNotExistLink to this heading

exception ViewDoesNotExistLink to this definition

The ViewDoesNotExist exception is raised by django.urls when a requested view does not exist.

MiddlewareNotUsedLink to this heading

exception MiddlewareNotUsedLink to this definition

The MiddlewareNotUsed exception is raised when a middleware is not used in the server configuration.

ImproperlyConfiguredLink to this heading

exception ImproperlyConfiguredLink to this definition

The ImproperlyConfigured exception is raised when Django is somehow improperly configured -- for example, if a value in settings.py is incorrect or unparseable.

FieldErrorLink to this heading

exception FieldErrorLink to this definition

The FieldError exception is raised when there is a problem with a model field. This can happen for several reasons:

  • A field in a model clashes with a field of the same name from an abstract base class

  • An infinite loop is caused by ordering

  • A keyword cannot be parsed from the filter parameters

  • A field cannot be determined from a keyword in the query parameters

  • A join is not permitted on the specified field

  • A field name is invalid

  • A query contains invalid order_by arguments

ValidationErrorLink to this heading

exception ValidationErrorLink to this definition

The ValidationError exception is raised when data fails form or model field validation. For more information about validation, see Form and Field Validation, Model Field Validation and the Validator Reference.

NON_FIELD_ERRORSLink to this heading

NON_FIELD_ERRORSLink to this definition

ValidationErrors that don't belong to a particular field in a form or model are classified as NON_FIELD_ERRORS. This constant is used as a key in dictionaries that otherwise map fields to their respective list of errors.

RequestAbortedLink to this heading

exception RequestAbortedLink to this definition

The RequestAborted exception is raised when a HTTP body being read in by the handler is cut off midstream and the client connection closes, or when the client does not send data and hits a timeout where the server closes the connection.

It is internal to the HTTP handler modules and you are unlikely to see it elsewhere. If you are modifying HTTP handling code, you should raise this when you encounter an aborted request to make sure the socket is closed cleanly.

SynchronousOnlyOperationLink to this heading

exception SynchronousOnlyOperationLink to this definition

The SynchronousOnlyOperation exception is raised when code that is only allowed in synchronous Python code is called from an asynchronous context (a thread with a running asynchronous event loop). These parts of Django are generally heavily reliant on thread-safety to function and don't work correctly under coroutines sharing the same thread.

If you are trying to call code that is synchronous-only from an asynchronous thread, then create a synchronous thread and call it in that. You can accomplish this is with asgiref.sync.sync_to_async().

URL Resolver exceptionsLink to this heading

URL Resolver exceptions are defined in django.urls.

Resolver404Link to this heading

exception Resolver404Link to this definition

The Resolver404 exception is raised by resolve() if the path passed to resolve() doesn't map to a view. It's a subclass of django.http.Http404.

NoReverseMatchLink to this heading

exception NoReverseMatchLink to this definition

The NoReverseMatch exception is raised by django.urls when a matching URL in your URLconf cannot be identified based on the parameters supplied.

Database ExceptionsLink to this heading

Database exceptions may be imported from django.db.

Django wraps the standard database exceptions so that your Django code has a guaranteed common implementation of these classes.

exception ErrorLink to this definition
exception InterfaceErrorLink to this definition
exception DatabaseErrorLink to this definition
exception DataErrorLink to this definition
exception OperationalErrorLink to this definition
exception IntegrityErrorLink to this definition
exception InternalErrorLink to this definition
exception ProgrammingErrorLink to this definition
exception NotSupportedErrorLink to this definition

The Django wrappers for database exceptions behave exactly the same as the underlying database exceptions. See PEP 249, the Python Database API Specification v2.0, for further information.

As per PEP 3134, a __cause__ attribute is set with the original (underlying) database exception, allowing access to any additional information provided.

exception models.ProtectedErrorLink to this definition

Raised to prevent deletion of referenced objects when using django.db.models.PROTECT. models.ProtectedError is a subclass of IntegrityError.

Http ExceptionsLink to this heading

Http exceptions may be imported from django.http.

UnreadablePostErrorLink to this heading

exception UnreadablePostErrorLink to this definition

UnreadablePostError is raised when a user cancels an upload.

Transaction ExceptionsLink to this heading

Transaction exceptions are defined in django.db.transaction.

TransactionManagementErrorLink to this heading

exception TransactionManagementErrorLink to this definition

TransactionManagementError is raised for any and all problems related to database transactions.

Testing Framework ExceptionsLink to this heading

Exceptions provided by the django.test package.

RedirectCycleErrorLink to this heading

exception client.RedirectCycleErrorLink to this definition

RedirectCycleError is raised when the test client detects a loop or an overly long chain of redirects.

Python ExceptionsLink to this heading

Django raises built-in Python exceptions when appropriate as well. See the Python documentation for further information on the Built-in Exceptions.