checks.txt 33 KB

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