checks.txt 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690
  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 the ``database`` tag when calling the :djadmin:`check` command.
  64. * ``models``: Checks of model, field, and manager definitions.
  65. * ``security``: Checks security related configuration.
  66. * ``signals``: Checks on signal declarations and handler registrations.
  67. * ``staticfiles``: Checks :mod:`django.contrib.staticfiles` configuration.
  68. * ``templates``: Checks template related configuration.
  69. * ``urls``: Checks URL configuration.
  70. Some checks may be registered with multiple tags.
  71. Core system checks
  72. ==================
  73. Backwards compatibility
  74. -----------------------
  75. The following checks are performed to warn the user of any potential problems
  76. that might occur as a result of a version upgrade.
  77. * **1_6.W001**: Some project unit tests may not execute as expected. *This
  78. check was removed in Django 1.8 due to false positives*.
  79. * **1_6.W002**: ``BooleanField`` does not have a default value. *This
  80. check was removed in Django 1.8 due to false positives*.
  81. * **1_7.W001**: Django 1.7 changed the global defaults for the
  82. ``MIDDLEWARE_CLASSES.``
  83. ``django.contrib.sessions.middleware.SessionMiddleware``,
  84. ``django.contrib.auth.middleware.AuthenticationMiddleware``, and
  85. ``django.contrib.messages.middleware.MessageMiddleware`` were removed from
  86. the defaults. If your project needs these middleware then you should
  87. configure this setting. *This check was removed in Django 1.9*.
  88. * **1_8.W001**: The standalone ``TEMPLATE_*`` settings were deprecated in
  89. Django 1.8 and the :setting:`TEMPLATES` dictionary takes precedence. You must
  90. put the values of the following settings into your defaults ``TEMPLATES``
  91. dict: ``TEMPLATE_DIRS``, ``TEMPLATE_CONTEXT_PROCESSORS``, ``TEMPLATE_DEBUG``,
  92. ``TEMPLATE_LOADERS``, ``TEMPLATE_STRING_IF_INVALID``. *This check was removed
  93. in Django 2.0*.
  94. * **1_10.W001**: The ``MIDDLEWARE_CLASSES`` setting is deprecated in Django
  95. 1.10 and the :setting:`MIDDLEWARE` setting takes precedence. Since you've
  96. set ``MIDDLEWARE``, the value of ``MIDDLEWARE_CLASSES`` is ignored. *This
  97. check was removed in Django 2.0*.
  98. Caches
  99. ------
  100. The following checks verify that your :setting:`CACHES` setting is correctly
  101. configured:
  102. * **caches.E001**: You must define a ``'default'`` cache in your
  103. :setting:`CACHES` setting.
  104. Database
  105. --------
  106. MySQL
  107. ~~~~~
  108. If you're using MySQL, the following checks will be performed:
  109. * **mysql.E001**: MySQL does not allow unique ``CharField``\s to have a
  110. ``max_length`` > 255.
  111. * **mysql.W002**: MySQL Strict Mode is not set for database connection
  112. '<alias>'. See also :ref:`mysql-sql-mode`.
  113. Model fields
  114. ------------
  115. * **fields.E001**: Field names must not end with an underscore.
  116. * **fields.E002**: Field names must not contain ``"__"``.
  117. * **fields.E003**: ``pk`` is a reserved word that cannot be used as a field
  118. name.
  119. * **fields.E004**: ``choices`` must be an iterable (e.g., a list or tuple).
  120. * **fields.E005**: ``choices`` must be an iterable returning ``(actual value,
  121. human readable name)`` tuples.
  122. * **fields.E006**: ``db_index`` must be ``None``, ``True`` or ``False``.
  123. * **fields.E007**: Primary keys must not have ``null=True``.
  124. * **fields.E008**: All ``validators`` must be callable.
  125. * **fields.E100**: ``AutoField``\s must set primary_key=True.
  126. * **fields.E110**: ``BooleanField``\s do not accept null values.
  127. * **fields.E120**: ``CharField``\s must define a ``max_length`` attribute.
  128. * **fields.E121**: ``max_length`` must be a positive integer.
  129. * **fields.W122**: ``max_length`` is ignored when used with ``IntegerField``.
  130. * **fields.E130**: ``DecimalField``\s must define a ``decimal_places`` attribute.
  131. * **fields.E131**: ``decimal_places`` must be a non-negative integer.
  132. * **fields.E132**: ``DecimalField``\s must define a ``max_digits`` attribute.
  133. * **fields.E133**: ``max_digits`` must be a non-negative integer.
  134. * **fields.E134**: ``max_digits`` must be greater or equal to ``decimal_places``.
  135. * **fields.E140**: ``FilePathField``\s must have either ``allow_files`` or
  136. ``allow_folders`` set to True.
  137. * **fields.E150**: ``GenericIPAddressField``\s cannot accept blank values if
  138. null values are not allowed, as blank values are stored as nulls.
  139. * **fields.E160**: The options ``auto_now``, ``auto_now_add``, and ``default``
  140. are mutually exclusive. Only one of these options may be present.
  141. * **fields.W161**: Fixed default value provided.
  142. * **fields.E900**: ``IPAddressField`` has been removed except for support in
  143. historical migrations.
  144. * **fields.W900**: ``IPAddressField`` has been deprecated. Support for it
  145. (except in historical migrations) will be removed in Django 1.9. *This check
  146. appeared in Django 1.7 and 1.8*.
  147. * **fields.W901**: ``CommaSeparatedIntegerField`` has been deprecated. Support
  148. for it (except in historical migrations) will be removed in Django 2.0. *This
  149. check appeared in Django 1.10 and 1.11*.
  150. * **fields.E901**: ``CommaSeparatedIntegerField`` is removed except for support
  151. in historical migrations.
  152. File fields
  153. ~~~~~~~~~~~
  154. * **fields.E200**: ``unique`` is not a valid argument for a ``FileField``.
  155. *This check is removed in Django 1.11*.
  156. * **fields.E201**: ``primary_key`` is not a valid argument for a ``FileField``.
  157. * **fields.E202**: ``FileField``’s ``upload_to`` argument must be a relative
  158. path, not an absolute path.
  159. * **fields.E210**: Cannot use ``ImageField`` because Pillow is not installed.
  160. Related fields
  161. ~~~~~~~~~~~~~~
  162. * **fields.E300**: Field defines a relation with model ``<model>``, which is
  163. either not installed, or is abstract.
  164. * **fields.E301**: Field defines a relation with the model ``<model>`` which
  165. has been swapped out.
  166. * **fields.E302**: Accessor for field ``<field name>`` clashes with field
  167. ``<field name>``.
  168. * **fields.E303**: Reverse query name for field ``<field name>`` clashes with
  169. field ``<field name>``.
  170. * **fields.E304**: Field name ``<field name>`` clashes with accessor for
  171. ``<field name>``.
  172. * **fields.E305**: Field name ``<field name>`` clashes with reverse query name
  173. for ``<field name>``.
  174. * **fields.E306**: Related name must be a valid Python identifier or end with
  175. a ``'+'``.
  176. * **fields.E307**: The field ``<app label>.<model>.<field name>`` was declared
  177. with a lazy reference to ``<app label>.<model>``, but app ``<app label>``
  178. isn't installed or doesn't provide model ``<model>``.
  179. * **fields.E308**: Reverse query name ``<related query name>`` must not end
  180. with an underscore.
  181. * **fields.E309**: Reverse query name ``<related query name>`` must not contain
  182. ``'__'``.
  183. * **fields.E310**: No subset of the fields ``<field1>``, ``<field2>``, ... on
  184. model ``<model>`` is unique. Add ``unique=True`` on any of those fields or
  185. add at least a subset of them to a unique_together constraint.
  186. * **fields.E311**: ``<model>`` must set ``unique=True`` because it is
  187. referenced by a ``ForeignKey``.
  188. * **fields.E312**: The ``to_field`` ``<field name>`` doesn't exist on the
  189. related model ``<app label>.<model>``.
  190. * **fields.E320**: Field specifies ``on_delete=SET_NULL``, but cannot be null.
  191. * **fields.E321**: The field specifies ``on_delete=SET_DEFAULT``, but has no
  192. default value.
  193. * **fields.E330**: ``ManyToManyField``\s cannot be unique.
  194. * **fields.E331**: Field specifies a many-to-many relation through model
  195. ``<model>``, which has not been installed.
  196. * **fields.E332**: Many-to-many fields with intermediate tables must not be
  197. symmetrical.
  198. * **fields.E333**: The model is used as an intermediate model by ``<model>``,
  199. but it has more than two foreign keys to ``<model>``, which is ambiguous.
  200. You must specify which two foreign keys Django should use via the
  201. ``through_fields`` keyword argument.
  202. * **fields.E334**: The model is used as an intermediate model by ``<model>``,
  203. but it has more than one foreign key from ``<model>``, which is ambiguous.
  204. You must specify which foreign key Django should use via the
  205. ``through_fields`` keyword argument.
  206. * **fields.E335**: The model is used as an intermediate model by ``<model>``,
  207. but it has more than one foreign key to ``<model>``, which is ambiguous.
  208. You must specify which foreign key Django should use via the
  209. ``through_fields`` keyword argument.
  210. * **fields.E336**: The model is used as an intermediary model by ``<model>``,
  211. but it does not have foreign key to ``<model>`` or ``<model>``.
  212. * **fields.E337**: Field specifies ``through_fields`` but does not provide the
  213. names of the two link fields that should be used for the relation through
  214. ``<model>``.
  215. * **fields.E338**: The intermediary model ``<through model>`` has no field
  216. ``<field name>``.
  217. * **fields.E339**: ``<model>.<field name>`` is not a foreign key to ``<model>``.
  218. * **fields.E340**: The field's intermediary table ``<table name>`` clashes with
  219. the table name of ``<model>``/``<model>.<field name>``.
  220. * **fields.W340**: ``null`` has no effect on ``ManyToManyField``.
  221. * **fields.W341**: ``ManyToManyField`` does not support ``validators``.
  222. * **fields.W342**: Setting ``unique=True`` on a ``ForeignKey`` has the same
  223. effect as using a ``OneToOneField``.
  224. * **fields.W343**: ``limit_choices_to`` has no effect on ``ManyToManyField``
  225. with a ``through`` model.
  226. Models
  227. ------
  228. * **models.E001**: ``<swappable>`` is not of the form ``app_label.app_name``.
  229. * **models.E002**: ``<SETTING>`` references ``<model>``, which has not been
  230. installed, or is abstract.
  231. * **models.E003**: The model has two many-to-many relations through the
  232. intermediate model ``<app_label>.<model>``.
  233. * **models.E004**: ``id`` can only be used as a field name if the field also
  234. sets ``primary_key=True``.
  235. * **models.E005**: The field ``<field name>`` from parent model ``<model>``
  236. clashes with the field ``<field name>`` from parent model ``<model>``.
  237. * **models.E006**: The field clashes with the field ``<field name>`` from model
  238. ``<model>``.
  239. * **models.E007**: Field ``<field name>`` has column name ``<column name>``
  240. that is used by another field.
  241. * **models.E008**: ``index_together`` must be a list or tuple.
  242. * **models.E009**: All ``index_together`` elements must be lists or tuples.
  243. * **models.E010**: ``unique_together`` must be a list or tuple.
  244. * **models.E011**: All ``unique_together`` elements must be lists or tuples.
  245. * **models.E012**: ``index_together/unique_together`` refers to the
  246. nonexistent field ``<field name>``.
  247. * **models.E013**: ``index_together/unique_together`` refers to a
  248. ``ManyToManyField`` ``<field name>``, but ``ManyToManyField``\s are not
  249. supported for that option.
  250. * **models.E014**: ``ordering`` must be a tuple or list (even if you want to
  251. order by only one field).
  252. * **models.E015**: ``ordering`` refers to the nonexistent field
  253. ``<field name>``.
  254. * **models.E016**: ``index_together/unique_together`` refers to field
  255. ``<field_name>`` which is not local to model ``<model>``.
  256. * **models.E017**: Proxy model ``<model>`` contains model fields.
  257. * **models.E018**: Autogenerated column name too long for field ``<field>``.
  258. Maximum length is ``<maximum length>`` for database ``<alias>``.
  259. * **models.E019**: Autogenerated column name too long for M2M field
  260. ``<M2M field>``. Maximum length is ``<maximum length>`` for database
  261. ``<alias>``.
  262. * **models.E020**: The ``<model>.check()`` class method is currently overridden.
  263. * **models.E021**: ``ordering`` and ``order_with_respect_to`` cannot be used
  264. together.
  265. * **models.E022**: ``<function>`` contains a lazy reference to
  266. ``<app label>.<model>``, but app ``<app label>`` isn't installed or
  267. doesn't provide model ``<model>``.
  268. * **models.E023**: The model name ``<model>`` cannot start or end with an
  269. underscore as it collides with the query lookup syntax.
  270. * **models.E024**: The model name ``<model>`` cannot contain double underscores
  271. as it collides with the query lookup syntax.
  272. Security
  273. --------
  274. The security checks do not make your site secure. They do not audit code, do
  275. intrusion detection, or do anything particularly complex. Rather, they help
  276. perform an automated, low-hanging-fruit checklist. They help you remember the
  277. simple things that improve your site's security.
  278. Some of these checks may not be appropriate for your particular deployment
  279. configuration. For instance, if you do your HTTP to HTTPS redirection in a load
  280. balancer, it'd be irritating to be constantly warned about not having enabled
  281. :setting:`SECURE_SSL_REDIRECT`. Use :setting:`SILENCED_SYSTEM_CHECKS` to
  282. silence unneeded checks.
  283. The following checks are run if you use the :option:`check --deploy` option:
  284. * **security.W001**: You do not have
  285. :class:`django.middleware.security.SecurityMiddleware` in your
  286. :setting:`MIDDLEWARE` so the :setting:`SECURE_HSTS_SECONDS`,
  287. :setting:`SECURE_CONTENT_TYPE_NOSNIFF`, :setting:`SECURE_BROWSER_XSS_FILTER`,
  288. and :setting:`SECURE_SSL_REDIRECT` settings will have no effect.
  289. * **security.W002**: You do not have
  290. :class:`django.middleware.clickjacking.XFrameOptionsMiddleware` in your
  291. :setting:`MIDDLEWARE`, so your pages will not be served with an
  292. ``'x-frame-options'`` header. Unless there is a good reason for your
  293. site to be served in a frame, you should consider enabling this
  294. header to help prevent clickjacking attacks.
  295. * **security.W003**: You don't appear to be using Django's built-in cross-site
  296. request forgery protection via the middleware
  297. (:class:`django.middleware.csrf.CsrfViewMiddleware` is not in your
  298. :setting:`MIDDLEWARE`). Enabling the middleware is the safest
  299. approach to ensure you don't leave any holes.
  300. * **security.W004**: You have not set a value for the
  301. :setting:`SECURE_HSTS_SECONDS` setting. If your entire site is served only
  302. over SSL, you may want to consider setting a value and enabling :ref:`HTTP
  303. Strict Transport Security <http-strict-transport-security>`. Be sure to read
  304. the documentation first; enabling HSTS carelessly can cause serious,
  305. irreversible problems.
  306. * **security.W005**: You have not set the
  307. :setting:`SECURE_HSTS_INCLUDE_SUBDOMAINS` setting to ``True``. Without this,
  308. your site is potentially vulnerable to attack via an insecure connection to a
  309. subdomain. Only set this to ``True`` if you are certain that all subdomains of
  310. your domain should be served exclusively via SSL.
  311. * **security.W006**: Your :setting:`SECURE_CONTENT_TYPE_NOSNIFF` setting is not
  312. set to ``True``, so your pages will not be served with an
  313. ``'x-content-type-options: nosniff'`` header. You should consider enabling
  314. this header to prevent the browser from identifying content types incorrectly.
  315. * **security.W007**: Your :setting:`SECURE_BROWSER_XSS_FILTER` setting is not
  316. set to ``True``, so your pages will not be served with an
  317. ``'x-xss-protection: 1; mode=block'`` header. You should consider enabling
  318. this header to activate the browser's XSS filtering and help prevent XSS
  319. attacks.
  320. * **security.W008**: Your :setting:`SECURE_SSL_REDIRECT` setting is not set to
  321. ``True``. Unless your site should be available over both SSL and non-SSL
  322. connections, you may want to either set this setting to ``True`` or configure
  323. a load balancer or reverse-proxy server to redirect all connections to HTTPS.
  324. * **security.W009**: Your :setting:`SECRET_KEY` has less than 50 characters or
  325. less than 5 unique characters. Please generate a long and random
  326. ``SECRET_KEY``, otherwise many of Django's security-critical features will be
  327. vulnerable to attack.
  328. * **security.W010**: You have :mod:`django.contrib.sessions` in your
  329. :setting:`INSTALLED_APPS` but you have not set
  330. :setting:`SESSION_COOKIE_SECURE` to ``True``. Using a secure-only session
  331. cookie makes it more difficult for network traffic sniffers to hijack user
  332. sessions.
  333. * **security.W011**: You have
  334. :class:`django.contrib.sessions.middleware.SessionMiddleware` in your
  335. :setting:`MIDDLEWARE`, but you have not set :setting:`SESSION_COOKIE_SECURE`
  336. to ``True``. Using a secure-only session cookie makes it more difficult for
  337. network traffic sniffers to hijack user sessions.
  338. * **security.W012**: :setting:`SESSION_COOKIE_SECURE` is not set to ``True``.
  339. Using a secure-only session cookie makes it more difficult for network traffic
  340. sniffers to hijack user sessions.
  341. * **security.W013**: You have :mod:`django.contrib.sessions` in your
  342. :setting:`INSTALLED_APPS`, but you have not set
  343. :setting:`SESSION_COOKIE_HTTPONLY` to ``True``. Using an ``HttpOnly`` session
  344. cookie makes it more difficult for cross-site scripting attacks to hijack user
  345. sessions.
  346. * **security.W014**: You have
  347. :class:`django.contrib.sessions.middleware.SessionMiddleware` in your
  348. :setting:`MIDDLEWARE`, but you have not set :setting:`SESSION_COOKIE_HTTPONLY`
  349. to ``True``. Using an ``HttpOnly`` session cookie makes it more difficult for
  350. cross-site scripting attacks to hijack user sessions.
  351. * **security.W015**: :setting:`SESSION_COOKIE_HTTPONLY` is not set to ``True``.
  352. Using an ``HttpOnly`` session cookie makes it more difficult for cross-site
  353. scripting attacks to hijack user sessions.
  354. * **security.W016**: :setting:`CSRF_COOKIE_SECURE` is not set to ``True``.
  355. Using a secure-only CSRF cookie makes it more difficult for network traffic
  356. sniffers to steal the CSRF token.
  357. * **security.W017**: :setting:`CSRF_COOKIE_HTTPONLY` is not set to ``True``.
  358. Using an ``HttpOnly`` CSRF cookie makes it more difficult for cross-site
  359. scripting attacks to steal the CSRF token. *This check is removed in Django
  360. 1.11 as the* :setting:`CSRF_COOKIE_HTTPONLY` *setting offers no pratical
  361. benefit.*
  362. * **security.W018**: You should not have :setting:`DEBUG` set to ``True`` in
  363. deployment.
  364. * **security.W019**: You have
  365. :class:`django.middleware.clickjacking.XFrameOptionsMiddleware` in your
  366. :setting:`MIDDLEWARE`, but :setting:`X_FRAME_OPTIONS` is not set to
  367. ``'DENY'``. The default is ``'SAMEORIGIN'``, but unless there is a good reason
  368. for your site to serve other parts of itself in a frame, you should change
  369. it to ``'DENY'``.
  370. * **security.W020**: :setting:`ALLOWED_HOSTS` must not be empty in deployment.
  371. * **security.W021**: You have not set the
  372. :setting:`SECURE_HSTS_PRELOAD` setting to ``True``. Without this, your site
  373. cannot be submitted to the browser preload list.
  374. Signals
  375. -------
  376. * **signals.E001**: ``<handler>`` was connected to the ``<signal>`` signal with
  377. a lazy reference to the sender ``<app label>.<model>``, but app ``<app label>``
  378. isn't installed or doesn't provide model ``<model>``.
  379. Templates
  380. ---------
  381. The following checks verify that your :setting:`TEMPLATES` setting is correctly
  382. configured:
  383. * **templates.E001**: You have ``'APP_DIRS': True`` in your
  384. :setting:`TEMPLATES` but also specify ``'loaders'`` in ``OPTIONS``. Either
  385. remove ``APP_DIRS`` or remove the ``'loaders'`` option.
  386. * **templates.E002**: ``string_if_invalid`` in :setting:`TEMPLATES`
  387. :setting:`OPTIONS <TEMPLATES-OPTIONS>` must be a string but got: ``{value}``
  388. (``{type}``).
  389. URLs
  390. ----
  391. The following checks are performed on your URL configuration:
  392. * **urls.W001**: Your URL pattern ``<pattern>`` uses
  393. :func:`~django.conf.urls.include` with a ``regex`` ending with a
  394. ``$``. Remove the dollar from the ``regex`` to avoid problems
  395. including URLs.
  396. * **urls.W002**: Your URL pattern ``<pattern>`` has a ``regex``
  397. beginning with a ``/``. Remove this slash as it is unnecessary.
  398. If this pattern is targeted in an :func:`~django.conf.urls.include`, ensure
  399. the :func:`~django.conf.urls.include` pattern has a trailing ``/``.
  400. * **urls.W003**: Your URL pattern ``<pattern>`` has a ``name``
  401. including a ``:``. Remove the colon, to avoid ambiguous namespace
  402. references.
  403. * **urls.E004**: Your URL pattern ``<pattern>`` is invalid. Ensure that
  404. ``urlpatterns`` is a list of :func:`~django.conf.urls.url()` instances.
  405. * **urls.W005**: URL namespace ``<namespace>`` isn't unique. You may not be
  406. able to reverse all URLs in this namespace.
  407. * **urls.E006**: The :setting:`MEDIA_URL`/ :setting:`STATIC_URL` setting must
  408. end with a slash.
  409. ``contrib`` app checks
  410. ======================
  411. ``admin``
  412. ---------
  413. Admin checks are all performed as part of the ``admin`` tag.
  414. The following checks are performed on any
  415. :class:`~django.contrib.admin.ModelAdmin` (or subclass) that is registered
  416. with the admin site:
  417. * **admin.E001**: The value of ``raw_id_fields`` must be a list or tuple.
  418. * **admin.E002**: The value of ``raw_id_fields[n]`` refers to ``<field name>``,
  419. which is not an attribute of ``<model>``.
  420. * **admin.E003**: The value of ``raw_id_fields[n]`` must be a foreign key or
  421. a many-to-many field.
  422. * **admin.E004**: The value of ``fields`` must be a list or tuple.
  423. * **admin.E005**: Both ``fieldsets`` and ``fields`` are specified.
  424. * **admin.E006**: The value of ``fields`` contains duplicate field(s).
  425. * **admin.E007**: The value of ``fieldsets`` must be a list or tuple.
  426. * **admin.E008**: The value of ``fieldsets[n]`` must be a list or tuple.
  427. * **admin.E009**: The value of ``fieldsets[n]`` must be of length 2.
  428. * **admin.E010**: The value of ``fieldsets[n][1]`` must be a dictionary.
  429. * **admin.E011**: The value of ``fieldsets[n][1]`` must contain the key
  430. ``fields``.
  431. * **admin.E012**: There are duplicate field(s) in ``fieldsets[n][1]``.
  432. * **admin.E013**: ``fields[n]/fieldsets[n][m]`` cannot include the
  433. ``ManyToManyField`` ``<field name>``, because that field manually specifies a
  434. relationship model.
  435. * **admin.E014**: The value of ``exclude`` must be a list or tuple.
  436. * **admin.E015**: The value of ``exclude`` contains duplicate field(s).
  437. * **admin.E016**: The value of ``form`` must inherit from ``BaseModelForm``.
  438. * **admin.E017**: The value of ``filter_vertical`` must be a list or tuple.
  439. * **admin.E018**: The value of ``filter_horizontal`` must be a list or tuple.
  440. * **admin.E019**: The value of ``filter_vertical[n]/filter_vertical[n]`` refers
  441. to ``<field name>``, which is not an attribute of ``<model>``.
  442. * **admin.E020**: The value of ``filter_vertical[n]/filter_vertical[n]`` must
  443. be a many-to-many field.
  444. * **admin.E021**: The value of ``radio_fields`` must be a dictionary.
  445. * **admin.E022**: The value of ``radio_fields`` refers to ``<field name>``,
  446. which is not an attribute of ``<model>``.
  447. * **admin.E023**: The value of ``radio_fields`` refers to ``<field name>``,
  448. which is not a ``ForeignKey``, and does not have a ``choices`` definition.
  449. * **admin.E024**: The value of ``radio_fields[<field name>]`` must be either
  450. ``admin.HORIZONTAL`` or ``admin.VERTICAL``.
  451. * **admin.E025**: The value of ``view_on_site`` must be either a callable or a
  452. boolean value.
  453. * **admin.E026**: The value of ``prepopulated_fields`` must be a dictionary.
  454. * **admin.E027**: The value of ``prepopulated_fields`` refers to
  455. ``<field name>``, which is not an attribute of ``<model>``.
  456. * **admin.E028**: The value of ``prepopulated_fields`` refers to
  457. ``<field name>``, which must not be a ``DateTimeField``, a ``ForeignKey``,
  458. a ``OneToOneField``, or a ``ManyToManyField`` field.
  459. * **admin.E029**: The value of ``prepopulated_fields[<field name>]`` must be a
  460. list or tuple.
  461. * **admin.E030**: The value of ``prepopulated_fields`` refers to
  462. ``<field name>``, which is not an attribute of ``<model>``.
  463. * **admin.E031**: The value of ``ordering`` must be a list or tuple.
  464. * **admin.E032**: The value of ``ordering`` has the random ordering marker
  465. ``?``, but contains other fields as well.
  466. * **admin.E033**: The value of ``ordering`` refers to ``<field name>``, which
  467. is not an attribute of ``<model>``.
  468. * **admin.E034**: The value of ``readonly_fields`` must be a list or tuple.
  469. * **admin.E035**: The value of ``readonly_fields[n]`` is not a callable, an
  470. attribute of ``<ModelAdmin class>``, or an attribute of ``<model>``.
  471. ``ModelAdmin``
  472. ~~~~~~~~~~~~~~
  473. The following checks are performed on any
  474. :class:`~django.contrib.admin.ModelAdmin` that is registered
  475. with the admin site:
  476. * **admin.E101**: The value of ``save_as`` must be a boolean.
  477. * **admin.E102**: The value of ``save_on_top`` must be a boolean.
  478. * **admin.E103**: The value of ``inlines`` must be a list or tuple.
  479. * **admin.E104**: ``<InlineModelAdmin class>`` must inherit from
  480. ``InlineModelAdmin``.
  481. * **admin.E105**: ``<InlineModelAdmin class>`` must have a ``model`` attribute.
  482. * **admin.E106**: The value of ``<InlineModelAdmin class>.model`` must be a
  483. ``Model``.
  484. * **admin.E107**: The value of ``list_display`` must be a list or tuple.
  485. * **admin.E108**: The value of ``list_display[n]`` refers to ``<label>``,
  486. which is not a callable, an attribute of ``<ModelAdmin class>``, or an
  487. attribute or method on ``<model>``.
  488. * **admin.E109**: The value of ``list_display[n]`` must not be a
  489. ``ManyToManyField`` field.
  490. * **admin.E110**: The value of ``list_display_links`` must be a list, a tuple,
  491. or ``None``.
  492. * **admin.E111**: The value of ``list_display_links[n]`` refers to ``<label>``,
  493. which is not defined in ``list_display``.
  494. * **admin.E112**: The value of ``list_filter`` must be a list or tuple.
  495. * **admin.E113**: The value of ``list_filter[n]`` must inherit from
  496. ``ListFilter``.
  497. * **admin.E114**: The value of ``list_filter[n]`` must not inherit from
  498. ``FieldListFilter``.
  499. * **admin.E115**: The value of ``list_filter[n][1]`` must inherit from
  500. ``FieldListFilter``.
  501. * **admin.E116**: The value of ``list_filter[n]`` refers to ``<label>``,
  502. which does not refer to a Field.
  503. * **admin.E117**: The value of ``list_select_related`` must be a boolean,
  504. tuple or list.
  505. * **admin.E118**: The value of ``list_per_page`` must be an integer.
  506. * **admin.E119**: The value of ``list_max_show_all`` must be an integer.
  507. * **admin.E120**: The value of ``list_editable`` must be a list or tuple.
  508. * **admin.E121**: The value of ``list_editable[n]`` refers to ``<label>``,
  509. which is not an attribute of ``<model>``.
  510. * **admin.E122**: The value of ``list_editable[n]`` refers to ``<label>``,
  511. which is not contained in ``list_display``.
  512. * **admin.E123**: The value of ``list_editable[n]`` cannot be in both
  513. ``list_editable`` and ``list_display_links``.
  514. * **admin.E124**: The value of ``list_editable[n]`` refers to the first field
  515. in ``list_display`` (``<label>``), which cannot be used unless
  516. ``list_display_links`` is set.
  517. * **admin.E125**: The value of ``list_editable[n]`` refers to ``<field name>``,
  518. which is not editable through the admin.
  519. * **admin.E126**: The value of ``search_fields`` must be a list or tuple.
  520. * **admin.E127**: The value of ``date_hierarchy`` refers to ``<field name>``,
  521. which does not refer to a Field.
  522. * **admin.E128**: The value of ``date_hierarchy`` must be a ``DateField`` or
  523. ``DateTimeField``.
  524. ``InlineModelAdmin``
  525. ~~~~~~~~~~~~~~~~~~~~
  526. The following checks are performed on any
  527. :class:`~django.contrib.admin.InlineModelAdmin` that is registered as an
  528. inline on a :class:`~django.contrib.admin.ModelAdmin`.
  529. * **admin.E201**: Cannot exclude the field ``<field name>``, because it is the
  530. foreign key to the parent model ``<app_label>.<model>``.
  531. * **admin.E202**: ``<model>`` has no ``ForeignKey`` to ``<parent model>``./
  532. ``<model>`` has more than one ``ForeignKey`` to ``<parent model>``.
  533. * **admin.E203**: The value of ``extra`` must be an integer.
  534. * **admin.E204**: The value of ``max_num`` must be an integer.
  535. * **admin.E205**: The value of ``min_num`` must be an integer.
  536. * **admin.E206**: The value of ``formset`` must inherit from
  537. ``BaseModelFormSet``.
  538. ``GenericInlineModelAdmin``
  539. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  540. The following checks are performed on any
  541. :class:`~django.contrib.contenttypes.admin.GenericInlineModelAdmin` that is
  542. registered as an inline on a :class:`~django.contrib.admin.ModelAdmin`.
  543. * **admin.E301**: ``'ct_field'`` references ``<label>``, which is not a field
  544. on ``<model>``.
  545. * **admin.E302**: ``'ct_fk_field'`` references ``<label>``, which is not a
  546. field on ``<model>``.
  547. * **admin.E303**: ``<model>`` has no ``GenericForeignKey``.
  548. * **admin.E304**: ``<model>`` has no ``GenericForeignKey`` using content type
  549. field ``<field name>`` and object ID field ``<field name>``.
  550. ``AdminSite``
  551. ~~~~~~~~~~~~~
  552. The following checks are performed on the default
  553. :class:`~django.contrib.admin.AdminSite`:
  554. * **admin.E401**: :mod:`django.contrib.contenttypes` must be in
  555. :setting:`INSTALLED_APPS` in order to use the admin application.
  556. * **admin.E402**: :mod:`django.contrib.auth.context_processors.auth`
  557. must be in :setting:`TEMPLATES` in order to use the admin application.
  558. ``auth``
  559. --------
  560. * **auth.E001**: ``REQUIRED_FIELDS`` must be a list or tuple.
  561. * **auth.E002**: The field named as the ``USERNAME_FIELD`` for a custom user
  562. model must not be included in ``REQUIRED_FIELDS``.
  563. * **auth.E003**: ``<field>`` must be unique because it is named as the
  564. ``USERNAME_FIELD``.
  565. * **auth.W004**: ``<field>`` is named as the ``USERNAME_FIELD``, but it is not
  566. unique.
  567. * **auth.E005**: The permission codenamed ``<codename>`` clashes with a builtin
  568. permission for model ``<model>``.
  569. * **auth.E006**: The permission codenamed ``<codename>`` is duplicated for model
  570. ``<model>``.
  571. * **auth.E007**: The :attr:`verbose_name
  572. <django.db.models.Options.verbose_name>` of model ``<model>`` must be at most
  573. 244 characters for its builtin permission names
  574. to be at most 255 characters.
  575. * **auth.E008**: The permission named ``<name>`` of model ``<model>`` is longer
  576. than 255 characters.
  577. * **auth.C009**: ``<User model>.is_anonymous`` must be an attribute or property
  578. rather than a method. Ignoring this is a security issue as anonymous users
  579. will be treated as authenticated!
  580. * **auth.C010**: ``<User model>.is_authenticated`` must be an attribute or
  581. property rather than a method. Ignoring this is a security issue as anonymous
  582. users will be treated as authenticated!
  583. ``contenttypes``
  584. ----------------
  585. The following checks are performed when a model contains a
  586. :class:`~django.contrib.contenttypes.fields.GenericForeignKey` or
  587. :class:`~django.contrib.contenttypes.fields.GenericRelation`:
  588. * **contenttypes.E001**: The ``GenericForeignKey`` object ID references the
  589. nonexistent field ``<field>``.
  590. * **contenttypes.E002**: The ``GenericForeignKey`` content type references the
  591. nonexistent field ``<field>``.
  592. * **contenttypes.E003**: ``<field>`` is not a ``ForeignKey``.
  593. * **contenttypes.E004**: ``<field>`` is not a ``ForeignKey`` to
  594. ``contenttypes.ContentType``.
  595. ``sites``
  596. ---------
  597. The following checks are performed on any model using a
  598. :class:`~django.contrib.sites.managers.CurrentSiteManager`:
  599. * **sites.E001**: ``CurrentSiteManager`` could not find a field named
  600. ``<field name>``.
  601. * **sites.E002**: ``CurrentSiteManager`` cannot use ``<field>`` as it is not a
  602. foreign key or a many-to-many field.
  603. ``staticfiles``
  604. ---------------
  605. The following checks verify that :mod:`django.contrib.staticfiles` is correctly
  606. configured:
  607. * **staticfiles.E001**: The :setting:`STATICFILES_DIRS` setting is not a tuple
  608. or list.
  609. * **staticfiles.E002**: The :setting:`STATICFILES_DIRS` setting should not
  610. contain the :setting:`STATIC_ROOT` setting.