2
0

checks.txt 38 KB

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