<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>System check framework — Django 1.8.19 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.8.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="top" title="Django 1.8.19 documentation" href="../contents.html" />
<link rel="up" title="API Reference" href="index.html" />
<link rel="next" title="Built-in class-based views API" href="class-based-views/index.html" />
<link rel="prev" title="Applications" href="applications.html" />
<script type="text/javascript" src="../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body role="document">
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../index.html">Django 1.8.19 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../index.html">Home</a> |
<a title="Table of contents" href="../contents.html">Table of contents</a> |
<a title="Global index" href="../genindex.html">Index</a> |
<a title="Module index" href="../py-modindex.html">Modules</a>
</div>
<div class="nav">
« <a href="applications.html" title="Applications">previous</a>
|
<a href="index.html" title="API Reference" accesskey="U">up</a>
|
<a href="class-based-views/index.html" title="Built-in class-based views API">next</a> »</div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="ref-checks">
<div class="section" id="s-system-check-framework">
<span id="system-check-framework"></span><h1>System check framework<a class="headerlink" href="#system-check-framework" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
<span class="title">New in Django 1.7.</span> </div>
<p>The system check framework is a set of static checks for validating Django
projects. It detects common problems and provides hints for how to fix them.
The framework is extensible so you can easily add your own checks.</p>
<p>For details on how to add your own checks and integrate them with Django’s
system checks, see the <a class="reference internal" href="../topics/checks.html"><span class="doc">System check topic guide</span></a>.</p>
<div class="section" id="s-api-reference">
<span id="api-reference"></span><h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h2>
<div class="section" id="s-checkmessage">
<span id="checkmessage"></span><h3><code class="docutils literal"><span class="pre">CheckMessage</span></code><a class="headerlink" href="#checkmessage" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.core.checks.CheckMessage">
<em class="property">class </em><code class="descname">CheckMessage</code>(<em>level</em>, <em>msg</em>, <em>hint</em>, <em>obj=None</em>, <em>id=None</em>)<a class="reference internal" href="../_modules/django/core/checks/messages.html#CheckMessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.core.checks.CheckMessage" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>The warnings and errors raised by system checks must be instances of
<code class="docutils literal"><span class="pre">CheckMessage</span></code>. An instance encapsulates a single reportable error or
warning. It also provides context and hints applicable to the message, and a
unique identifier that is used for filtering purposes.</p>
<p>Constructor arguments are:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">level</span></code></dt>
<dd>The severity of the message. Use one of the predefined values: <code class="docutils literal"><span class="pre">DEBUG</span></code>,
<code class="docutils literal"><span class="pre">INFO</span></code>, <code class="docutils literal"><span class="pre">WARNING</span></code>, <code class="docutils literal"><span class="pre">ERROR</span></code>, <code class="docutils literal"><span class="pre">CRITICAL</span></code>. If the level is greater or
equal to <code class="docutils literal"><span class="pre">ERROR</span></code>, then Django will prevent management commands from
executing. Messages with level lower than <code class="docutils literal"><span class="pre">ERROR</span></code> (i.e. warnings) are
reported to the console, but can be silenced.</dd>
<dt><code class="docutils literal"><span class="pre">msg</span></code></dt>
<dd>A short (less than 80 characters) string describing the problem. The string
should <em>not</em> contain newlines.</dd>
<dt><code class="docutils literal"><span class="pre">hint</span></code></dt>
<dd>A single-line string providing a hint for fixing the problem. If no hint
can be provided, or the hint is self-evident from the error message, the
hint can be omitted, or a value of <code class="docutils literal"><span class="pre">None</span></code> can be used.</dd>
<dt><code class="docutils literal"><span class="pre">obj</span></code></dt>
<dd>Optional. An object providing context for the message (for example, the
model where the problem was discovered). The object should be a model,
field, or manager or any other object that defines <code class="docutils literal"><span class="pre">__str__</span></code> method (on
Python 2 you need to define <code class="docutils literal"><span class="pre">__unicode__</span></code> method). The method is used
while reporting all messages and its result precedes the message.</dd>
<dt><code class="docutils literal"><span class="pre">id</span></code></dt>
<dd>Optional string. A unique identifier for the issue. Identifiers should
follow the pattern <code class="docutils literal"><span class="pre">applabel.X001</span></code>, where <code class="docutils literal"><span class="pre">X</span></code> is one of the letters
<code class="docutils literal"><span class="pre">CEWID</span></code>, indicating the message severity (<code class="docutils literal"><span class="pre">C</span></code> for criticals, <code class="docutils literal"><span class="pre">E</span></code> for
errors and so). The number can be allocated by the application, but should
be unique within that application.</dd>
</dl>
<p>There are subclasses to make creating messages with common levels easier. When
using them you can omit the <code class="docutils literal"><span class="pre">level</span></code> argument because it is implied by the
class name.</p>
<dl class="class">
<dt id="django.core.checks.Debug">
<em class="property">class </em><code class="descname">Debug</code>(<em>msg</em>, <em>hint</em>, <em>obj=None</em>, <em>id=None</em>)<a class="reference internal" href="../_modules/django/core/checks/messages.html#Debug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.core.checks.Debug" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="django.core.checks.Info">
<em class="property">class </em><code class="descname">Info</code>(<em>msg</em>, <em>hint</em>, <em>obj=None</em>, <em>id=None</em>)<a class="reference internal" href="../_modules/django/core/checks/messages.html#Info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.core.checks.Info" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="django.core.checks.Warning">
<em class="property">class </em><code class="descname">Warning</code>(<em>msg</em>, <em>hint</em>, <em>obj=None</em>, <em>id=None</em>)<a class="reference internal" href="../_modules/django/core/checks/messages.html#Warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.core.checks.Warning" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="django.core.checks.Error">
<em class="property">class </em><code class="descname">Error</code>(<em>msg</em>, <em>hint</em>, <em>obj=None</em>, <em>id=None</em>)<a class="reference internal" href="../_modules/django/core/checks/messages.html#Error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.core.checks.Error" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="django.core.checks.Critical">
<em class="property">class </em><code class="descname">Critical</code>(<em>msg</em>, <em>hint</em>, <em>obj=None</em>, <em>id=None</em>)<a class="reference internal" href="../_modules/django/core/checks/messages.html#Critical"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#django.core.checks.Critical" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
<div class="section" id="s-builtin-checks">
<span id="builtin-checks"></span><h2>Builtin checks<a class="headerlink" href="#builtin-checks" title="Permalink to this headline">¶</a></h2>
<div class="section" id="s-builtin-tags">
<span id="builtin-tags"></span><h3>Builtin tags<a class="headerlink" href="#builtin-tags" title="Permalink to this headline">¶</a></h3>
<p>Django’s system checks are organized using the following tags:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">models</span></code>: Checks governing model, field and manager definitions.</li>
<li><code class="docutils literal"><span class="pre">signals</span></code>: Checks on signal declarations and handler registrations.</li>
<li><code class="docutils literal"><span class="pre">admin</span></code>: Checks of any admin site declarations.</li>
<li><code class="docutils literal"><span class="pre">compatibility</span></code>: Flagging potential problems with version upgrades.</li>
<li><code class="docutils literal"><span class="pre">security</span></code>: Checks security related configuration.</li>
</ul>
<p>Some checks may be registered with multiple tags.</p>
</div>
<div class="section" id="s-core-system-checks">
<span id="core-system-checks"></span><h3>Core system checks<a class="headerlink" href="#core-system-checks" title="Permalink to this headline">¶</a></h3>
<div class="section" id="s-models">
<span id="models"></span><h4>Models<a class="headerlink" href="#models" title="Permalink to this headline">¶</a></h4>
<ul class="simple">
<li><strong>models.E001</strong>: <code class="docutils literal"><span class="pre"><swappable></span></code> is not of the form <code class="docutils literal"><span class="pre">app_label.app_name</span></code>.</li>
<li><strong>models.E002</strong>: <code class="docutils literal"><span class="pre"><SETTING></span></code> references <code class="docutils literal"><span class="pre"><model></span></code>, which has not been
installed, or is abstract.</li>
<li><strong>models.E003</strong>: The model has two many-to-many relations through the
intermediate model <code class="docutils literal"><span class="pre"><app_label>.<model></span></code>.</li>
<li><strong>models.E004</strong>: <code class="docutils literal"><span class="pre">id</span></code> can only be used as a field name if the field also
sets <code class="docutils literal"><span class="pre">primary_key=True</span></code>.</li>
<li><strong>models.E005</strong>: The field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code> from parent model <code class="docutils literal"><span class="pre"><model></span></code>
clashes with the field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code> from parent model <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>models.E006</strong>: The field clashes with the field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code> from model
<code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>models.E007</strong>: Field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code> has column name <code class="docutils literal"><span class="pre"><column</span> <span class="pre">name></span></code>
that is used by another field.</li>
<li><strong>models.E008</strong>: <code class="docutils literal"><span class="pre">index_together</span></code> must be a list or tuple.</li>
<li><strong>models.E009</strong>: All <code class="docutils literal"><span class="pre">index_together</span></code> elements must be lists or tuples.</li>
<li><strong>models.E010</strong>: <code class="docutils literal"><span class="pre">unique_together</span></code> must be a list or tuple.</li>
<li><strong>models.E011</strong>: All <code class="docutils literal"><span class="pre">unique_together</span></code> elements must be lists or tuples.</li>
<li><strong>models.E012</strong>: <code class="docutils literal"><span class="pre">index_together/unique_together</span></code> refers to the
non-existent field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>.</li>
<li><strong>models.E013</strong>: <code class="docutils literal"><span class="pre">index_together/unique_together</span></code> refers to a
<code class="docutils literal"><span class="pre">ManyToManyField</span></code> <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>, but <code class="docutils literal"><span class="pre">ManyToManyField</span></code>s are not
supported for that option.</li>
<li><strong>models.E014</strong>: <code class="docutils literal"><span class="pre">ordering</span></code> must be a tuple or list (even if you want to
order by only one field).</li>
<li><strong>models.E015</strong>: <code class="docutils literal"><span class="pre">ordering</span></code> refers to the non-existent field
<code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>.</li>
<li><strong>models.E016</strong>: <code class="docutils literal"><span class="pre">index_together/unique_together</span></code> refers to field
<code class="docutils literal"><span class="pre"><field_name></span></code> which is not local to model <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>models.E017</strong>: Proxy model <code class="docutils literal"><span class="pre"><model></span></code> contains model fields.</li>
<li><strong>models.E018</strong>: Autogenerated column name too long for field <code class="docutils literal"><span class="pre"><field></span></code>.
Maximum length is <code class="docutils literal"><span class="pre"><maximum</span> <span class="pre">length></span></code> for database <code class="docutils literal"><span class="pre"><alias></span></code>.</li>
<li><strong>models.E019</strong>: Autogenerated column name too long for M2M field
<code class="docutils literal"><span class="pre"><M2M</span> <span class="pre">field></span></code>. Maximum length is <code class="docutils literal"><span class="pre"><maximum</span> <span class="pre">length></span></code> for database
<code class="docutils literal"><span class="pre"><alias></span></code>.</li>
<li><strong>models.E020</strong>: The <code class="docutils literal"><span class="pre"><model>.check()</span></code> class method is currently overridden.</li>
</ul>
</div>
<div class="section" id="s-fields">
<span id="fields"></span><h4>Fields<a class="headerlink" href="#fields" title="Permalink to this headline">¶</a></h4>
<ul class="simple">
<li><strong>fields.E001</strong>: Field names must not end with an underscore.</li>
<li><strong>fields.E002</strong>: Field names must not contain <code class="docutils literal"><span class="pre">"__"</span></code>.</li>
<li><strong>fields.E003</strong>: <code class="docutils literal"><span class="pre">pk</span></code> is a reserved word that cannot be used as a field
name.</li>
<li><strong>fields.E004</strong>: <code class="docutils literal"><span class="pre">choices</span></code> must be an iterable (e.g., a list or tuple).</li>
<li><strong>fields.E005</strong>: <code class="docutils literal"><span class="pre">choices</span></code> must be an iterable returning <code class="docutils literal"><span class="pre">(actual</span> <span class="pre">value,</span>
<span class="pre">human</span> <span class="pre">readable</span> <span class="pre">name)</span></code> tuples.</li>
<li><strong>fields.E006</strong>: <code class="docutils literal"><span class="pre">db_index</span></code> must be <code class="docutils literal"><span class="pre">None</span></code>, <code class="docutils literal"><span class="pre">True</span></code> or <code class="docutils literal"><span class="pre">False</span></code>.</li>
<li><strong>fields.E007</strong>: Primary keys must not have <code class="docutils literal"><span class="pre">null=True</span></code>.</li>
<li><strong>fields.E100</strong>: <code class="docutils literal"><span class="pre">AutoField</span></code>s must set primary_key=True.</li>
<li><strong>fields.E110</strong>: <code class="docutils literal"><span class="pre">BooleanField</span></code>s do not accept null values.</li>
<li><strong>fields.E120</strong>: <code class="docutils literal"><span class="pre">CharField</span></code>s must define a <code class="docutils literal"><span class="pre">max_length</span></code> attribute.</li>
<li><strong>fields.E121</strong>: <code class="docutils literal"><span class="pre">max_length</span></code> must be a positive integer.</li>
<li><strong>fields.W122</strong>: <code class="docutils literal"><span class="pre">max_length</span></code> is ignored when used with <code class="docutils literal"><span class="pre">IntegerField</span></code>.</li>
<li><strong>fields.E130</strong>: <code class="docutils literal"><span class="pre">DecimalField</span></code>s must define a <code class="docutils literal"><span class="pre">decimal_places</span></code> attribute.</li>
<li><strong>fields.E131</strong>: <code class="docutils literal"><span class="pre">decimal_places</span></code> must be a non-negative integer.</li>
<li><strong>fields.E132</strong>: <code class="docutils literal"><span class="pre">DecimalField</span></code>s must define a <code class="docutils literal"><span class="pre">max_digits</span></code> attribute.</li>
<li><strong>fields.E133</strong>: <code class="docutils literal"><span class="pre">max_digits</span></code> must be a non-negative integer.</li>
<li><strong>fields.E134</strong>: <code class="docutils literal"><span class="pre">max_digits</span></code> must be greater or equal to <code class="docutils literal"><span class="pre">decimal_places</span></code>.</li>
<li><strong>fields.E140</strong>: <code class="docutils literal"><span class="pre">FilePathField</span></code>s must have either <code class="docutils literal"><span class="pre">allow_files</span></code> or
<code class="docutils literal"><span class="pre">allow_folders</span></code> set to True.</li>
<li><strong>fields.E150</strong>: <code class="docutils literal"><span class="pre">GenericIPAddressField</span></code>s cannot accept blank values if
null values are not allowed, as blank values are stored as nulls.</li>
<li><strong>fields.E160</strong>: The options <code class="docutils literal"><span class="pre">auto_now</span></code>, <code class="docutils literal"><span class="pre">auto_now_add</span></code>, and <code class="docutils literal"><span class="pre">default</span></code>
are mutually exclusive. Only one of these options may be present.</li>
<li><strong>fields.W161</strong>: Fixed default value provided.</li>
<li><strong>fields.W900</strong>: <code class="docutils literal"><span class="pre">IPAddressField</span></code> has been deprecated. Support for it
(except in historical migrations) will be removed in Django 1.9.</li>
</ul>
</div>
<div class="section" id="s-file-fields">
<span id="file-fields"></span><h4>File Fields<a class="headerlink" href="#file-fields" title="Permalink to this headline">¶</a></h4>
<ul class="simple">
<li><strong>fields.E200</strong>: <code class="docutils literal"><span class="pre">unique</span></code> is not a valid argument for a <code class="docutils literal"><span class="pre">FileField</span></code>.</li>
<li><strong>fields.E201</strong>: <code class="docutils literal"><span class="pre">primary_key</span></code> is not a valid argument for a <code class="docutils literal"><span class="pre">FileField</span></code>.</li>
<li><strong>fields.E210</strong>: Cannot use <code class="docutils literal"><span class="pre">ImageField</span></code> because Pillow is not installed.</li>
</ul>
</div>
<div class="section" id="s-related-fields">
<span id="related-fields"></span><h4>Related Fields<a class="headerlink" href="#related-fields" title="Permalink to this headline">¶</a></h4>
<ul class="simple">
<li><strong>fields.E300</strong>: Field defines a relation with model <code class="docutils literal"><span class="pre"><model></span></code>, which is
either not installed, or is abstract.</li>
<li><strong>fields.E301</strong>: Field defines a relation with the model <code class="docutils literal"><span class="pre"><model></span></code> which
has been swapped out.</li>
<li><strong>fields.E302</strong>: Accessor for field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code> clashes with field
<code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>.</li>
<li><strong>fields.E303</strong>: Reverse query name for field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code> clashes with
field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>.</li>
<li><strong>fields.E304</strong>: Field name <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code> clashes with accessor for
<code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>.</li>
<li><strong>fields.E305</strong>: Field name <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code> clashes with reverse query name
for <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>.</li>
<li><strong>fields.E306</strong>: Related name must be a valid Python identifier or end with
a <code class="docutils literal"><span class="pre">'+'</span></code>.</li>
<li><strong>fields.E310</strong>: None of the fields <code class="docutils literal"><span class="pre"><field1></span></code>, <code class="docutils literal"><span class="pre"><field2></span></code>, ... on model
<code class="docutils literal"><span class="pre"><model></span></code> have a <code class="docutils literal"><span class="pre">unique=True</span></code> constraint.</li>
<li><strong>fields.E311</strong>: <code class="docutils literal"><span class="pre"><model></span></code> must set <code class="docutils literal"><span class="pre">unique=True</span></code> because it is
referenced by a <code class="docutils literal"><span class="pre">ForeignKey</span></code>.</li>
<li><strong>fields.E320</strong>: Field specifies <code class="docutils literal"><span class="pre">on_delete=SET_NULL</span></code>, but cannot be null.</li>
<li><strong>fields.E321</strong>: The field specifies <code class="docutils literal"><span class="pre">on_delete=SET_DEFAULT</span></code>, but has no
default value.</li>
<li><strong>fields.E330</strong>: <code class="docutils literal"><span class="pre">ManyToManyField</span></code>s cannot be unique.</li>
<li><strong>fields.E331</strong>: Field specifies a many-to-many relation through model
<code class="docutils literal"><span class="pre"><model></span></code>, which has not been installed.</li>
<li><strong>fields.E332</strong>: Many-to-many fields with intermediate tables must not be
symmetrical.</li>
<li><strong>fields.E333</strong>: The model is used as an intermediate model by <code class="docutils literal"><span class="pre"><model></span></code>,
but it has more than two foreign keys to <code class="docutils literal"><span class="pre"><model></span></code>, which is ambiguous.
You must specify which two foreign keys Django should use via the
<code class="docutils literal"><span class="pre">through_fields</span></code> keyword argument.</li>
<li><strong>fields.E334</strong>: The model is used as an intermediate model by <code class="docutils literal"><span class="pre"><model></span></code>,
but it has more than one foreign key from <code class="docutils literal"><span class="pre"><model></span></code>, which is ambiguous.
You must specify which foreign key Django should use via the
<code class="docutils literal"><span class="pre">through_fields</span></code> keyword argument.</li>
<li><strong>fields.E335</strong>: The model is used as an intermediate model by <code class="docutils literal"><span class="pre"><model></span></code>,
but it has more than one foreign key to <code class="docutils literal"><span class="pre"><model></span></code>, which is ambiguous.
You must specify which foreign key Django should use via the
<code class="docutils literal"><span class="pre">through_fields</span></code> keyword argument.</li>
<li><strong>fields.E336</strong>: The model is used as an intermediary model by <code class="docutils literal"><span class="pre"><model></span></code>,
but it does not have foreign key to <code class="docutils literal"><span class="pre"><model></span></code> or <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>fields.E337</strong>: Field specifies <code class="docutils literal"><span class="pre">through_fields</span></code> but does not provide the
names of the two link fields that should be used for the relation through
<code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>fields.E338</strong>: The intermediary model <code class="docutils literal"><span class="pre"><through</span> <span class="pre">model></span></code> has no field
<code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>.</li>
<li><strong>fields.E339</strong>: <code class="docutils literal"><span class="pre"><model>.<field</span> <span class="pre">name></span></code> is not a foreign key to <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>fields.W340</strong>: <code class="docutils literal"><span class="pre">null</span></code> has no effect on <code class="docutils literal"><span class="pre">ManyToManyField</span></code>.</li>
<li><strong>fields.W341</strong>: <code class="docutils literal"><span class="pre">ManyToManyField</span></code> does not support <code class="docutils literal"><span class="pre">validators</span></code>.</li>
<li><strong>fields.W342</strong>: Setting <code class="docutils literal"><span class="pre">unique=True</span></code> on a <code class="docutils literal"><span class="pre">ForeignKey</span></code> has the same
effect as using a <code class="docutils literal"><span class="pre">OneToOneField</span></code>.</li>
</ul>
</div>
<div class="section" id="s-signals">
<span id="signals"></span><h4>Signals<a class="headerlink" href="#signals" title="Permalink to this headline">¶</a></h4>
<ul class="simple">
<li><strong>signals.E001</strong>: <code class="docutils literal"><span class="pre"><handler></span></code> was connected to the <code class="docutils literal"><span class="pre"><signal></span></code> signal with
a lazy reference to the <code class="docutils literal"><span class="pre"><model></span></code> sender, which has not been installed.</li>
</ul>
</div>
<div class="section" id="s-backwards-compatibility">
<span id="backwards-compatibility"></span><h4>Backwards Compatibility<a class="headerlink" href="#backwards-compatibility" title="Permalink to this headline">¶</a></h4>
<p>The following checks are performed to warn the user of any potential problems
that might occur as a result of a version upgrade.</p>
<ul class="simple">
<li><strong>1_6.W001</strong>: Some project unit tests may not execute as expected. <em>This
check was removed in Django 1.8 due to false positives</em>.</li>
<li><strong>1_6.W002</strong>: <code class="docutils literal"><span class="pre">BooleanField</span></code> does not have a default value. <em>This
check was removed in Django 1.8 due to false positives</em>.</li>
<li><strong>1_7.W001</strong>: Django 1.7 changed the global defaults for the
<code class="docutils literal"><span class="pre">MIDDLEWARE_CLASSES.</span></code>
<code class="docutils literal"><span class="pre">django.contrib.sessions.middleware.SessionMiddleware</span></code>,
<code class="docutils literal"><span class="pre">django.contrib.auth.middleware.AuthenticationMiddleware</span></code>, and
<code class="docutils literal"><span class="pre">django.contrib.messages.middleware.MessageMiddleware</span></code> were removed from
the defaults. If your project needs these middleware then you should
configure this setting.</li>
<li><strong>1_8.W001</strong>: The standalone <code class="docutils literal"><span class="pre">TEMPLATE_*</span></code> settings were deprecated in
Django 1.8 and the <a class="reference internal" href="settings.html#std:setting-TEMPLATES"><code class="xref std std-setting docutils literal"><span class="pre">TEMPLATES</span></code></a> dictionary takes precedence. You must
put the values of the following settings into your defaults <code class="docutils literal"><span class="pre">TEMPLATES</span></code>
dict: <a class="reference internal" href="settings.html#std:setting-TEMPLATE_DIRS"><code class="xref std std-setting docutils literal"><span class="pre">TEMPLATE_DIRS</span></code></a>, <a class="reference internal" href="settings.html#std:setting-ALLOWED_INCLUDE_ROOTS"><code class="xref std std-setting docutils literal"><span class="pre">ALLOWED_INCLUDE_ROOTS</span></code></a>,
<a class="reference internal" href="settings.html#std:setting-TEMPLATE_CONTEXT_PROCESSORS"><code class="xref std std-setting docutils literal"><span class="pre">TEMPLATE_CONTEXT_PROCESSORS</span></code></a>, <a class="reference internal" href="settings.html#std:setting-TEMPLATE_DEBUG"><code class="xref std std-setting docutils literal"><span class="pre">TEMPLATE_DEBUG</span></code></a>,
<a class="reference internal" href="settings.html#std:setting-TEMPLATE_LOADERS"><code class="xref std std-setting docutils literal"><span class="pre">TEMPLATE_LOADERS</span></code></a>, <a class="reference internal" href="settings.html#std:setting-TEMPLATE_STRING_IF_INVALID"><code class="xref std std-setting docutils literal"><span class="pre">TEMPLATE_STRING_IF_INVALID</span></code></a>.</li>
</ul>
</div>
</div>
<div class="section" id="s-admin">
<span id="admin"></span><h3>Admin<a class="headerlink" href="#admin" title="Permalink to this headline">¶</a></h3>
<p>Admin checks are all performed as part of the <code class="docutils literal"><span class="pre">admin</span></code> tag.</p>
<p>The following checks are performed on any
<a class="reference internal" href="contrib/admin/index.html#django.contrib.admin.ModelAdmin" title="django.contrib.admin.ModelAdmin"><code class="xref py py-class docutils literal"><span class="pre">ModelAdmin</span></code></a> (or subclass) that is registered
with the admin site:</p>
<ul class="simple">
<li><strong>admin.E001</strong>: The value of <code class="docutils literal"><span class="pre">raw_id_fields</span></code> must be a list or tuple.</li>
<li><strong>admin.E002</strong>: The value of <code class="docutils literal"><span class="pre">raw_id_fields[n]</span></code> refers to <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>,
which is not an attribute of <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E003</strong>: The value of <code class="docutils literal"><span class="pre">raw_id_fields[n]</span></code> must be a <code class="docutils literal"><span class="pre">ForeignKey</span></code> or
<code class="docutils literal"><span class="pre">ManyToManyField</span></code>.</li>
<li><strong>admin.E004</strong>: The value of <code class="docutils literal"><span class="pre">fields</span></code> must be a list or tuple.</li>
<li><strong>admin.E005</strong>: Both <code class="docutils literal"><span class="pre">fieldsets</span></code> and <code class="docutils literal"><span class="pre">fields</span></code> are specified.</li>
<li><strong>admin.E006</strong>: The value of <code class="docutils literal"><span class="pre">fields</span></code> contains duplicate field(s).</li>
<li><strong>admin.E007</strong>: The value of <code class="docutils literal"><span class="pre">fieldsets</span></code> must be a list or tuple.</li>
<li><strong>admin.E008</strong>: The value of <code class="docutils literal"><span class="pre">fieldsets[n]</span></code> must be a list or tuple.</li>
<li><strong>admin.E009</strong>: The value of <code class="docutils literal"><span class="pre">fieldsets[n]</span></code> must be of length 2.</li>
<li><strong>admin.E010</strong>: The value of <code class="docutils literal"><span class="pre">fieldsets[n][1]</span></code> must be a dictionary.</li>
<li><strong>admin.E011</strong>: The value of <code class="docutils literal"><span class="pre">fieldsets[n][1]</span></code> must contain the key
<code class="docutils literal"><span class="pre">fields</span></code>.</li>
<li><strong>admin.E012</strong>: There are duplicate field(s) in <code class="docutils literal"><span class="pre">fieldsets[n][1]</span></code>.</li>
<li><strong>admin.E013</strong>: <code class="docutils literal"><span class="pre">fields[n]/fieldsets[n][m]</span></code> cannot include the
<code class="docutils literal"><span class="pre">ManyToManyField</span></code> <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>, because that field manually specifies a
relationship model.</li>
<li><strong>admin.E014</strong>: The value of <code class="docutils literal"><span class="pre">exclude</span></code> must be a list or tuple.</li>
<li><strong>admin.E015</strong>: The value of <code class="docutils literal"><span class="pre">exclude</span></code> contains duplicate field(s).</li>
<li><strong>admin.E016</strong>: The value of <code class="docutils literal"><span class="pre">form</span></code> must inherit from <code class="docutils literal"><span class="pre">BaseModelForm</span></code>.</li>
<li><strong>admin.E017</strong>: The value of <code class="docutils literal"><span class="pre">filter_vertical</span></code> must be a list or tuple.</li>
<li><strong>admin.E018</strong>: The value of <code class="docutils literal"><span class="pre">filter_horizontal</span></code> must be a list or tuple.</li>
<li><strong>admin.E019</strong>: The value of <code class="docutils literal"><span class="pre">filter_vertical[n]/filter_vertical[n]</span></code> refers
to <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>, which is not an attribute of <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E020</strong>: The value of <code class="docutils literal"><span class="pre">filter_vertical[n]/filter_vertical[n]</span></code> must
be a <code class="docutils literal"><span class="pre">ManyToManyField</span></code>.</li>
<li><strong>admin.E021</strong>: The value of <code class="docutils literal"><span class="pre">radio_fields</span></code> must be a dictionary.</li>
<li><strong>admin.E022</strong>: The value of <code class="docutils literal"><span class="pre">radio_fields</span></code> refers to <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>,
which is not an attribute of <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E023</strong>: The value of <code class="docutils literal"><span class="pre">radio_fields</span></code> refers to <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>,
which is not a <code class="docutils literal"><span class="pre">ForeignKey</span></code>, and does not have a <code class="docutils literal"><span class="pre">choices</span></code> definition.</li>
<li><strong>admin.E024</strong>: The value of <code class="docutils literal"><span class="pre">radio_fields[<field</span> <span class="pre">name>]</span></code> must be either
<code class="docutils literal"><span class="pre">admin.HORIZONTAL</span></code> or <code class="docutils literal"><span class="pre">admin.VERTICAL</span></code>.</li>
<li><strong>admin.E025</strong>: The value of <code class="docutils literal"><span class="pre">view_on_site</span></code> must be either a callable or a
boolean value.</li>
<li><strong>admin.E026</strong>: The value of <code class="docutils literal"><span class="pre">prepopulated_fields</span></code> must be a dictionary.</li>
<li><strong>admin.E027</strong>: The value of <code class="docutils literal"><span class="pre">prepopulated_fields</span></code> refers to
<code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>, which is not an attribute of <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E028</strong>: The value of <code class="docutils literal"><span class="pre">prepopulated_fields</span></code> refers to
<code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>, which must not be a <code class="docutils literal"><span class="pre">DateTimeField</span></code>, <code class="docutils literal"><span class="pre">ForeignKey</span></code> or
<code class="docutils literal"><span class="pre">ManyToManyField</span></code>.</li>
<li><strong>admin.E029</strong>: The value of <code class="docutils literal"><span class="pre">prepopulated_fields[<field</span> <span class="pre">name>]</span></code> must be a
list or tuple.</li>
<li><strong>admin.E030</strong>: The value of <code class="docutils literal"><span class="pre">prepopulated_fields</span></code> refers to
<code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>, which is not an attribute of <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E031</strong>: The value of <code class="docutils literal"><span class="pre">ordering</span></code> must be a list or tuple.</li>
<li><strong>admin.E032</strong>: The value of <code class="docutils literal"><span class="pre">ordering</span></code> has the random ordering marker
<code class="docutils literal"><span class="pre">?</span></code>, but contains other fields as well.</li>
<li><strong>admin.E033</strong>: The value of <code class="docutils literal"><span class="pre">ordering</span></code> refers to <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>, which
is not an attribute of <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E034</strong>: The value of <code class="docutils literal"><span class="pre">readonly_fields</span></code> must be a list or tuple.</li>
<li><strong>admin.E035</strong>: The value of <code class="docutils literal"><span class="pre">readonly_fields[n]</span></code> is not a callable, an
attribute of <code class="docutils literal"><span class="pre"><ModelAdmin</span> <span class="pre">class></span></code>, or an attribute of <code class="docutils literal"><span class="pre"><model></span></code>.</li>
</ul>
<div class="section" id="s-modeladmin">
<span id="modeladmin"></span><h4>ModelAdmin<a class="headerlink" href="#modeladmin" title="Permalink to this headline">¶</a></h4>
<p>The following checks are performed on any
<a class="reference internal" href="contrib/admin/index.html#django.contrib.admin.ModelAdmin" title="django.contrib.admin.ModelAdmin"><code class="xref py py-class docutils literal"><span class="pre">ModelAdmin</span></code></a> that is registered
with the admin site:</p>
<ul class="simple">
<li><strong>admin.E101</strong>: The value of <code class="docutils literal"><span class="pre">save_as</span></code> must be a boolean.</li>
<li><strong>admin.E102</strong>: The value of <code class="docutils literal"><span class="pre">save_on_top</span></code> must be a boolean.</li>
<li><strong>admin.E103</strong>: The value of <code class="docutils literal"><span class="pre">inlines</span></code> must be a list or tuple.</li>
<li><strong>admin.E104</strong>: <code class="docutils literal"><span class="pre"><InlineModelAdmin</span> <span class="pre">class></span></code> must inherit from
<code class="docutils literal"><span class="pre">BaseModelAdmin</span></code>.</li>
<li><strong>admin.E105</strong>: <code class="docutils literal"><span class="pre"><InlineModelAdmin</span> <span class="pre">class></span></code> must have a <code class="docutils literal"><span class="pre">model</span></code> attribute.</li>
<li><strong>admin.E106</strong>: The value of <code class="docutils literal"><span class="pre"><InlineModelAdmin</span> <span class="pre">class>.model</span></code> must be a
<code class="docutils literal"><span class="pre">Model</span></code>.</li>
<li><strong>admin.E107</strong>: The value of <code class="docutils literal"><span class="pre">list_display</span></code> must be a list or tuple.</li>
<li><strong>admin.E108</strong>: The value of <code class="docutils literal"><span class="pre">list_display[n]</span></code> refers to <code class="docutils literal"><span class="pre"><label></span></code>,
which is not a callable, an attribute of <code class="docutils literal"><span class="pre"><ModelAdmin</span> <span class="pre">class></span></code>, or an
attribute or method on <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E109</strong>: The value of <code class="docutils literal"><span class="pre">list_display[n]</span></code> must not be a
<code class="docutils literal"><span class="pre">ManyToManyField</span></code>.</li>
<li><strong>admin.E110</strong>: The value of <code class="docutils literal"><span class="pre">list_display_links</span></code> must be a list, a tuple,
or <code class="docutils literal"><span class="pre">None</span></code>.</li>
<li><strong>admin.E111</strong>: The value of <code class="docutils literal"><span class="pre">list_display_links[n]</span></code> refers to <code class="docutils literal"><span class="pre"><label></span></code>,
which is not defined in <code class="docutils literal"><span class="pre">list_display</span></code>.</li>
<li><strong>admin.E112</strong>: The value of <code class="docutils literal"><span class="pre">list_filter</span></code> must be a list or tuple.</li>
<li><strong>admin.E113</strong>: The value of <code class="docutils literal"><span class="pre">list_filter[n]</span></code> must inherit from
<code class="docutils literal"><span class="pre">ListFilter</span></code>.</li>
<li><strong>admin.E114</strong>: The value of <code class="docutils literal"><span class="pre">list_filter[n]</span></code> must not inherit from
<code class="docutils literal"><span class="pre">FieldListFilter</span></code>.</li>
<li><strong>admin.E115</strong>: The value of <code class="docutils literal"><span class="pre">list_filter[n][1]</span></code> must inherit from
<code class="docutils literal"><span class="pre">FieldListFilter</span></code>.</li>
<li><strong>admin.E116</strong>: The value of <code class="docutils literal"><span class="pre">list_filter[n]</span></code> refers to <code class="docutils literal"><span class="pre"><label></span></code>,
which does not refer to a Field.</li>
<li><strong>admin.E117</strong>: The value of <code class="docutils literal"><span class="pre">list_select_related</span></code> must be a boolean,
tuple or list.</li>
<li><strong>admin.E118</strong>: The value of <code class="docutils literal"><span class="pre">list_per_page</span></code> must be an integer.</li>
<li><strong>admin.E119</strong>: The value of <code class="docutils literal"><span class="pre">list_max_show_all</span></code> must be an integer.</li>
<li><strong>admin.E120</strong>: The value of <code class="docutils literal"><span class="pre">list_editable</span></code> must be a list or tuple.</li>
<li><strong>admin.E121</strong>: The value of <code class="docutils literal"><span class="pre">list_editable[n]</span></code> refers to <code class="docutils literal"><span class="pre"><label></span></code>,
which is not an attribute of <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E122</strong>: The value of <code class="docutils literal"><span class="pre">list_editable[n]</span></code> refers to <code class="docutils literal"><span class="pre"><label></span></code>,
which is not contained in <code class="docutils literal"><span class="pre">list_display</span></code>.</li>
<li><strong>admin.E123</strong>: The value of <code class="docutils literal"><span class="pre">list_editable[n]</span></code> cannot be in both
<code class="docutils literal"><span class="pre">list_editable</span></code> and <code class="docutils literal"><span class="pre">list_display_links</span></code>.</li>
<li><strong>admin.E124</strong>: The value of <code class="docutils literal"><span class="pre">list_editable[n]</span></code> refers to the first field
in <code class="docutils literal"><span class="pre">list_display</span></code> (<code class="docutils literal"><span class="pre"><label></span></code>), which cannot be used unless
<code class="docutils literal"><span class="pre">list_display_links</span></code> is set.</li>
<li><strong>admin.E125</strong>: The value of <code class="docutils literal"><span class="pre">list_editable[n]</span></code> refers to <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>,
which is not editable through the admin.</li>
<li><strong>admin.E126</strong>: The value of <code class="docutils literal"><span class="pre">search_fields</span></code> must be a list or tuple.</li>
<li><strong>admin.E127</strong>: The value of <code class="docutils literal"><span class="pre">date_hierarchy</span></code> refers to <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>,
which is not an attribute of <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E128</strong>: The value of <code class="docutils literal"><span class="pre">date_hierarchy</span></code> must be a <code class="docutils literal"><span class="pre">DateField</span></code> or
<code class="docutils literal"><span class="pre">DateTimeField</span></code>.</li>
</ul>
</div>
<div class="section" id="s-inlinemodeladmin">
<span id="inlinemodeladmin"></span><h4>InlineModelAdmin<a class="headerlink" href="#inlinemodeladmin" title="Permalink to this headline">¶</a></h4>
<p>The following checks are performed on any
<a class="reference internal" href="contrib/admin/index.html#django.contrib.admin.InlineModelAdmin" title="django.contrib.admin.InlineModelAdmin"><code class="xref py py-class docutils literal"><span class="pre">InlineModelAdmin</span></code></a> that is registered as an
inline on a <a class="reference internal" href="contrib/admin/index.html#django.contrib.admin.ModelAdmin" title="django.contrib.admin.ModelAdmin"><code class="xref py py-class docutils literal"><span class="pre">ModelAdmin</span></code></a>.</p>
<ul class="simple">
<li><strong>admin.E201</strong>: Cannot exclude the field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>, because it is the
foreign key to the parent model <code class="docutils literal"><span class="pre"><app_label>.<model></span></code>.</li>
<li><strong>admin.E202</strong>: <code class="docutils literal"><span class="pre"><model></span></code> has no <code class="docutils literal"><span class="pre">ForeignKey</span></code> to <code class="docutils literal"><span class="pre"><parent</span> <span class="pre">model></span></code>./
<code class="docutils literal"><span class="pre"><model></span></code> has more than one <code class="docutils literal"><span class="pre">ForeignKey</span></code> to <code class="docutils literal"><span class="pre"><parent</span> <span class="pre">model></span></code>.</li>
<li><strong>admin.E203</strong>: The value of <code class="docutils literal"><span class="pre">extra</span></code> must be an integer.</li>
<li><strong>admin.E204</strong>: The value of <code class="docutils literal"><span class="pre">max_num</span></code> must be an integer.</li>
<li><strong>admin.E205</strong>: The value of <code class="docutils literal"><span class="pre">min_num</span></code> must be an integer.</li>
<li><strong>admin.E206</strong>: The value of <code class="docutils literal"><span class="pre">formset</span></code> must inherit from
<code class="docutils literal"><span class="pre">BaseModelFormSet</span></code>.</li>
</ul>
</div>
<div class="section" id="s-genericinlinemodeladmin">
<span id="genericinlinemodeladmin"></span><h4>GenericInlineModelAdmin<a class="headerlink" href="#genericinlinemodeladmin" title="Permalink to this headline">¶</a></h4>
<p>The following checks are performed on any
<a class="reference internal" href="contrib/contenttypes.html#django.contrib.contenttypes.admin.GenericInlineModelAdmin" title="django.contrib.contenttypes.admin.GenericInlineModelAdmin"><code class="xref py py-class docutils literal"><span class="pre">GenericInlineModelAdmin</span></code></a> that is
registered as an inline on a <a class="reference internal" href="contrib/admin/index.html#django.contrib.admin.ModelAdmin" title="django.contrib.admin.ModelAdmin"><code class="xref py py-class docutils literal"><span class="pre">ModelAdmin</span></code></a>.</p>
<ul class="simple">
<li><strong>admin.E301</strong>: <code class="docutils literal"><span class="pre">'ct_field'</span></code> references <code class="docutils literal"><span class="pre"><label></span></code>, which is not a field
on <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E302</strong>: <code class="docutils literal"><span class="pre">'ct_fk_field'</span></code> references <code class="docutils literal"><span class="pre"><label></span></code>, which is not a
field on <code class="docutils literal"><span class="pre"><model></span></code>.</li>
<li><strong>admin.E303</strong>: <code class="docutils literal"><span class="pre"><model></span></code> has no <code class="docutils literal"><span class="pre">GenericForeignKey</span></code>.</li>
<li><strong>admin.E304</strong>: <code class="docutils literal"><span class="pre"><model></span></code> has no <code class="docutils literal"><span class="pre">GenericForeignKey</span></code> using content type
field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code> and object ID field <code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>.</li>
</ul>
</div>
</div>
<div class="section" id="s-auth">
<span id="auth"></span><h3>Auth<a class="headerlink" href="#auth" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><strong>auth.E001</strong>: <code class="docutils literal"><span class="pre">REQUIRED_FIELDS</span></code> must be a list or tuple.</li>
<li><strong>auth.E002</strong>: The field named as the <code class="docutils literal"><span class="pre">USERNAME_FIELD</span></code> for a custom user
model must not be included in <code class="docutils literal"><span class="pre">REQUIRED_FIELDS</span></code>.</li>
<li><strong>auth.E003</strong>: <code class="docutils literal"><span class="pre"><field></span></code> must be unique because it is named as the
<code class="docutils literal"><span class="pre">USERNAME_FIELD</span></code>.</li>
<li><strong>auth.W004</strong>: <code class="docutils literal"><span class="pre"><field></span></code> is named as the <code class="docutils literal"><span class="pre">USERNAME_FIELD</span></code>, but it is not
unique.</li>
</ul>
</div>
<div class="section" id="s-content-types">
<span id="content-types"></span><h3>Content Types<a class="headerlink" href="#content-types" title="Permalink to this headline">¶</a></h3>
<p>The following checks are performed when a model contains a
<a class="reference internal" href="contrib/contenttypes.html#django.contrib.contenttypes.fields.GenericForeignKey" title="django.contrib.contenttypes.fields.GenericForeignKey"><code class="xref py py-class docutils literal"><span class="pre">GenericForeignKey</span></code></a> or
<a class="reference internal" href="contrib/contenttypes.html#django.contrib.contenttypes.fields.GenericRelation" title="django.contrib.contenttypes.fields.GenericRelation"><code class="xref py py-class docutils literal"><span class="pre">GenericRelation</span></code></a>:</p>
<ul class="simple">
<li><strong>contenttypes.E001</strong>: The <code class="docutils literal"><span class="pre">GenericForeignKey</span></code> object ID references the
non-existent field <code class="docutils literal"><span class="pre"><field></span></code>.</li>
<li><strong>contenttypes.E002</strong>: The <code class="docutils literal"><span class="pre">GenericForeignKey</span></code> content type references the
non-existent field <code class="docutils literal"><span class="pre"><field></span></code>.</li>
<li><strong>contenttypes.E003</strong>: <code class="docutils literal"><span class="pre"><field></span></code> is not a <code class="docutils literal"><span class="pre">ForeignKey</span></code>.</li>
<li><strong>contenttypes.E004</strong>: <code class="docutils literal"><span class="pre"><field></span></code> is not a <code class="docutils literal"><span class="pre">ForeignKey</span></code> to
<code class="docutils literal"><span class="pre">contenttypes.ContentType</span></code>.</li>
</ul>
</div>
<div class="section" id="s-security">
<span id="security"></span><h3>Security<a class="headerlink" href="#security" title="Permalink to this headline">¶</a></h3>
<p>The security checks do not make your site secure. They do not audit code, do
intrusion detection, or do anything particularly complex. Rather, they help
perform an automated, low-hanging-fruit checklist. They help you remember the
simple things that improve your site’s security.</p>
<p>Some of these checks may not be appropriate for your particular deployment
configuration. For instance, if you do your HTTP to HTTPS redirection in a load
balancer, it’d be irritating to be constantly warned about not having enabled
<a class="reference internal" href="settings.html#std:setting-SECURE_SSL_REDIRECT"><code class="xref std std-setting docutils literal"><span class="pre">SECURE_SSL_REDIRECT</span></code></a>. Use <a class="reference internal" href="settings.html#std:setting-SILENCED_SYSTEM_CHECKS"><code class="xref std std-setting docutils literal"><span class="pre">SILENCED_SYSTEM_CHECKS</span></code></a> to
silence unneeded checks.</p>
<p>The following checks will be run if you use the <a class="reference internal" href="django-admin.html#django-admin-option---deploy"><code class="xref std std-djadminopt docutils literal"><span class="pre">--deploy</span></code></a> option
of the <a class="reference internal" href="django-admin.html#django-admin-check"><code class="xref std std-djadmin docutils literal"><span class="pre">check</span></code></a> command:</p>
<ul class="simple">
<li><strong>security.W001</strong>: You do not have
<a class="reference internal" href="middleware.html#django.middleware.security.SecurityMiddleware" title="django.middleware.security.SecurityMiddleware"><code class="xref py py-class docutils literal"><span class="pre">django.middleware.security.SecurityMiddleware</span></code></a> in your
<a class="reference internal" href="settings.html#std:setting-MIDDLEWARE_CLASSES"><code class="xref std std-setting docutils literal"><span class="pre">MIDDLEWARE_CLASSES</span></code></a> so the <a class="reference internal" href="settings.html#std:setting-SECURE_HSTS_SECONDS"><code class="xref std std-setting docutils literal"><span class="pre">SECURE_HSTS_SECONDS</span></code></a>,
<a class="reference internal" href="settings.html#std:setting-SECURE_CONTENT_TYPE_NOSNIFF"><code class="xref std std-setting docutils literal"><span class="pre">SECURE_CONTENT_TYPE_NOSNIFF</span></code></a>, <a class="reference internal" href="settings.html#std:setting-SECURE_BROWSER_XSS_FILTER"><code class="xref std std-setting docutils literal"><span class="pre">SECURE_BROWSER_XSS_FILTER</span></code></a>,
and <a class="reference internal" href="settings.html#std:setting-SECURE_SSL_REDIRECT"><code class="xref std std-setting docutils literal"><span class="pre">SECURE_SSL_REDIRECT</span></code></a> settings will have no effect.</li>
<li><strong>security.W002</strong>: You do not have
<a class="reference internal" href="middleware.html#django.middleware.clickjacking.XFrameOptionsMiddleware" title="django.middleware.clickjacking.XFrameOptionsMiddleware"><code class="xref py py-class docutils literal"><span class="pre">django.middleware.clickjacking.XFrameOptionsMiddleware</span></code></a> in your
<a class="reference internal" href="settings.html#std:setting-MIDDLEWARE_CLASSES"><code class="xref std std-setting docutils literal"><span class="pre">MIDDLEWARE_CLASSES</span></code></a>, so your pages will not be served with an
<code class="docutils literal"><span class="pre">'x-frame-options'</span></code> header. Unless there is a good reason for your
site to be served in a frame, you should consider enabling this
header to help prevent clickjacking attacks.</li>
<li><strong>security.W003</strong>: You don’t appear to be using Django’s built-in cross-site
request forgery protection via the middleware
(<a class="reference internal" href="middleware.html#django.middleware.csrf.CsrfViewMiddleware" title="django.middleware.csrf.CsrfViewMiddleware"><code class="xref py py-class docutils literal"><span class="pre">django.middleware.csrf.CsrfViewMiddleware</span></code></a> is not in your
<a class="reference internal" href="settings.html#std:setting-MIDDLEWARE_CLASSES"><code class="xref std std-setting docutils literal"><span class="pre">MIDDLEWARE_CLASSES</span></code></a>). Enabling the middleware is the safest
approach to ensure you don’t leave any holes.</li>
<li><strong>security.W004</strong>: You have not set a value for the
<a class="reference internal" href="settings.html#std:setting-SECURE_HSTS_SECONDS"><code class="xref std std-setting docutils literal"><span class="pre">SECURE_HSTS_SECONDS</span></code></a> setting. If your entire site is served only
over SSL, you may want to consider setting a value and enabling <a class="reference internal" href="middleware.html#http-strict-transport-security"><span class="std std-ref">HTTP
Strict Transport Security</span></a>. Be sure to read
the documentation first; enabling HSTS carelessly can cause serious,
irreversible problems.</li>
<li><strong>security.W005</strong>: You have not set the
<a class="reference internal" href="settings.html#std:setting-SECURE_HSTS_INCLUDE_SUBDOMAINS"><code class="xref std std-setting docutils literal"><span class="pre">SECURE_HSTS_INCLUDE_SUBDOMAINS</span></code></a> setting to <code class="docutils literal"><span class="pre">True</span></code>. Without this,
your site is potentially vulnerable to attack via an insecure connection to a
subdomain. Only set this to <code class="docutils literal"><span class="pre">True</span></code> if you are certain that all subdomains of
your domain should be served exclusively via SSL.</li>
<li><strong>security.W006</strong>: Your <a class="reference internal" href="settings.html#std:setting-SECURE_CONTENT_TYPE_NOSNIFF"><code class="xref std std-setting docutils literal"><span class="pre">SECURE_CONTENT_TYPE_NOSNIFF</span></code></a> setting is not
set to <code class="docutils literal"><span class="pre">True</span></code>, so your pages will not be served with an
<code class="docutils literal"><span class="pre">'x-content-type-options:</span> <span class="pre">nosniff'</span></code> header. You should consider enabling
this header to prevent the browser from identifying content types incorrectly.</li>
<li><strong>security.W007</strong>: Your <a class="reference internal" href="settings.html#std:setting-SECURE_BROWSER_XSS_FILTER"><code class="xref std std-setting docutils literal"><span class="pre">SECURE_BROWSER_XSS_FILTER</span></code></a> setting is not
set to <code class="docutils literal"><span class="pre">True</span></code>, so your pages will not be served with an
<code class="docutils literal"><span class="pre">'x-xss-protection:</span> <span class="pre">1;</span> <span class="pre">mode=block'</span></code> header. You should consider enabling
this header to activate the browser’s XSS filtering and help prevent XSS
attacks.</li>
<li><strong>security.W008</strong>: Your <a class="reference internal" href="settings.html#std:setting-SECURE_SSL_REDIRECT"><code class="xref std std-setting docutils literal"><span class="pre">SECURE_SSL_REDIRECT</span></code></a> setting is not set to
<code class="docutils literal"><span class="pre">True</span></code>. Unless your site should be available over both SSL and non-SSL
connections, you may want to either set this setting to <code class="docutils literal"><span class="pre">True</span></code> or configure
a load balancer or reverse-proxy server to redirect all connections to HTTPS.</li>
<li><strong>security.W009</strong>: Your <a class="reference internal" href="settings.html#std:setting-SECRET_KEY"><code class="xref std std-setting docutils literal"><span class="pre">SECRET_KEY</span></code></a> has less than 50 characters or
less than 5 unique characters. Please generate a long and random
<code class="docutils literal"><span class="pre">SECRET_KEY</span></code>, otherwise many of Django’s security-critical features will be
vulnerable to attack.</li>
<li><strong>security.W010</strong>: You have <a class="reference internal" href="../topics/http/sessions.html#module-django.contrib.sessions" title="django.contrib.sessions: Provides session management for Django projects."><code class="xref py py-mod docutils literal"><span class="pre">django.contrib.sessions</span></code></a> in your
<a class="reference internal" href="settings.html#std:setting-INSTALLED_APPS"><code class="xref std std-setting docutils literal"><span class="pre">INSTALLED_APPS</span></code></a> but you have not set
<a class="reference internal" href="settings.html#std:setting-SESSION_COOKIE_SECURE"><code class="xref std std-setting docutils literal"><span class="pre">SESSION_COOKIE_SECURE</span></code></a> to <code class="docutils literal"><span class="pre">True</span></code>. Using a secure-only session
cookie makes it more difficult for network traffic sniffers to hijack user
sessions.</li>
<li><strong>security.W011</strong>: You have
<a class="reference internal" href="middleware.html#django.contrib.sessions.middleware.SessionMiddleware" title="django.contrib.sessions.middleware.SessionMiddleware"><code class="xref py py-class docutils literal"><span class="pre">django.contrib.sessions.middleware.SessionMiddleware</span></code></a> in your
<a class="reference internal" href="settings.html#std:setting-MIDDLEWARE_CLASSES"><code class="xref std std-setting docutils literal"><span class="pre">MIDDLEWARE_CLASSES</span></code></a>, but you have not set
<a class="reference internal" href="settings.html#std:setting-SESSION_COOKIE_SECURE"><code class="xref std std-setting docutils literal"><span class="pre">SESSION_COOKIE_SECURE</span></code></a> to <code class="docutils literal"><span class="pre">True</span></code>. Using a secure-only session
cookie makes it more difficult for network traffic sniffers to hijack user
sessions.</li>
<li><strong>security.W012</strong>: <a class="reference internal" href="settings.html#std:setting-SESSION_COOKIE_SECURE"><code class="xref std std-setting docutils literal"><span class="pre">SESSION_COOKIE_SECURE</span></code></a> is not set to <code class="docutils literal"><span class="pre">True</span></code>.
Using a secure-only session cookie makes it more difficult for network traffic
sniffers to hijack user sessions.</li>
<li><strong>security.W013</strong>: You have <a class="reference internal" href="../topics/http/sessions.html#module-django.contrib.sessions" title="django.contrib.sessions: Provides session management for Django projects."><code class="xref py py-mod docutils literal"><span class="pre">django.contrib.sessions</span></code></a> in your
<a class="reference internal" href="settings.html#std:setting-INSTALLED_APPS"><code class="xref std std-setting docutils literal"><span class="pre">INSTALLED_APPS</span></code></a>, but you have not set
<a class="reference internal" href="settings.html#std:setting-SESSION_COOKIE_HTTPONLY"><code class="xref std std-setting docutils literal"><span class="pre">SESSION_COOKIE_HTTPONLY</span></code></a> to <code class="docutils literal"><span class="pre">True</span></code>. Using an <code class="docutils literal"><span class="pre">HttpOnly</span></code> session
cookie makes it more difficult for cross-site scripting attacks to hijack user
sessions.</li>
<li><strong>security.W014</strong>: You have
<a class="reference internal" href="middleware.html#django.contrib.sessions.middleware.SessionMiddleware" title="django.contrib.sessions.middleware.SessionMiddleware"><code class="xref py py-class docutils literal"><span class="pre">django.contrib.sessions.middleware.SessionMiddleware</span></code></a> in your
<a class="reference internal" href="settings.html#std:setting-MIDDLEWARE_CLASSES"><code class="xref std std-setting docutils literal"><span class="pre">MIDDLEWARE_CLASSES</span></code></a>, but you have not set
<a class="reference internal" href="settings.html#std:setting-SESSION_COOKIE_HTTPONLY"><code class="xref std std-setting docutils literal"><span class="pre">SESSION_COOKIE_HTTPONLY</span></code></a> to <code class="docutils literal"><span class="pre">True</span></code>. Using an <code class="docutils literal"><span class="pre">HttpOnly</span></code> session
cookie makes it more difficult for cross-site scripting attacks to hijack user
sessions.</li>
<li><strong>security.W015</strong>: <a class="reference internal" href="settings.html#std:setting-SESSION_COOKIE_HTTPONLY"><code class="xref std std-setting docutils literal"><span class="pre">SESSION_COOKIE_HTTPONLY</span></code></a> is not set to <code class="docutils literal"><span class="pre">True</span></code>.
Using an <code class="docutils literal"><span class="pre">HttpOnly</span></code> session cookie makes it more difficult for cross-site
scripting attacks to hijack user sessions.</li>
<li><strong>security.W016</strong>: <a class="reference internal" href="settings.html#std:setting-CSRF_COOKIE_SECURE"><code class="xref std std-setting docutils literal"><span class="pre">CSRF_COOKIE_SECURE</span></code></a> is not set to <code class="docutils literal"><span class="pre">True</span></code>.
Using a secure-only CSRF cookie makes it more difficult for network traffic
sniffers to steal the CSRF token.</li>
<li><strong>security.W017</strong>: <a class="reference internal" href="settings.html#std:setting-CSRF_COOKIE_HTTPONLY"><code class="xref std std-setting docutils literal"><span class="pre">CSRF_COOKIE_HTTPONLY</span></code></a> is not set to <code class="docutils literal"><span class="pre">True</span></code>.
Using an <code class="docutils literal"><span class="pre">HttpOnly</span></code> CSRF cookie makes it more difficult for cross-site
scripting attacks to steal the CSRF token.</li>
<li><strong>security.W018</strong>: You should not have <a class="reference internal" href="settings.html#std:setting-DEBUG"><code class="xref std std-setting docutils literal"><span class="pre">DEBUG</span></code></a> set to <code class="docutils literal"><span class="pre">True</span></code> in
deployment.</li>
<li><strong>security.W019</strong>: You have
<a class="reference internal" href="middleware.html#django.middleware.clickjacking.XFrameOptionsMiddleware" title="django.middleware.clickjacking.XFrameOptionsMiddleware"><code class="xref py py-class docutils literal"><span class="pre">django.middleware.clickjacking.XFrameOptionsMiddleware</span></code></a> in your
<a class="reference internal" href="settings.html#std:setting-MIDDLEWARE_CLASSES"><code class="xref std std-setting docutils literal"><span class="pre">MIDDLEWARE_CLASSES</span></code></a>, but <a class="reference internal" href="settings.html#std:setting-X_FRAME_OPTIONS"><code class="xref std std-setting docutils literal"><span class="pre">X_FRAME_OPTIONS</span></code></a> is not set to
<code class="docutils literal"><span class="pre">'DENY'</span></code>. The default is <code class="docutils literal"><span class="pre">'SAMEORIGIN'</span></code>, but unless there is a good reason
for your site to serve other parts of itself in a frame, you should change
it to <code class="docutils literal"><span class="pre">'DENY'</span></code>.</li>
</ul>
</div>
<div class="section" id="s-sites">
<span id="sites"></span><h3>Sites<a class="headerlink" href="#sites" title="Permalink to this headline">¶</a></h3>
<p>The following checks are performed on any model using a
<a class="reference internal" href="contrib/sites.html#django.contrib.sites.managers.CurrentSiteManager" title="django.contrib.sites.managers.CurrentSiteManager"><code class="xref py py-class docutils literal"><span class="pre">CurrentSiteManager</span></code></a>:</p>
<ul class="simple">
<li><strong>sites.E001</strong>: <code class="docutils literal"><span class="pre">CurrentSiteManager</span></code> could not find a field named
<code class="docutils literal"><span class="pre"><field</span> <span class="pre">name></span></code>.</li>
<li><strong>sites.E002</strong>: <code class="docutils literal"><span class="pre">CurrentSiteManager</span></code> cannot use <code class="docutils literal"><span class="pre"><field></span></code> as it is not a
<code class="docutils literal"><span class="pre">ForeignKey</span></code> or <code class="docutils literal"><span class="pre">ManyToManyField</span></code>.</li>
</ul>
</div>
<div class="section" id="s-database">
<span id="database"></span><h3>Database<a class="headerlink" href="#database" title="Permalink to this headline">¶</a></h3>
<div class="section" id="s-mysql">
<span id="mysql"></span><h4>MySQL<a class="headerlink" href="#mysql" title="Permalink to this headline">¶</a></h4>
<p>If you’re using MySQL, the following checks will be performed:</p>
<ul class="simple">
<li><strong>mysql.E001</strong>: MySQL does not allow unique <code class="docutils literal"><span class="pre">CharField</span></code>s to have a
<code class="docutils literal"><span class="pre">max_length</span></code> > 255.</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">System check framework</a><ul>
<li><a class="reference internal" href="#api-reference">API Reference</a><ul>
<li><a class="reference internal" href="#checkmessage"><code class="docutils literal"><span class="pre">CheckMessage</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#builtin-checks">Builtin checks</a><ul>
<li><a class="reference internal" href="#builtin-tags">Builtin tags</a></li>
<li><a class="reference internal" href="#core-system-checks">Core system checks</a><ul>
<li><a class="reference internal" href="#models">Models</a></li>
<li><a class="reference internal" href="#fields">Fields</a></li>
<li><a class="reference internal" href="#file-fields">File Fields</a></li>
<li><a class="reference internal" href="#related-fields">Related Fields</a></li>
<li><a class="reference internal" href="#signals">Signals</a></li>
<li><a class="reference internal" href="#backwards-compatibility">Backwards Compatibility</a></li>
</ul>
</li>
<li><a class="reference internal" href="#admin">Admin</a><ul>
<li><a class="reference internal" href="#modeladmin">ModelAdmin</a></li>
<li><a class="reference internal" href="#inlinemodeladmin">InlineModelAdmin</a></li>
<li><a class="reference internal" href="#genericinlinemodeladmin">GenericInlineModelAdmin</a></li>
</ul>
</li>
<li><a class="reference internal" href="#auth">Auth</a></li>
<li><a class="reference internal" href="#content-types">Content Types</a></li>
<li><a class="reference internal" href="#security">Security</a></li>
<li><a class="reference internal" href="#sites">Sites</a></li>
<li><a class="reference internal" href="#database">Database</a><ul>
<li><a class="reference internal" href="#mysql">MySQL</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h3>Browse</h3>
<ul>
<li>Prev: <a href="applications.html">Applications</a></li>
<li>Next: <a href="class-based-views/index.html">Built-in class-based views API</a></li>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../index.html">Django 1.8.19 documentation</a>
<ul><li><a href="index.html">API Reference</a>
<ul><li>System check framework</li></ul>
</li></ul>
</li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/ref/checks.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Jan 06, 2019</p>
</div>
</div>
<div id="ft">
<div class="nav">
« <a href="applications.html" title="Applications">previous</a>
|
<a href="index.html" title="API Reference" accesskey="U">up</a>
|
<a href="class-based-views/index.html" title="Built-in class-based views API">next</a> »</div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
3f388dbb5c0ba9abe7c510467d6cc65d
>
files
>
683
