checks.txt 33 KB

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