Debian Codegraph @

docs/ref/checks.txt

raw
1 ======================
2 System check framework
3 ======================
4
5 .. currentmodule:: django.core.checks
6
7 The system check framework is a set of static checks for validating Django
8 projects. It detects common problems and provides hints for how to fix them.
9 The framework is extensible so you can easily add your own checks.
10
11 For details on how to add your own checks and integrate them with Django's
12 system checks, see the :doc:`System check topic guide </topics/checks>`.
13
14 API reference
15 =============
16
17 ``CheckMessage``
18 ----------------
19
20 .. class:: CheckMessage(level, msg, hint=None, obj=None, id=None)
21
22 The warnings and errors raised by system checks must be instances of
23 ``CheckMessage``. An instance encapsulates a single reportable error or
24 warning. It also provides context and hints applicable to the message, and a
25 unique identifier that is used for filtering purposes.
26
27 Constructor arguments are:
28
29 ``level``
30 The severity of the message. Use one of the predefined values: ``DEBUG``,
31 ``INFO``, ``WARNING``, ``ERROR``, ``CRITICAL``. If the level is greater or
32 equal to ``ERROR``, then Django will prevent management commands from
33 executing. Messages with level lower than ``ERROR`` (i.e. warnings) are
34 reported to the console, but can be silenced.
35
36 ``msg``
37 A short (less than 80 characters) string describing the problem. The string
38 should *not* contain newlines.
39
40 ``hint``
41 A single-line string providing a hint for fixing the problem. If no hint
42 can be provided, or the hint is self-evident from the error message, the
43 hint can be omitted, or a value of ``None`` can be used.
44
45 ``obj``
46 Optional. An object providing context for the message (for example, the
47 model where the problem was discovered). The object should be a model,
48 field, or manager or any other object that defines a ``__str__()`` method.
49 The method is used while reporting all messages and its result precedes the
50 message.
51
52 ``id``
53 Optional string. A unique identifier for the issue. Identifiers should
54 follow the pattern ``applabel.X001``, where ``X`` is one of the letters
55 ``CEWID``, indicating the message severity (``C`` for criticals, ``E`` for
56 errors and so). The number can be allocated by the application, but should
57 be unique within that application.
58
59 There are subclasses to make creating messages with common levels easier. When
60 using them you can omit the ``level`` argument because it is implied by the
61 class name.
62
63 .. class:: Debug(msg, hint=None, obj=None, id=None)
64 .. class:: Info(msg, hint=None, obj=None, id=None)
65 .. class:: Warning(msg, hint=None, obj=None, id=None)
66 .. class:: Error(msg, hint=None, obj=None, id=None)
67 .. class:: Critical(msg, hint=None, obj=None, id=None)
68
69 .. _system-check-builtin-tags:
70
71 Builtin tags
72 ============
73
74 Django's system checks are organized using the following tags:
75
76 * ``admin``: Checks of any admin site declarations.
77 * ``async_support``: Checks asynchronous-related configuration.
78 * ``caches``: Checks cache related configuration.
79 * ``compatibility``: Flags potential problems with version upgrades.
80 * ``commands``: Checks custom management commands related configuration.
81 * ``database``: Checks database-related configuration issues. Database checks
82 are not run by default because they do more than static code analysis as
83 regular checks do. They are only run by the :djadmin:`migrate` command or if
84 you specify configured database aliases using the ``--database`` option when
85 calling the :djadmin:`check` command.
86 * ``files``: Checks files related configuration.
87 * ``models``: Checks of model, field, and manager definitions.
88 * ``security``: Checks security related configuration.
89 * ``signals``: Checks on signal declarations and handler registrations.
90 * ``sites``: Checks :mod:`django.contrib.sites` configuration.
91 * ``staticfiles``: Checks :mod:`django.contrib.staticfiles` configuration.
92 * ``templates``: Checks template related configuration.
93 * ``translation``: Checks translation related configuration.
94 * ``urls``: Checks URL configuration.
95
96 Some checks may be registered with multiple tags.
97
98 Core system checks
99 ==================
100
101 Asynchronous support
102 --------------------
103
104 The following checks verify your setup for :doc:`/topics/async`:
105
106 * **async.E001**: You should not set the :envvar:`DJANGO_ALLOW_ASYNC_UNSAFE`
107 environment variable in deployment. This disables :ref:`async safety
108 protection <async-safety>`.
109
110 Backwards compatibility
111 -----------------------
112
113 Compatibility checks warn of potential problems that might occur after
114 upgrading Django.
115
116 * **2_0.W001**: Your URL pattern ``<pattern>`` has a ``route`` that contains
117 ``(?P<``, begins with a ``^``, or ends with a ``$``. This was likely an
118 oversight when migrating from ``url()`` to :func:`~django.urls.path`.
119 * **4_0.E001**: As of Django 4.0, the values in the
120 :setting:`CSRF_TRUSTED_ORIGINS` setting must start with a scheme (usually
121 ``http://`` or ``https://``) but found ``<hostname>``.
122
123 Caches
124 ------
125
126 The following checks verify that your :setting:`CACHES` setting is correctly
127 configured:
128
129 * **caches.E001**: You must define a ``'default'`` cache in your
130 :setting:`CACHES` setting.
131 * **caches.W002**: Your ``<cache>`` configuration might expose your cache or
132 lead to corruption of your data because its
133 :setting:`LOCATION <CACHES-LOCATION>` matches/is inside/contains
134 :setting:`MEDIA_ROOT`/:setting:`STATIC_ROOT`/:setting:`STATICFILES_DIRS`.
135 * **caches.W003**: Your ``<cache>`` cache :setting:`LOCATION <CACHES-LOCATION>`
136 is relative. Use an absolute path instead.
137
138 Database
139 --------
140
141 MySQL and MariaDB
142 ~~~~~~~~~~~~~~~~~
143
144 If you're using MySQL or MariaDB, the following checks will be performed:
145
146 * **mysql.E001**: MySQL/MariaDB does not allow unique ``CharField``\s to have a
147 ``max_length`` > 255. *This check was changed to* ``mysql.W003`` *in Django
148 3.1 as the real maximum size depends on many factors.*
149 * **mysql.W002**: MySQL/MariaDB Strict Mode is not set for database connection
150 ``<alias>``. See also :ref:`mysql-sql-mode`.
151 * **mysql.W003**: MySQL/MariaDB may not allow unique ``CharField``\s to have a
152 ``max_length`` > 255.
153
154 Managing files
155 --------------
156
157 The following checks verify your setup for :doc:`/topics/files`:
158
159 * **files.E001**: The :setting:`FILE_UPLOAD_TEMP_DIR` setting refers to the
160 nonexistent directory ``<path>``.
161
162 Model fields
163 ------------
164
165 * **fields.E001**: Field names must not end with an underscore.
166 * **fields.E002**: Field names must not contain ``"__"``.
167 * **fields.E003**: ``pk`` is a reserved word that cannot be used as a field
168 name.
169 * **fields.E004**: ``choices`` must be a mapping (e.g. a dictionary) or an
170 iterable (e.g. a list or tuple).
171 * **fields.E005**: ``choices`` must be a mapping of actual values to human
172 readable names or an iterable containing ``(actual value, human readable
173 name)`` tuples.
174 * **fields.E006**: ``db_index`` must be ``None``, ``True`` or ``False``.
175 * **fields.E007**: Primary keys must not have ``null=True``.
176 * **fields.E008**: All ``validators`` must be callable.
177 * **fields.E009**: ``max_length`` is too small to fit the longest value in
178 ``choices`` (``<count>`` characters).
179 * **fields.E010**: ``<field>`` default should be a callable instead of an
180 instance so that it's not shared between all field instances.
181 * **fields.E011**: ``<database>`` does not support default database values with
182 expressions (``db_default``).
183 * **fields.E012**: ``<expression>`` cannot be used in ``db_default``.
184 * **fields.E013**: ``CompositePrimaryKey`` must be named ``pk``.
185 * **fields.E100**: ``AutoField``\s must set primary_key=True.
186 * **fields.E110**: ``BooleanField``\s do not accept null values. *This check
187 appeared before support for null values was added in Django 2.1.*
188 * **fields.E120**: ``CharField``\s must define a ``max_length`` attribute.
189 * **fields.E121**: ``max_length`` must be a positive integer.
190 * **fields.W122**: ``max_length`` is ignored when used with
191 ``<integer field type>``.
192 * **fields.E130**: ``DecimalField``\s must define a ``decimal_places`` attribute.
193 * **fields.E131**: ``decimal_places`` must be a non-negative integer.
194 * **fields.E132**: ``DecimalField``\s must define a ``max_digits`` attribute.
195 * **fields.E133**: ``max_digits`` must be a positive integer.
196 * **fields.E134**: ``max_digits`` must be greater or equal to ``decimal_places``.
197 * **fields.E140**: ``FilePathField``\s must have either ``allow_files`` or
198 ``allow_folders`` set to True.
199 * **fields.E150**: ``GenericIPAddressField``\s cannot have ``blank=True`` if
200 ``null=False``, as blank values are stored as nulls.
201 * **fields.E160**: The options ``auto_now``, ``auto_now_add``, and ``default``
202 are mutually exclusive. Only one of these options may be present.
203 * **fields.W161**: Fixed default value provided.
204 * **fields.W162**: ``<database>`` does not support a database index on
205 ``<field data type>`` columns.
206 * **fields.W163**: ``<database>`` does not support comments on columns
207 (``db_comment``).
208 * **fields.E170**: ``BinaryField``’s ``default`` cannot be a string. Use bytes
209 content instead.
210 * **fields.E180**: ``<database>`` does not support ``JSONField``\s.
211 * **fields.E190**: ``<database>`` does not support a database collation on
212 ``<field_type>``\s.
213 * **fields.E220**: ``<database>`` does not support ``GeneratedField``\s.
214 * **fields.E221**: ``<database>`` does not support non-persisted
215 ``GeneratedField``\s.
216 * **fields.E222**: ``<database>`` does not support persisted
217 ``GeneratedField``\s.
218 * **fields.E223**: ``GeneratedField.output_field`` has errors: ...
219 * **fields.W224**: ``GeneratedField.output_field`` has warnings: ...
220 * **fields.E900**: ``IPAddressField`` has been removed except for support in
221 historical migrations.
222 * **fields.W900**: ``IPAddressField`` has been deprecated. Support for it
223 (except in historical migrations) will be removed in Django 1.9. *This check
224 appeared in Django 1.7 and 1.8*.
225 * **fields.W901**: ``CommaSeparatedIntegerField`` has been deprecated. Support
226 for it (except in historical migrations) will be removed in Django 2.0. *This
227 check appeared in Django 1.10 and 1.11*.
228 * **fields.E901**: ``CommaSeparatedIntegerField`` is removed except for support
229 in historical migrations.
230 * **fields.W902**: ``FloatRangeField`` is deprecated and will be removed in
231 Django 3.1. *This check appeared in Django 2.2 and 3.0*.
232 * **fields.W903**: ``NullBooleanField`` is deprecated. Support for it (except
233 in historical migrations) will be removed in Django 4.0. *This check appeared
234 in Django 3.1 and 3.2*.
235 * **fields.E903**: ``NullBooleanField`` is removed except for support in
236 historical migrations.
237 * **fields.W904**: ``django.contrib.postgres.fields.JSONField`` is deprecated.
238 Support for it (except in historical migrations) will be removed in Django
239 4.0. *This check appeared in Django 3.1 and 3.2*.
240 * **fields.E904**: ``django.contrib.postgres.fields.JSONField`` is removed
241 except for support in historical migrations.
242 * **fields.W905**: ``django.contrib.postgres.fields.CICharField`` is
243 deprecated. Support for it (except in historical migrations) will be removed
244 in Django 5.1. *This check appeared in Django 4.2 and 5.0*.
245 * **fields.E905**: ``django.contrib.postgres.fields.CICharField`` is removed
246 except for support in historical migrations.
247 * **fields.W906**: ``django.contrib.postgres.fields.CIEmailField`` is
248 deprecated. Support for it (except in historical migrations) will be removed
249 in Django 5.1. *This check appeared in Django 4.2 and 5.0*.
250 * **fields.E906**: ``django.contrib.postgres.fields.CIEmailField`` is removed
251 except for support in historical migrations.
252 * **fields.W907**: ``django.contrib.postgres.fields.CITextField`` is
253 deprecated. Support for it (except in historical migrations) will be removed
254 in Django 5.1. *This check appeared in Django 4.2 and 5.0*.
255 * **fields.E907**: ``django.contrib.postgres.fields.CITextField`` is removed
256 except for support for historical migrations.
257
258 File fields
259 ~~~~~~~~~~~
260
261 * **fields.E200**: ``unique`` is not a valid argument for a ``FileField``.
262 *This check is removed in Django 1.11*.
263 * **fields.E201**: ``primary_key`` is not a valid argument for a ``FileField``.
264 * **fields.E202**: ``FileField``’s ``upload_to`` argument must be a relative
265 path, not an absolute path.
266 * **fields.E210**: Cannot use ``ImageField`` because Pillow is not installed.
267
268 Related fields
269 ~~~~~~~~~~~~~~
270
271 * **fields.E300**: Field defines a relation with model ``<model>``, which is
272 either not installed, or is abstract.
273 * **fields.E301**: Field defines a relation with the model
274 ``<app_label>.<model>`` which has been swapped out.
275 * **fields.E302**: Reverse accessor ``<related model>.<accessor name>`` for
276 ``<app_label>.<model>.<field name>`` clashes with field name
277 ``<app_label>.<model>.<field name>``.
278 * **fields.E303**: Reverse query name for ``<app_label>.<model>.<field name>``
279 clashes with field name ``<app_label>.<model>.<field name>``.
280 * **fields.E304**: Reverse accessor ``<related model>.<accessor name>`` for
281 ``<app_label>.<model>.<field name>`` clashes with reverse accessor for
282 ``<app_label>.<model>.<field name>``.
283 * **fields.E305**: Reverse query name for ``<app_label>.<model>.<field name>``
284 clashes with reverse query name for ``<app_label>.<model>.<field name>``.
285 * **fields.E306**: The name ``<name>`` is invalid ``related_name`` for field
286 ``<model>.<field name>``.
287 * **fields.E307**: The field ``<app label>.<model>.<field name>`` was declared
288 with a lazy reference to ``<app label>.<model>``, but app ``<app label>``
289 isn't installed or doesn't provide model ``<model>``.
290 * **fields.E308**: Reverse query name ``<related query name>`` must not end
291 with an underscore.
292 * **fields.E309**: Reverse query name ``<related query name>`` must not contain
293 ``'__'``.
294 * **fields.E310**: No subset of the fields ``<field1>``, ``<field2>``, ... on
295 model ``<model>`` is unique.
296 * **fields.E311**: ``<model>.<field name>`` must be unique because it is
297 referenced by a ``ForeignKey``.
298 * **fields.E312**: The ``to_field`` ``<field name>`` doesn't exist on the
299 related model ``<app label>.<model>``.
300 * **fields.E320**: Field specifies ``on_delete=SET_NULL``, but cannot be null.
301 * **fields.E321**: The field specifies ``on_delete=SET_DEFAULT``, but has no
302 default value.
303 * **fields.E330**: ``ManyToManyField``\s cannot be unique.
304 * **fields.E331**: Field specifies a many-to-many relation through model
305 ``<model>``, which has not been installed.
306 * **fields.E332**: Many-to-many fields with intermediate tables must not be
307 symmetrical. *This check appeared before Django 3.0.*
308 * **fields.E333**: The model is used as an intermediate model by ``<model>``,
309 but it has more than two foreign keys to ``<model>``, which is ambiguous.
310 You must specify which two foreign keys Django should use via the
311 ``through_fields`` keyword argument.
312 * **fields.E334**: The model is used as an intermediate model by ``<model>``,
313 but it has more than one foreign key from ``<model>``, which is ambiguous.
314 You must specify which foreign key Django should use via the
315 ``through_fields`` keyword argument.
316 * **fields.E335**: The model is used as an intermediate model by ``<model>``,
317 but it has more than one foreign key to ``<model>``, which is ambiguous.
318 You must specify which foreign key Django should use via the
319 ``through_fields`` keyword argument.
320 * **fields.E336**: The model is used as an intermediary model by ``<model>``,
321 but it does not have foreign key to ``<model>`` or ``<model>``.
322 * **fields.E337**: Field specifies ``through_fields`` but does not provide the
323 names of the two link fields that should be used for the relation through
324 ``<model>``.
325 * **fields.E338**: The intermediary model ``<through model>`` has no field
326 ``<field name>``.
327 * **fields.E339**: ``<model>.<field name>`` is not a foreign key to ``<model>``.
328 * **fields.E340**: The field's intermediary table ``<table name>`` clashes with
329 the table name of ``<model>``/``<model>.<field name>``.
330 * **fields.W340**: ``null`` has no effect on ``ManyToManyField``.
331 * **fields.W341**: ``ManyToManyField`` does not support ``validators``.
332 * **fields.W342**: Setting ``unique=True`` on a ``ForeignKey`` has the same
333 effect as using a ``OneToOneField``.
334 * **fields.W343**: ``limit_choices_to`` has no effect on ``ManyToManyField``
335 with a ``through`` model. *This check appeared before Django 4.0.*
336 * **fields.W344**: The field's intermediary table ``<table name>`` clashes with
337 the table name of ``<model>``/``<model>.<field name>``.
338 * **fields.W345**: ``related_name`` has no effect on ``ManyToManyField`` with a
339 symmetrical relationship, e.g. to "self".
340 * **fields.W346**: ``db_comment`` has no effect on ``ManyToManyField``.
341 * **fields.E347**: Field defines a relation involving model ``<model>`` which
342 has a ``CompositePrimaryKey`` and such relations are not supported.
343
344 Models
345 ------
346
347 * **models.E001**: ``<swappable>`` is not of the form ``app_label.app_name``.
348 * **models.E002**: ``<SETTING>`` references ``<model>``, which has not been
349 installed, or is abstract.
350 * **models.E003**: The model has two identical many-to-many relations through
351 the intermediate model ``<app_label>.<model>``.
352 * **models.E004**: ``id`` can only be used as a field name if the field also
353 sets ``primary_key=True``.
354 * **models.E005**: The field ``<field name>`` from parent model ``<model>``
355 clashes with the field ``<field name>`` from parent model ``<model>``.
356 * **models.E006**: The field ``<field name>`` clashes with the field
357 ``<field name>`` from model ``<model>``.
358 * **models.E007**: Field ``<field name>`` has column name ``<column name>``
359 that is used by another field.
360 * **models.E008**: ``index_together`` must be a list or tuple. *This check
361 appeared before Django 5.1.*
362 * **models.E009**: All ``index_together`` elements must be lists or tuples.
363 *This check appeared before Django 5.1.*
364 * **models.E010**: ``unique_together`` must be a list or tuple.
365 * **models.E011**: All ``unique_together`` elements must be lists or tuples.
366 * **models.E012**: ``constraints/indexes/unique_together`` refers to the
367 nonexistent field ``<field name>``.
368 * **models.E013**: ``constraints/indexes/unique_together`` refers to a
369 ``ManyToManyField`` ``<field name>``, but ``ManyToManyField``\s are not
370 supported for that option.
371 * **models.E014**: ``ordering`` must be a tuple or list (even if you want to
372 order by only one field).
373 * **models.E015**: ``ordering`` refers to the nonexistent field, related field,
374 or lookup ``<field name>``.
375 * **models.E016**: ``constraints/indexes/unique_together`` refers to field
376 ``<field_name>`` which is not local to model ``<model>``.
377 * **models.E017**: Proxy model ``<model>`` contains model fields.
378 * **models.E018**: Autogenerated column name too long for field ``<field>``.
379 Maximum length is ``<maximum length>`` for database ``<alias>``.
380 * **models.E019**: Autogenerated column name too long for M2M field
381 ``<M2M field>``. Maximum length is ``<maximum length>`` for database
382 ``<alias>``.
383 * **models.E020**: The ``<model>.check()`` class method is currently overridden.
384 * **models.E021**: ``ordering`` and ``order_with_respect_to`` cannot be used
385 together.
386 * **models.E022**: ``<function>`` contains a lazy reference to
387 ``<app label>.<model>``, but app ``<app label>`` isn't installed or
388 doesn't provide model ``<model>``.
389 * **models.E023**: The model name ``<model>`` cannot start or end with an
390 underscore as it collides with the query lookup syntax.
391 * **models.E024**: The model name ``<model>`` cannot contain double underscores
392 as it collides with the query lookup syntax.
393 * **models.E025**: The property ``<property name>`` clashes with a related
394 field accessor.
395 * **models.E026**: The model cannot have more than one field with
396 ``primary_key=True``.
397 * **models.W027**: ``<database>`` does not support check constraints.
398 * **models.E028**: ``db_table`` ``<db_table>`` is used by multiple models:
399 ``<model list>``.
400 * **models.E029**: index name ``<index>`` is not unique for model ``<model>``.
401 * **models.E030**: index name ``<index>`` is not unique among models:
402 ``<model list>``.
403 * **models.E031**: constraint name ``<constraint>`` is not unique for model
404 ``<model>``.
405 * **models.E032**: constraint name ``<constraint>`` is not unique among
406 models: ``<model list>``.
407 * **models.E033**: The index name ``<index>`` cannot start with an underscore
408 or a number.
409 * **models.E034**: The index name ``<index>`` cannot be longer than
410 ``<max_length>`` characters.
411 * **models.W035**: ``db_table`` ``<db_table>`` is used by multiple models:
412 ``<model list>``.
413 * **models.W036**: ``<database>`` does not support unique constraints with
414 conditions.
415 * **models.W037**: ``<database>`` does not support indexes with conditions.
416 * **models.W038**: ``<database>`` does not support deferrable unique
417 constraints.
418 * **models.W039**: ``<database>`` does not support unique constraints with
419 non-key columns.
420 * **models.W040**: ``<database>`` does not support indexes with non-key
421 columns.
422 * **models.E041**: ``constraints`` refers to the joined field ``<field name>``.
423 * **models.E042**: ``<field name>`` cannot be included in the composite
424 primary key.
425 * **models.W042**: Auto-created primary key used when not defining a primary
426 key type, by default ``django.db.models.AutoField``.
427 * **models.W043**: ``<database>`` does not support indexes on expressions.
428 * **models.W044**: ``<database>`` does not support unique constraints on
429 expressions.
430 * **models.W045**: Check constraint ``<constraint>`` contains ``RawSQL()``
431 expression and won't be validated during the model ``full_clean()``.
432 * **models.W046**: ``<database>`` does not support comments on tables
433 (``db_table_comment``).
434 * **models.W047**: ``<database>`` does not support unique constraints with
435 nulls distinct.
436 * **models.E048**: ``constraints/indexes/unique_together`` refers to a
437 ``CompositePrimaryKey`` ``<field name>``, but ``CompositePrimaryKey``\s are
438 not supported for that option.
439
440 Management Commands
441 -------------------
442
443 The following checks verify custom management commands are correctly configured:
444
445 * **commands.E001**: The ``migrate`` and ``makemigrations`` commands must have
446 the same ``autodetector``.
447
448 Security
449 --------
450
451 The security checks do not make your site secure. They do not audit code, do
452 intrusion detection, or do anything particularly complex. Rather, they help
453 perform an automated, low-hanging-fruit checklist, that can help you to improve
454 your site's security.
455
456 Some of these checks may not be appropriate for your particular deployment
457 configuration. For instance, if you do your HTTP to HTTPS redirection in a load
458 balancer, it'd be irritating to be constantly warned about not having enabled
459 :setting:`SECURE_SSL_REDIRECT`. Use :setting:`SILENCED_SYSTEM_CHECKS` to
460 silence unneeded checks.
461
462 The following checks are run if you use the :option:`check --deploy` option:
463
464 * **security.W001**: You do not have
465 :class:`django.middleware.security.SecurityMiddleware` in your
466 :setting:`MIDDLEWARE` so the :setting:`SECURE_HSTS_SECONDS`,
467 :setting:`SECURE_CONTENT_TYPE_NOSNIFF`, :setting:`SECURE_REFERRER_POLICY`,
468 :setting:`SECURE_CROSS_ORIGIN_OPENER_POLICY`, and
469 :setting:`SECURE_SSL_REDIRECT` settings will have no effect.
470 * **security.W002**: You do not have
471 :class:`django.middleware.clickjacking.XFrameOptionsMiddleware` in your
472 :setting:`MIDDLEWARE`, so your pages will not be served with an
473 ``'x-frame-options'`` header. Unless there is a good reason for your
474 site to be served in a frame, you should consider enabling this
475 header to help prevent clickjacking attacks.
476 * **security.W003**: You don't appear to be using Django's built-in cross-site
477 request forgery protection via the middleware
478 (:class:`django.middleware.csrf.CsrfViewMiddleware` is not in your
479 :setting:`MIDDLEWARE`). Enabling the middleware is the safest
480 approach to ensure you don't leave any holes.
481 * **security.W004**: You have not set a value for the
482 :setting:`SECURE_HSTS_SECONDS` setting. If your entire site is served only
483 over SSL, you may want to consider setting a value and enabling :ref:`HTTP
484 Strict Transport Security <http-strict-transport-security>`. Be sure to read
485 the documentation first; enabling HSTS carelessly can cause serious,
486 irreversible problems.
487 * **security.W005**: You have not set the
488 :setting:`SECURE_HSTS_INCLUDE_SUBDOMAINS` setting to ``True``. Without this,
489 your site is potentially vulnerable to attack via an insecure connection to a
490 subdomain. Only set this to ``True`` if you are certain that all subdomains of
491 your domain should be served exclusively via SSL.
492 * **security.W006**: Your :setting:`SECURE_CONTENT_TYPE_NOSNIFF` setting is not
493 set to ``True``, so your pages will not be served with an
494 ``'X-Content-Type-Options: nosniff'`` header. You should consider enabling
495 this header to prevent the browser from identifying content types incorrectly.
496 * **security.W007**: Your ``SECURE_BROWSER_XSS_FILTER`` setting is not
497 set to ``True``, so your pages will not be served with an
498 ``'X-XSS-Protection: 1; mode=block'`` header. You should consider enabling
499 this header to activate the browser's XSS filtering and help prevent XSS
500 attacks. *This check is removed in Django 3.0 as the* ``X-XSS-Protection``
501 *header is no longer honored by modern browsers.*
502 * **security.W008**: Your :setting:`SECURE_SSL_REDIRECT` setting is not set to
503 ``True``. Unless your site should be available over both SSL and non-SSL
504 connections, you may want to either set this setting to ``True`` or configure
505 a load balancer or reverse-proxy server to redirect all connections to HTTPS.
506 * **security.W009**: Your :setting:`SECRET_KEY` has less than 50 characters,
507 less than 5 unique characters, or it's prefixed with ``'django-insecure-'``
508 indicating that it was generated automatically by Django. Please generate a
509 long and random value, otherwise many of Django's security-critical features
510 will be vulnerable to attack.
511 * **security.W010**: You have :mod:`django.contrib.sessions` in your
512 :setting:`INSTALLED_APPS` but you have not set
513 :setting:`SESSION_COOKIE_SECURE` to ``True``. Using a secure-only session
514 cookie makes it more difficult for network traffic sniffers to hijack user
515 sessions.
516 * **security.W011**: You have
517 :class:`django.contrib.sessions.middleware.SessionMiddleware` in your
518 :setting:`MIDDLEWARE`, but you have not set :setting:`SESSION_COOKIE_SECURE`
519 to ``True``. Using a secure-only session cookie makes it more difficult for
520 network traffic sniffers to hijack user sessions.
521 * **security.W012**: :setting:`SESSION_COOKIE_SECURE` is not set to ``True``.
522 Using a secure-only session cookie makes it more difficult for network traffic
523 sniffers to hijack user sessions.
524 * **security.W013**: You have :mod:`django.contrib.sessions` in your
525 :setting:`INSTALLED_APPS`, but you have not set
526 :setting:`SESSION_COOKIE_HTTPONLY` to ``True``. Using an ``HttpOnly`` session
527 cookie makes it more difficult for cross-site scripting attacks to hijack user
528 sessions.
529 * **security.W014**: You have
530 :class:`django.contrib.sessions.middleware.SessionMiddleware` in your
531 :setting:`MIDDLEWARE`, but you have not set :setting:`SESSION_COOKIE_HTTPONLY`
532 to ``True``. Using an ``HttpOnly`` session cookie makes it more difficult for
533 cross-site scripting attacks to hijack user sessions.
534 * **security.W015**: :setting:`SESSION_COOKIE_HTTPONLY` is not set to ``True``.
535 Using an ``HttpOnly`` session cookie makes it more difficult for cross-site
536 scripting attacks to hijack user sessions.
537 * **security.W016**: :setting:`CSRF_COOKIE_SECURE` is not set to ``True``.
538 Using a secure-only CSRF cookie makes it more difficult for network traffic
539 sniffers to steal the CSRF token.
540 * **security.W017**: :setting:`CSRF_COOKIE_HTTPONLY` is not set to ``True``.
541 Using an ``HttpOnly`` CSRF cookie makes it more difficult for cross-site
542 scripting attacks to steal the CSRF token. *This check is removed in Django
543 1.11 as the* :setting:`CSRF_COOKIE_HTTPONLY` *setting offers no practical
544 benefit.*
545 * **security.W018**: You should not have :setting:`DEBUG` set to ``True`` in
546 deployment.
547 * **security.W019**: You have
548 :class:`django.middleware.clickjacking.XFrameOptionsMiddleware` in your
549 :setting:`MIDDLEWARE`, but :setting:`X_FRAME_OPTIONS` is not set to
550 ``'DENY'``. Unless there is a good reason for your site to serve other parts
551 of itself in a frame, you should change it to ``'DENY'``.
552 * **security.W020**: :setting:`ALLOWED_HOSTS` must not be empty in deployment.
553 * **security.W021**: You have not set the
554 :setting:`SECURE_HSTS_PRELOAD` setting to ``True``. Without this, your site
555 cannot be submitted to the browser preload list.
556 * **security.W022**: You have not set the :setting:`SECURE_REFERRER_POLICY`
557 setting. Without this, your site will not send a Referrer-Policy header. You
558 should consider enabling this header to protect user privacy.
559 * **security.E023**: You have set the :setting:`SECURE_REFERRER_POLICY` setting
560 to an invalid value.
561 * **security.E024**: You have set the
562 :setting:`SECURE_CROSS_ORIGIN_OPENER_POLICY` setting to an invalid value.
563 * **security.W025**: Your
564 :setting:`SECRET_KEY_FALLBACKS[n] <SECRET_KEY_FALLBACKS>` has less than 50
565 characters, less than 5 unique characters, or it's prefixed with
566 ``'django-insecure-'`` indicating that it was generated automatically by
567 Django. Please generate a long and random value, otherwise many of Django's
568 security-critical features will be vulnerable to attack.
569
570 The following checks verify that your security-related settings are correctly
571 configured:
572
573 * **security.E100**: ``DEFAULT_HASHING_ALGORITHM`` must be ``'sha1'`` or
574 ``'sha256'``. *This check appeared in Django 3.1 and 3.2*.
575 * **security.E101**: The CSRF failure view ``'path.to.view'`` does not take the
576 correct number of arguments.
577 * **security.E102**: The CSRF failure view ``'path.to.view'`` could not be
578 imported.
579
580 Signals
581 -------
582
583 * **signals.E001**: ``<handler>`` was connected to the ``<signal>`` signal with
584 a lazy reference to the sender ``<app label>.<model>``, but app ``<app label>``
585 isn't installed or doesn't provide model ``<model>``.
586
587 Templates
588 ---------
589
590 The following checks verify that your :setting:`TEMPLATES` setting is correctly
591 configured:
592
593 * **templates.E001**: You have ``'APP_DIRS': True`` in your
594 :setting:`TEMPLATES` but also specify ``'loaders'`` in ``OPTIONS``. Either
595 remove ``APP_DIRS`` or remove the ``'loaders'`` option. *This check is
596 removed in Django 5.1 as system checks may now raise*
597 ``ImproperlyConfigured`` *instead.*
598 * **templates.E002**: ``string_if_invalid`` in :setting:`TEMPLATES`
599 :setting:`OPTIONS <TEMPLATES-OPTIONS>` must be a string but got: ``{value}``
600 (``{type}``).
601 * **templates.E003**:``<name>`` is used for multiple template tag modules:
602 ``<module list>``. *This check was changed to* ``templates.W003`` *in Django
603 4.1.2*.
604 * **templates.W003**:``<name>`` is used for multiple template tag modules:
605 ``<module list>``.
606
607 Translation
608 -----------
609
610 The following checks are performed on your translation configuration:
611
612 * **translation.E001**: You have provided an invalid value for the
613 :setting:`LANGUAGE_CODE` setting: ``<value>``.
614 * **translation.E002**: You have provided an invalid language code in the
615 :setting:`LANGUAGES` setting: ``<value>``.
616 * **translation.E003**: You have provided an invalid language code in the
617 :setting:`LANGUAGES_BIDI` setting: ``<value>``.
618 * **translation.E004**: You have provided a value for the
619 :setting:`LANGUAGE_CODE` setting that is not in the :setting:`LANGUAGES`
620 setting.
621
622 URLs
623 ----
624
625 The following checks are performed on your URL configuration:
626
627 * **urls.W001**: Your URL pattern ``<pattern>`` uses
628 :func:`~django.urls.include` with a ``route`` ending with a ``$``. Remove the
629 dollar from the ``route`` to avoid problems including URLs.
630 * **urls.W002**: Your URL pattern ``<pattern>`` has a ``route`` beginning with
631 a ``/``. Remove this slash as it is unnecessary. If this pattern is targeted
632 in an :func:`~django.urls.include`, ensure the :func:`~django.urls.include`
633 pattern has a trailing ``/``.
634 * **urls.W003**: Your URL pattern ``<pattern>`` has a ``name``
635 including a ``:``. Remove the colon, to avoid ambiguous namespace
636 references.
637 * **urls.E004**: Your URL pattern ``<pattern>`` is invalid. Ensure that
638 ``urlpatterns`` is a list of :func:`~django.urls.path` and/or
639 :func:`~django.urls.re_path` instances.
640 * **urls.W005**: URL namespace ``<namespace>`` isn't unique. You may not be
641 able to reverse all URLs in this namespace.
642 * **urls.E006**: The :setting:`MEDIA_URL`/ :setting:`STATIC_URL` setting must
643 end with a slash.
644 * **urls.E007**: The custom ``handlerXXX`` view ``'path.to.view'`` does not
645 take the correct number of arguments (…).
646 * **urls.E008**: The custom ``handlerXXX`` view ``'path.to.view'`` could not be
647 imported.
648 * **urls.E009**: Your URL pattern ``<pattern>`` has an invalid view, pass
649 ``<view>.as_view()`` instead of ``<view>``.
650 * **urls.W010**: Your URL pattern ``<pattern>`` has an unmatched
651 ``<angle bracket>``.
652
653 ``contrib`` app checks
654 ======================
655
656 ``admin``
657 ---------
658
659 Admin checks are all performed as part of the ``admin`` tag.
660
661 The following checks are performed on any
662 :class:`~django.contrib.admin.ModelAdmin` (or subclass) that is registered
663 with the admin site:
664
665 * **admin.E001**: The value of ``raw_id_fields`` must be a list or tuple.
666 * **admin.E002**: The value of ``raw_id_fields[n]`` refers to ``<field name>``,
667 which is not a field of ``<model>``.
668 * **admin.E003**: The value of ``raw_id_fields[n]`` must be a foreign key or
669 a many-to-many field.
670 * **admin.E004**: The value of ``fields`` must be a list or tuple.
671 * **admin.E005**: Both ``fieldsets`` and ``fields`` are specified.
672 * **admin.E006**: The value of ``fields`` contains duplicate field(s).
673 * **admin.E007**: The value of ``fieldsets`` must be a list or tuple.
674 * **admin.E008**: The value of ``fieldsets[n]`` must be a list or tuple.
675 * **admin.E009**: The value of ``fieldsets[n]`` must be of length 2.
676 * **admin.E010**: The value of ``fieldsets[n][1]`` must be a dictionary.
677 * **admin.E011**: The value of ``fieldsets[n][1]`` must contain the key
678 ``fields``.
679 * **admin.E012**: There are duplicate field(s) in ``fieldsets[n][1]``.
680 * **admin.E013**: The value of
681 ``fields[n]/filter_horizontal[n]/filter_vertical[n]/fieldsets[n][m]`` cannot
682 include the ``ManyToManyField`` ``<field name>``, because that field manually
683 specifies a relationship model.
684 * **admin.E014**: The value of ``exclude`` must be a list or tuple.
685 * **admin.E015**: The value of ``exclude`` contains duplicate field(s).
686 * **admin.E016**: The value of ``form`` must inherit from ``BaseModelForm``.
687 * **admin.E017**: The value of ``filter_vertical`` must be a list or tuple.
688 * **admin.E018**: The value of ``filter_horizontal`` must be a list or tuple.
689 * **admin.E019**: The value of ``filter_vertical[n]/filter_horizontal[n]``
690 refers to ``<field name>``, which is not a field of ``<model>``.
691 * **admin.E020**: The value of ``filter_vertical[n]/filter_horizontal[n]``
692 must be a many-to-many field.
693 * **admin.E021**: The value of ``radio_fields`` must be a dictionary.
694 * **admin.E022**: The value of ``radio_fields`` refers to ``<field name>``,
695 which is not a field of ``<model>``.
696 * **admin.E023**: The value of ``radio_fields`` refers to ``<field name>``,
697 which is not an instance of ``ForeignKey``, and does not have a ``choices``
698 definition.
699 * **admin.E024**: The value of ``radio_fields[<field name>]`` must be either
700 ``admin.HORIZONTAL`` or ``admin.VERTICAL``.
701 * **admin.E025**: The value of ``view_on_site`` must be either a callable or a
702 boolean value.
703 * **admin.E026**: The value of ``prepopulated_fields`` must be a dictionary.
704 * **admin.E027**: The value of ``prepopulated_fields`` refers to
705 ``<field name>``, which is not a field of ``<model>``.
706 * **admin.E028**: The value of ``prepopulated_fields`` refers to
707 ``<field name>``, which must not be a ``DateTimeField``, a ``ForeignKey``,
708 a ``OneToOneField``, or a ``ManyToManyField`` field.
709 * **admin.E029**: The value of ``prepopulated_fields[<field name>]`` must be a
710 list or tuple.
711 * **admin.E030**: The value of ``prepopulated_fields`` refers to
712 ``<field name>``, which is not a field of ``<model>``.
713 * **admin.E031**: The value of ``ordering`` must be a list or tuple.
714 * **admin.E032**: The value of ``ordering`` has the random ordering marker
715 ``?``, but contains other fields as well.
716 * **admin.E033**: The value of ``ordering`` refers to ``<field name>``, which
717 is not a field of ``<model>``.
718 * **admin.E034**: The value of ``readonly_fields`` must be a list or tuple.
719 * **admin.E035**: The value of ``readonly_fields[n]`` refers to
720 ``<field_name>``, which is not a callable, an attribute of
721 ``<ModelAdmin class>``, or an attribute of ``<model>``.
722 * **admin.E036**: The value of ``autocomplete_fields`` must be a list or tuple.
723 * **admin.E037**: The value of ``autocomplete_fields[n]`` refers to
724 ``<field name>``, which is not a field of ``<model>``.
725 * **admin.E038**: The value of ``autocomplete_fields[n]`` must be a foreign
726 key or a many-to-many field.
727 * **admin.E039**: An admin for model ``<model>`` has to be registered to be
728 referenced by ``<modeladmin>.autocomplete_fields``.
729 * **admin.E040**: ``<modeladmin>`` must define ``search_fields``, because
730 it's referenced by ``<other_modeladmin>.autocomplete_fields``.
731
732 ``ModelAdmin``
733 ~~~~~~~~~~~~~~
734
735 The following checks are performed on any
736 :class:`~django.contrib.admin.ModelAdmin` that is registered
737 with the admin site:
738
739 * **admin.E101**: The value of ``save_as`` must be a boolean.
740 * **admin.E102**: The value of ``save_on_top`` must be a boolean.
741 * **admin.E103**: The value of ``inlines`` must be a list or tuple.
742 * **admin.E104**: ``<InlineModelAdmin class>`` must inherit from
743 ``InlineModelAdmin``.
744 * **admin.E105**: ``<InlineModelAdmin class>`` must have a ``model`` attribute.
745 * **admin.E106**: The value of ``<InlineModelAdmin class>.model`` must be a
746 ``Model``.
747 * **admin.E107**: The value of ``list_display`` must be a list or tuple.
748 * **admin.E108**: The value of ``list_display[n]`` refers to ``<label>``, which
749 is not a callable or attribute of ``<ModelAdmin class>``, or an attribute,
750 method, or field on ``<model>``.
751 * **admin.E109**: The value of ``list_display[n]`` must not be a many-to-many
752 field or a reverse foreign key.
753 * **admin.E110**: The value of ``list_display_links`` must be a list, a tuple,
754 or ``None``.
755 * **admin.E111**: The value of ``list_display_links[n]`` refers to ``<label>``,
756 which is not defined in ``list_display``.
757 * **admin.E112**: The value of ``list_filter`` must be a list or tuple.
758 * **admin.E113**: The value of ``list_filter[n]`` must inherit from
759 ``ListFilter``.
760 * **admin.E114**: The value of ``list_filter[n]`` must not inherit from
761 ``FieldListFilter``.
762 * **admin.E115**: The value of ``list_filter[n][1]`` must inherit from
763 ``FieldListFilter``.
764 * **admin.E116**: The value of ``list_filter[n]`` refers to ``<label>``,
765 which does not refer to a Field.
766 * **admin.E117**: The value of ``list_select_related`` must be a boolean,
767 tuple or list.
768 * **admin.E118**: The value of ``list_per_page`` must be an integer.
769 * **admin.E119**: The value of ``list_max_show_all`` must be an integer.
770 * **admin.E120**: The value of ``list_editable`` must be a list or tuple.
771 * **admin.E121**: The value of ``list_editable[n]`` refers to ``<label>``,
772 which is not a field of ``<model>``.
773 * **admin.E122**: The value of ``list_editable[n]`` refers to ``<label>``,
774 which is not contained in ``list_display``.
775 * **admin.E123**: The value of ``list_editable[n]`` cannot be in both
776 ``list_editable`` and ``list_display_links``.
777 * **admin.E124**: The value of ``list_editable[n]`` refers to the first field
778 in ``list_display`` (``<label>``), which cannot be used unless
779 ``list_display_links`` is set.
780 * **admin.E125**: The value of ``list_editable[n]`` refers to ``<field name>``,
781 which is not editable through the admin.
782 * **admin.E126**: The value of ``search_fields`` must be a list or tuple.
783 * **admin.E127**: The value of ``date_hierarchy`` refers to ``<field name>``,
784 which does not refer to a Field.
785 * **admin.E128**: The value of ``date_hierarchy`` must be a ``DateField`` or
786 ``DateTimeField``.
787 * **admin.E129**: ``<modeladmin>`` must define a ``has_<foo>_permission()``
788 method for the ``<action>`` action.
789 * **admin.E130**: ``__name__`` attributes of actions defined in
790 ``<modeladmin>`` must be unique. Name ``<name>`` is not unique.
791
792 ``InlineModelAdmin``
793 ~~~~~~~~~~~~~~~~~~~~
794
795 The following checks are performed on any
796 :class:`~django.contrib.admin.InlineModelAdmin` that is registered as an
797 inline on a :class:`~django.contrib.admin.ModelAdmin`.
798
799 * **admin.E201**: Cannot exclude the field ``<field name>``, because it is the
800 foreign key to the parent model ``<app_label>.<model>``.
801 * **admin.E202**: ``<model>`` has no ``ForeignKey`` to ``<parent model>``./
802 ``<model>`` has more than one ``ForeignKey`` to ``<parent model>``. You must
803 specify a ``fk_name`` attribute.
804 * **admin.E203**: The value of ``extra`` must be an integer.
805 * **admin.E204**: The value of ``max_num`` must be an integer.
806 * **admin.E205**: The value of ``min_num`` must be an integer.
807 * **admin.E206**: The value of ``formset`` must inherit from
808 ``BaseModelFormSet``.
809
810 ``GenericInlineModelAdmin``
811 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
812
813 The following checks are performed on any
814 :class:`~django.contrib.contenttypes.admin.GenericInlineModelAdmin` that is
815 registered as an inline on a :class:`~django.contrib.admin.ModelAdmin`.
816
817 * **admin.E301**: ``<model>`` has no ``GenericForeignKey``.
818 * **admin.E302**: ``'ct_field'`` references ``<label>``, which is not a field
819 on ``<model>``.
820 * **admin.E303**: ``'ct_fk_field'`` references ``<label>``, which is not a
821 field on ``<model>``.
822 * **admin.E304**: ``<model>`` has no ``GenericForeignKey`` using content type
823 field ``<field name>`` and object ID field ``<field name>``.
824
825 ``AdminSite``
826 ~~~~~~~~~~~~~
827
828 The following checks are performed on the default
829 :class:`~django.contrib.admin.AdminSite`:
830
831 * **admin.E401**: :mod:`django.contrib.contenttypes` must be in
832 :setting:`INSTALLED_APPS` in order to use the admin application.
833 * **admin.E402**: :mod:`django.contrib.auth.context_processors.auth`
834 must be enabled in :class:`~django.template.backends.django.DjangoTemplates`
835 (:setting:`TEMPLATES`) if using the default auth backend in order to use the
836 admin application.
837 * **admin.E403**: A :class:`django.template.backends.django.DjangoTemplates`
838 instance must be configured in :setting:`TEMPLATES` in order to use the
839 admin application.
840 * **admin.E404**: ``django.contrib.messages.context_processors.messages``
841 must be enabled in :class:`~django.template.backends.django.DjangoTemplates`
842 (:setting:`TEMPLATES`) in order to use the admin application.
843 * **admin.E405**: :mod:`django.contrib.auth` must be in
844 :setting:`INSTALLED_APPS` in order to use the admin application.
845 * **admin.E406**: :mod:`django.contrib.messages` must be in
846 :setting:`INSTALLED_APPS` in order to use the admin application.
847 * **admin.E408**:
848 :class:`django.contrib.auth.middleware.AuthenticationMiddleware` must be in
849 :setting:`MIDDLEWARE` in order to use the admin application.
850 * **admin.E409**: :class:`django.contrib.messages.middleware.MessageMiddleware`
851 must be in :setting:`MIDDLEWARE` in order to use the admin application.
852 * **admin.E410**: :class:`django.contrib.sessions.middleware.SessionMiddleware`
853 must be in :setting:`MIDDLEWARE` in order to use the admin application.
854 * **admin.W411**: ``django.template.context_processors.request`` must be
855 enabled in :class:`~django.template.backends.django.DjangoTemplates`
856 (:setting:`TEMPLATES`) in order to use the admin navigation sidebar.
857
858 ``auth``
859 --------
860
861 * **auth.E001**: ``REQUIRED_FIELDS`` must be a list or tuple.
862 * **auth.E002**: The field named as the ``USERNAME_FIELD`` for a custom user
863 model must not be included in ``REQUIRED_FIELDS``.
864 * **auth.E003**: ``<field>`` must be unique because it is named as the
865 ``USERNAME_FIELD``.
866 * **auth.W004**: ``<field>`` is named as the ``USERNAME_FIELD``, but it is not
867 unique.
868 * **auth.E005**: The permission codenamed ``<codename>`` clashes with a builtin
869 permission for model ``<model>``.
870 * **auth.E006**: The permission codenamed ``<codename>`` is duplicated for model
871 ``<model>``.
872 * **auth.E007**: The :attr:`verbose_name
873 <django.db.models.Options.verbose_name>` of model ``<model>`` must be at most
874 244 characters for its builtin permission names
875 to be at most 255 characters.
876 * **auth.E008**: The permission named ``<name>`` of model ``<model>`` is longer
877 than 255 characters.
878 * **auth.C009**: ``<User model>.is_anonymous`` must be an attribute or property
879 rather than a method. Ignoring this is a security issue as anonymous users
880 will be treated as authenticated!
881 * **auth.C010**: ``<User model>.is_authenticated`` must be an attribute or
882 property rather than a method. Ignoring this is a security issue as anonymous
883 users will be treated as authenticated!
884 * **auth.E011**: The name of model ``<model>`` must be at most 93 characters
885 for its builtin permission names to be at most 100 characters.
886 * **auth.E012**: The permission codenamed ``<codename>`` of model ``<model>``
887 is longer than 100 characters.
888 * **auth.E013**: In order to use
889 :class:`django.contrib.auth.middleware.LoginRequiredMiddleware`,
890 :class:`django.contrib.auth.middleware.AuthenticationMiddleware` must be
891 defined before it in MIDDLEWARE.
892
893 ``contenttypes``
894 ----------------
895
896 The following checks are performed when a model contains a
897 :class:`~django.contrib.contenttypes.fields.GenericForeignKey` or
898 :class:`~django.contrib.contenttypes.fields.GenericRelation`:
899
900 * **contenttypes.E001**: The ``GenericForeignKey`` object ID references the
901 nonexistent field ``<field>``.
902 * **contenttypes.E002**: The ``GenericForeignKey`` content type references the
903 nonexistent field ``<field>``.
904 * **contenttypes.E003**: ``<field>`` is not a ``ForeignKey``.
905 * **contenttypes.E004**: ``<field>`` is not a ``ForeignKey`` to
906 ``contenttypes.ContentType``.
907 * **contenttypes.E005**: Model names must be at most 100 characters.
908
909 ``postgres``
910 ------------
911
912 The following checks are performed on :mod:`django.contrib.postgres` model
913 fields:
914
915 * **postgres.E001**: Base field for array has errors: ...
916 * **postgres.E002**: Base field for array cannot be a related field.
917 * **postgres.E003**: ``<field>`` default should be a callable instead of an
918 instance so that it's not shared between all field instances. *This check was
919 changed to* ``fields.E010`` *in Django 3.1*.
920 * **postgres.W004**: Base field for array has warnings: ...
921
922 .. _sites-system-checks:
923
924 ``sites``
925 ---------
926
927 The following checks are performed on any model using a
928 :class:`~django.contrib.sites.managers.CurrentSiteManager`:
929
930 * **sites.E001**: ``CurrentSiteManager`` could not find a field named
931 ``<field name>``.
932 * **sites.E002**: ``CurrentSiteManager`` cannot use ``<field>`` as it is not a
933 foreign key or a many-to-many field.
934
935 The following checks verify that :mod:`django.contrib.sites` is correctly
936 configured:
937
938 * **sites.E101**: The :setting:`SITE_ID` setting must be an integer.
939
940 ``staticfiles``
941 ---------------
942
943 The following checks verify that :mod:`django.contrib.staticfiles` is correctly
944 configured:
945
946 * **staticfiles.E001**: The :setting:`STATICFILES_DIRS` setting is not a tuple
947 or list.
948 * **staticfiles.E002**: The :setting:`STATICFILES_DIRS` setting should not
949 contain the :setting:`STATIC_ROOT` setting.
950 * **staticfiles.E003**: The prefix ``<prefix>`` in the
951 :setting:`STATICFILES_DIRS` setting must not end with a slash.
952 * **staticfiles.W004**: The directory ``<directory>`` in the
953 :setting:`STATICFILES_DIRS` does not exist.
954 * **staticfiles.E005**: The :setting:`STORAGES` setting must define a
955 ``staticfiles`` storage.