checks.txt 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744
  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. * ``translation``: Checks translation related configuration.
  70. * ``urls``: Checks URL configuration.
  71. Some checks may be registered with multiple tags.
  72. Core system checks
  73. ==================
  74. Backwards compatibility
  75. -----------------------
  76. Compatibility checks warn of potential problems that might occur after
  77. upgrading Django.
  78. * **2_0.W001**: Your URL pattern ``<pattern>`` has a ``route`` that contains
  79. ``(?P<``, begins with a ``^``, or ends with a ``$``. This was likely an
  80. oversight when migrating from ``url()`` to :func:`~django.urls.path`.
  81. Caches
  82. ------
  83. The following checks verify that your :setting:`CACHES` setting is correctly
  84. configured:
  85. * **caches.E001**: You must define a ``'default'`` cache in your
  86. :setting:`CACHES` setting.
  87. Database
  88. --------
  89. MySQL
  90. ~~~~~
  91. If you're using MySQL, the following checks will be performed:
  92. * **mysql.E001**: MySQL does not allow unique ``CharField``\s to have a
  93. ``max_length`` > 255.
  94. * **mysql.W002**: MySQL Strict Mode is not set for database connection
  95. '<alias>'. See also :ref:`mysql-sql-mode`.
  96. Model fields
  97. ------------
  98. * **fields.E001**: Field names must not end with an underscore.
  99. * **fields.E002**: Field names must not contain ``"__"``.
  100. * **fields.E003**: ``pk`` is a reserved word that cannot be used as a field
  101. name.
  102. * **fields.E004**: ``choices`` must be an iterable (e.g., a list or tuple).
  103. * **fields.E005**: ``choices`` must be an iterable returning ``(actual value,
  104. human readable name)`` tuples.
  105. * **fields.E006**: ``db_index`` must be ``None``, ``True`` or ``False``.
  106. * **fields.E007**: Primary keys must not have ``null=True``.
  107. * **fields.E008**: All ``validators`` must be callable.
  108. * **fields.E100**: ``AutoField``\s must set primary_key=True.
  109. * **fields.E110**: ``BooleanField``\s do not accept null values. *This check
  110. appeared before support for null values was added in Django 2.1.*
  111. * **fields.E120**: ``CharField``\s must define a ``max_length`` attribute.
  112. * **fields.E121**: ``max_length`` must be a positive integer.
  113. * **fields.W122**: ``max_length`` is ignored when used with
  114. ``<integer field type>``.
  115. * **fields.E130**: ``DecimalField``\s must define a ``decimal_places`` attribute.
  116. * **fields.E131**: ``decimal_places`` must be a non-negative integer.
  117. * **fields.E132**: ``DecimalField``\s must define a ``max_digits`` attribute.
  118. * **fields.E133**: ``max_digits`` must be a non-negative integer.
  119. * **fields.E134**: ``max_digits`` must be greater or equal to ``decimal_places``.
  120. * **fields.E140**: ``FilePathField``\s must have either ``allow_files`` or
  121. ``allow_folders`` set to True.
  122. * **fields.E150**: ``GenericIPAddressField``\s cannot accept blank values if
  123. null values are not allowed, as blank values are stored as nulls.
  124. * **fields.E160**: The options ``auto_now``, ``auto_now_add``, and ``default``
  125. are mutually exclusive. Only one of these options may be present.
  126. * **fields.W161**: Fixed default value provided.
  127. * **fields.W162**: ``<database>`` does not support a database index on
  128. ``<field data type>`` columns.
  129. * **fields.E170**: ``BinaryField``’s ``default`` cannot be a string. Use bytes
  130. content instead.
  131. * **fields.E900**: ``IPAddressField`` has been removed except for support in
  132. historical migrations.
  133. * **fields.W900**: ``IPAddressField`` has been deprecated. Support for it
  134. (except in historical migrations) will be removed in Django 1.9. *This check
  135. appeared in Django 1.7 and 1.8*.
  136. * **fields.W901**: ``CommaSeparatedIntegerField`` has been deprecated. Support
  137. for it (except in historical migrations) will be removed in Django 2.0. *This
  138. check appeared in Django 1.10 and 1.11*.
  139. * **fields.E901**: ``CommaSeparatedIntegerField`` is removed except for support
  140. in historical migrations.
  141. * **fields.W902**: ``FloatRangeField`` is deprecated and will be removed in
  142. Django 3.1.
  143. File fields
  144. ~~~~~~~~~~~
  145. * **fields.E200**: ``unique`` is not a valid argument for a ``FileField``.
  146. *This check is removed in Django 1.11*.
  147. * **fields.E201**: ``primary_key`` is not a valid argument for a ``FileField``.
  148. * **fields.E202**: ``FileField``’s ``upload_to`` argument must be a relative
  149. path, not an absolute path.
  150. * **fields.E210**: Cannot use ``ImageField`` because Pillow is not installed.
  151. Related fields
  152. ~~~~~~~~~~~~~~
  153. * **fields.E300**: Field defines a relation with model ``<model>``, which is
  154. either not installed, or is abstract.
  155. * **fields.E301**: Field defines a relation with the model ``<model>`` which
  156. has been swapped out.
  157. * **fields.E302**: Accessor for field ``<field name>`` clashes with field
  158. ``<field name>``.
  159. * **fields.E303**: Reverse query name for field ``<field name>`` clashes with
  160. field ``<field name>``.
  161. * **fields.E304**: Field name ``<field name>`` clashes with accessor for
  162. ``<field name>``.
  163. * **fields.E305**: Field name ``<field name>`` clashes with reverse query name
  164. for ``<field name>``.
  165. * **fields.E306**: Related name must be a valid Python identifier or end with
  166. a ``'+'``.
  167. * **fields.E307**: The field ``<app label>.<model>.<field name>`` was declared
  168. with a lazy reference to ``<app label>.<model>``, but app ``<app label>``
  169. isn't installed or doesn't provide model ``<model>``.
  170. * **fields.E308**: Reverse query name ``<related query name>`` must not end
  171. with an underscore.
  172. * **fields.E309**: Reverse query name ``<related query name>`` must not contain
  173. ``'__'``.
  174. * **fields.E310**: No subset of the fields ``<field1>``, ``<field2>``, ... on
  175. model ``<model>`` is unique. Add ``unique=True`` on any of those fields or
  176. add at least a subset of them to a unique_together constraint.
  177. * **fields.E311**: ``<model>`` must set ``unique=True`` because it is
  178. referenced by a ``ForeignKey``.
  179. * **fields.E312**: The ``to_field`` ``<field name>`` doesn't exist on the
  180. related model ``<app label>.<model>``.
  181. * **fields.E320**: Field specifies ``on_delete=SET_NULL``, but cannot be null.
  182. * **fields.E321**: The field specifies ``on_delete=SET_DEFAULT``, but has no
  183. default value.
  184. * **fields.E330**: ``ManyToManyField``\s cannot be unique.
  185. * **fields.E331**: Field specifies a many-to-many relation through model
  186. ``<model>``, which has not been installed.
  187. * **fields.E332**: Many-to-many fields with intermediate tables must not be
  188. symmetrical.
  189. * **fields.E333**: The model is used as an intermediate model by ``<model>``,
  190. but it has more than two foreign keys to ``<model>``, which is ambiguous.
  191. You must specify which two foreign keys Django should use via the
  192. ``through_fields`` keyword argument.
  193. * **fields.E334**: The model is used as an intermediate model by ``<model>``,
  194. but it has more than one foreign key from ``<model>``, which is ambiguous.
  195. You must specify which foreign key Django should use via the
  196. ``through_fields`` keyword argument.
  197. * **fields.E335**: The model is used as an intermediate model by ``<model>``,
  198. but it has more than one foreign key to ``<model>``, which is ambiguous.
  199. You must specify which foreign key Django should use via the
  200. ``through_fields`` keyword argument.
  201. * **fields.E336**: The model is used as an intermediary model by ``<model>``,
  202. but it does not have foreign key to ``<model>`` or ``<model>``.
  203. * **fields.E337**: Field specifies ``through_fields`` but does not provide the
  204. names of the two link fields that should be used for the relation through
  205. ``<model>``.
  206. * **fields.E338**: The intermediary model ``<through model>`` has no field
  207. ``<field name>``.
  208. * **fields.E339**: ``<model>.<field name>`` is not a foreign key to ``<model>``.
  209. * **fields.E340**: The field's intermediary table ``<table name>`` clashes with
  210. the table name of ``<model>``/``<model>.<field name>``.
  211. * **fields.W340**: ``null`` has no effect on ``ManyToManyField``.
  212. * **fields.W341**: ``ManyToManyField`` does not support ``validators``.
  213. * **fields.W342**: Setting ``unique=True`` on a ``ForeignKey`` has the same
  214. effect as using a ``OneToOneField``.
  215. * **fields.W343**: ``limit_choices_to`` has no effect on ``ManyToManyField``
  216. with a ``through`` model.
  217. Models
  218. ------
  219. * **models.E001**: ``<swappable>`` is not of the form ``app_label.app_name``.
  220. * **models.E002**: ``<SETTING>`` references ``<model>``, which has not been
  221. installed, or is abstract.
  222. * **models.E003**: The model has two identical many-to-many relations through
  223. the intermediate model ``<app_label>.<model>``.
  224. * **models.E004**: ``id`` can only be used as a field name if the field also
  225. sets ``primary_key=True``.
  226. * **models.E005**: The field ``<field name>`` from parent model ``<model>``
  227. clashes with the field ``<field name>`` from parent model ``<model>``.
  228. * **models.E006**: The field clashes with the field ``<field name>`` from model
  229. ``<model>``.
  230. * **models.E007**: Field ``<field name>`` has column name ``<column name>``
  231. that is used by another field.
  232. * **models.E008**: ``index_together`` must be a list or tuple.
  233. * **models.E009**: All ``index_together`` elements must be lists or tuples.
  234. * **models.E010**: ``unique_together`` must be a list or tuple.
  235. * **models.E011**: All ``unique_together`` elements must be lists or tuples.
  236. * **models.E012**: ``indexes/index_together/unique_together`` refers to the
  237. nonexistent field ``<field name>``.
  238. * **models.E013**: ``indexes/index_together/unique_together`` refers to a
  239. ``ManyToManyField`` ``<field name>``, but ``ManyToManyField``\s are not
  240. supported for that option.
  241. * **models.E014**: ``ordering`` must be a tuple or list (even if you want to
  242. order by only one field).
  243. * **models.E015**: ``ordering`` refers to the nonexistent field, related field,
  244. or lookup ``<field name>``.
  245. * **models.E016**: ``indexes/index_together/unique_together`` refers to field
  246. ``<field_name>`` which is not local to model ``<model>``.
  247. * **models.E017**: Proxy model ``<model>`` contains model fields.
  248. * **models.E018**: Autogenerated column name too long for field ``<field>``.
  249. Maximum length is ``<maximum length>`` for database ``<alias>``.
  250. * **models.E019**: Autogenerated column name too long for M2M field
  251. ``<M2M field>``. Maximum length is ``<maximum length>`` for database
  252. ``<alias>``.
  253. * **models.E020**: The ``<model>.check()`` class method is currently overridden.
  254. * **models.E021**: ``ordering`` and ``order_with_respect_to`` cannot be used
  255. together.
  256. * **models.E022**: ``<function>`` contains a lazy reference to
  257. ``<app label>.<model>``, but app ``<app label>`` isn't installed or
  258. doesn't provide model ``<model>``.
  259. * **models.E023**: The model name ``<model>`` cannot start or end with an
  260. underscore as it collides with the query lookup syntax.
  261. * **models.E024**: The model name ``<model>`` cannot contain double underscores
  262. as it collides with the query lookup syntax.
  263. * **models.E025**: The property ``<property name>`` clashes with a related
  264. field accessor.
  265. * **models.E026**: The model cannot have more than one field with
  266. ``primary_key=True``.
  267. * **models.W027**: ``<database>`` does not support check constraints.
  268. * **models.E028**: ``db_table`` ``<db_table>`` is used by multiple models:
  269. ``<model list>``.
  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. Translation
  388. -----------
  389. The following checks are performed on your translation configuration:
  390. * **translation.E001**: You have provided an invalid value for the
  391. :setting:`LANGUAGE_CODE` setting.
  392. URLs
  393. ----
  394. The following checks are performed on your URL configuration:
  395. * **urls.W001**: Your URL pattern ``<pattern>`` uses
  396. :func:`~django.urls.include` with a ``route`` ending with a ``$``. Remove the
  397. dollar from the ``route`` to avoid problems including URLs.
  398. * **urls.W002**: Your URL pattern ``<pattern>`` has a ``route`` beginning with
  399. a ``/``. Remove this slash as it is unnecessary. If this pattern is targeted
  400. in an :func:`~django.urls.include`, ensure the :func:`~django.urls.include`
  401. pattern has a trailing ``/``.
  402. * **urls.W003**: Your URL pattern ``<pattern>`` has a ``name``
  403. including a ``:``. Remove the colon, to avoid ambiguous namespace
  404. references.
  405. * **urls.E004**: Your URL pattern ``<pattern>`` is invalid. Ensure that
  406. ``urlpatterns`` is a list of :func:`~django.urls.path` and/or
  407. :func:`~django.urls.re_path` instances.
  408. * **urls.W005**: URL namespace ``<namespace>`` isn't unique. You may not be
  409. able to reverse all URLs in this namespace.
  410. * **urls.E006**: The :setting:`MEDIA_URL`/ :setting:`STATIC_URL` setting must
  411. end with a slash.
  412. * **urls.E007**: The custom ``handlerXXX`` view ``'path.to.view'`` does not
  413. take the correct number of arguments (…).
  414. ``contrib`` app checks
  415. ======================
  416. ``admin``
  417. ---------
  418. Admin checks are all performed as part of the ``admin`` tag.
  419. The following checks are performed on any
  420. :class:`~django.contrib.admin.ModelAdmin` (or subclass) that is registered
  421. with the admin site:
  422. * **admin.E001**: The value of ``raw_id_fields`` must be a list or tuple.
  423. * **admin.E002**: The value of ``raw_id_fields[n]`` refers to ``<field name>``,
  424. which is not an attribute of ``<model>``.
  425. * **admin.E003**: The value of ``raw_id_fields[n]`` must be a foreign key or
  426. a many-to-many field.
  427. * **admin.E004**: The value of ``fields`` must be a list or tuple.
  428. * **admin.E005**: Both ``fieldsets`` and ``fields`` are specified.
  429. * **admin.E006**: The value of ``fields`` contains duplicate field(s).
  430. * **admin.E007**: The value of ``fieldsets`` must be a list or tuple.
  431. * **admin.E008**: The value of ``fieldsets[n]`` must be a list or tuple.
  432. * **admin.E009**: The value of ``fieldsets[n]`` must be of length 2.
  433. * **admin.E010**: The value of ``fieldsets[n][1]`` must be a dictionary.
  434. * **admin.E011**: The value of ``fieldsets[n][1]`` must contain the key
  435. ``fields``.
  436. * **admin.E012**: There are duplicate field(s) in ``fieldsets[n][1]``.
  437. * **admin.E013**: ``fields[n]/fieldsets[n][m]`` cannot include the
  438. ``ManyToManyField`` ``<field name>``, because that field manually specifies a
  439. relationship model.
  440. * **admin.E014**: The value of ``exclude`` must be a list or tuple.
  441. * **admin.E015**: The value of ``exclude`` contains duplicate field(s).
  442. * **admin.E016**: The value of ``form`` must inherit from ``BaseModelForm``.
  443. * **admin.E017**: The value of ``filter_vertical`` must be a list or tuple.
  444. * **admin.E018**: The value of ``filter_horizontal`` must be a list or tuple.
  445. * **admin.E019**: The value of ``filter_vertical[n]/filter_vertical[n]`` refers
  446. to ``<field name>``, which is not an attribute of ``<model>``.
  447. * **admin.E020**: The value of ``filter_vertical[n]/filter_vertical[n]`` must
  448. be a many-to-many field.
  449. * **admin.E021**: The value of ``radio_fields`` must be a dictionary.
  450. * **admin.E022**: The value of ``radio_fields`` refers to ``<field name>``,
  451. which is not an attribute of ``<model>``.
  452. * **admin.E023**: The value of ``radio_fields`` refers to ``<field name>``,
  453. which is not a ``ForeignKey``, and does not have a ``choices`` definition.
  454. * **admin.E024**: The value of ``radio_fields[<field name>]`` must be either
  455. ``admin.HORIZONTAL`` or ``admin.VERTICAL``.
  456. * **admin.E025**: The value of ``view_on_site`` must be either a callable or a
  457. boolean value.
  458. * **admin.E026**: The value of ``prepopulated_fields`` must be a dictionary.
  459. * **admin.E027**: The value of ``prepopulated_fields`` refers to
  460. ``<field name>``, which is not an attribute of ``<model>``.
  461. * **admin.E028**: The value of ``prepopulated_fields`` refers to
  462. ``<field name>``, which must not be a ``DateTimeField``, a ``ForeignKey``,
  463. a ``OneToOneField``, or a ``ManyToManyField`` field.
  464. * **admin.E029**: The value of ``prepopulated_fields[<field name>]`` must be a
  465. list or tuple.
  466. * **admin.E030**: The value of ``prepopulated_fields`` refers to
  467. ``<field name>``, which is not an attribute of ``<model>``.
  468. * **admin.E031**: The value of ``ordering`` must be a list or tuple.
  469. * **admin.E032**: The value of ``ordering`` has the random ordering marker
  470. ``?``, but contains other fields as well.
  471. * **admin.E033**: The value of ``ordering`` refers to ``<field name>``, which
  472. is not an attribute of ``<model>``.
  473. * **admin.E034**: The value of ``readonly_fields`` must be a list or tuple.
  474. * **admin.E035**: The value of ``readonly_fields[n]`` is not a callable, an
  475. attribute of ``<ModelAdmin class>``, or an attribute of ``<model>``.
  476. * **admin.E036**: The value of ``autocomplete_fields`` must be a list or tuple.
  477. * **admin.E037**: The value of ``autocomplete_fields[n]`` refers to
  478. ``<field name>``, which is not an attribute of ``<model>``.
  479. * **admin.E038**: The value of ``autocomplete_fields[n]`` must be a foreign
  480. key or a many-to-many field.
  481. * **admin.E039**: An admin for model ``<model>`` has to be registered to be
  482. referenced by ``<modeladmin>.autocomplete_fields``.
  483. * **admin.E040**: ``<modeladmin>`` must define ``search_fields``, because
  484. it's referenced by ``<other_modeladmin>.autocomplete_fields``.
  485. ``ModelAdmin``
  486. ~~~~~~~~~~~~~~
  487. The following checks are performed on any
  488. :class:`~django.contrib.admin.ModelAdmin` that is registered
  489. with the admin site:
  490. * **admin.E101**: The value of ``save_as`` must be a boolean.
  491. * **admin.E102**: The value of ``save_on_top`` must be a boolean.
  492. * **admin.E103**: The value of ``inlines`` must be a list or tuple.
  493. * **admin.E104**: ``<InlineModelAdmin class>`` must inherit from
  494. ``InlineModelAdmin``.
  495. * **admin.E105**: ``<InlineModelAdmin class>`` must have a ``model`` attribute.
  496. * **admin.E106**: The value of ``<InlineModelAdmin class>.model`` must be a
  497. ``Model``.
  498. * **admin.E107**: The value of ``list_display`` must be a list or tuple.
  499. * **admin.E108**: The value of ``list_display[n]`` refers to ``<label>``,
  500. which is not a callable, an attribute of ``<ModelAdmin class>``, or an
  501. attribute or method on ``<model>``.
  502. * **admin.E109**: The value of ``list_display[n]`` must not be a
  503. ``ManyToManyField`` field.
  504. * **admin.E110**: The value of ``list_display_links`` must be a list, a tuple,
  505. or ``None``.
  506. * **admin.E111**: The value of ``list_display_links[n]`` refers to ``<label>``,
  507. which is not defined in ``list_display``.
  508. * **admin.E112**: The value of ``list_filter`` must be a list or tuple.
  509. * **admin.E113**: The value of ``list_filter[n]`` must inherit from
  510. ``ListFilter``.
  511. * **admin.E114**: The value of ``list_filter[n]`` must not inherit from
  512. ``FieldListFilter``.
  513. * **admin.E115**: The value of ``list_filter[n][1]`` must inherit from
  514. ``FieldListFilter``.
  515. * **admin.E116**: The value of ``list_filter[n]`` refers to ``<label>``,
  516. which does not refer to a Field.
  517. * **admin.E117**: The value of ``list_select_related`` must be a boolean,
  518. tuple or list.
  519. * **admin.E118**: The value of ``list_per_page`` must be an integer.
  520. * **admin.E119**: The value of ``list_max_show_all`` must be an integer.
  521. * **admin.E120**: The value of ``list_editable`` must be a list or tuple.
  522. * **admin.E121**: The value of ``list_editable[n]`` refers to ``<label>``,
  523. which is not an attribute of ``<model>``.
  524. * **admin.E122**: The value of ``list_editable[n]`` refers to ``<label>``,
  525. which is not contained in ``list_display``.
  526. * **admin.E123**: The value of ``list_editable[n]`` cannot be in both
  527. ``list_editable`` and ``list_display_links``.
  528. * **admin.E124**: The value of ``list_editable[n]`` refers to the first field
  529. in ``list_display`` (``<label>``), which cannot be used unless
  530. ``list_display_links`` is set.
  531. * **admin.E125**: The value of ``list_editable[n]`` refers to ``<field name>``,
  532. which is not editable through the admin.
  533. * **admin.E126**: The value of ``search_fields`` must be a list or tuple.
  534. * **admin.E127**: The value of ``date_hierarchy`` refers to ``<field name>``,
  535. which does not refer to a Field.
  536. * **admin.E128**: The value of ``date_hierarchy`` must be a ``DateField`` or
  537. ``DateTimeField``.
  538. * **admin.E129**: ``<modeladmin>`` must define a ``has_<foo>_permission()``
  539. method for the ``<action>`` action.
  540. * **admin.E130**: ``__name__`` attributes of actions defined in
  541. ``<modeladmin>`` must be unique.
  542. ``InlineModelAdmin``
  543. ~~~~~~~~~~~~~~~~~~~~
  544. The following checks are performed on any
  545. :class:`~django.contrib.admin.InlineModelAdmin` that is registered as an
  546. inline on a :class:`~django.contrib.admin.ModelAdmin`.
  547. * **admin.E201**: Cannot exclude the field ``<field name>``, because it is the
  548. foreign key to the parent model ``<app_label>.<model>``.
  549. * **admin.E202**: ``<model>`` has no ``ForeignKey`` to ``<parent model>``./
  550. ``<model>`` has more than one ``ForeignKey`` to ``<parent model>``.
  551. * **admin.E203**: The value of ``extra`` must be an integer.
  552. * **admin.E204**: The value of ``max_num`` must be an integer.
  553. * **admin.E205**: The value of ``min_num`` must be an integer.
  554. * **admin.E206**: The value of ``formset`` must inherit from
  555. ``BaseModelFormSet``.
  556. ``GenericInlineModelAdmin``
  557. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  558. The following checks are performed on any
  559. :class:`~django.contrib.contenttypes.admin.GenericInlineModelAdmin` that is
  560. registered as an inline on a :class:`~django.contrib.admin.ModelAdmin`.
  561. * **admin.E301**: ``'ct_field'`` references ``<label>``, which is not a field
  562. on ``<model>``.
  563. * **admin.E302**: ``'ct_fk_field'`` references ``<label>``, which is not a
  564. field on ``<model>``.
  565. * **admin.E303**: ``<model>`` has no ``GenericForeignKey``.
  566. * **admin.E304**: ``<model>`` has no ``GenericForeignKey`` using content type
  567. field ``<field name>`` and object ID field ``<field name>``.
  568. ``AdminSite``
  569. ~~~~~~~~~~~~~
  570. The following checks are performed on the default
  571. :class:`~django.contrib.admin.AdminSite`:
  572. * **admin.E401**: :mod:`django.contrib.contenttypes` must be in
  573. :setting:`INSTALLED_APPS` in order to use the admin application.
  574. * **admin.E402**: :mod:`django.contrib.auth.context_processors.auth`
  575. must be enabled in :class:`~django.template.backends.django.DjangoTemplates`
  576. (:setting:`TEMPLATES`) if using the default auth backend in order to use the
  577. admin application.
  578. * **admin.E403**: A :class:`django.template.backends.django.DjangoTemplates`
  579. instance must be configured in :setting:`TEMPLATES` in order to use the
  580. admin application.
  581. * **admin.E404**: ``django.contrib.messages.context_processors.messages``
  582. must be enabled in :class:`~django.template.backends.django.DjangoTemplates`
  583. (:setting:`TEMPLATES`) in order to use the admin application.
  584. * **admin.E405**: :mod:`django.contrib.auth` must be in
  585. :setting:`INSTALLED_APPS` in order to use the admin application.
  586. * **admin.E406**: :mod:`django.contrib.messages` must be in
  587. :setting:`INSTALLED_APPS` in order to use the admin application.
  588. * **admin.E407**: :mod:`django.contrib.sessions` must be in
  589. :setting:`INSTALLED_APPS` in order to use the admin application.
  590. * **admin.E408**:
  591. :class:`django.contrib.auth.middleware.AuthenticationMiddleware` must be in
  592. :setting:`MIDDLEWARE` in order to use the admin application.
  593. * **admin.E409**: :class:`django.contrib.messages.middleware.MessageMiddleware`
  594. must be in :setting:`MIDDLEWARE` in order to use the admin application.
  595. ``auth``
  596. --------
  597. * **auth.E001**: ``REQUIRED_FIELDS`` must be a list or tuple.
  598. * **auth.E002**: The field named as the ``USERNAME_FIELD`` for a custom user
  599. model must not be included in ``REQUIRED_FIELDS``.
  600. * **auth.E003**: ``<field>`` must be unique because it is named as the
  601. ``USERNAME_FIELD``.
  602. * **auth.W004**: ``<field>`` is named as the ``USERNAME_FIELD``, but it is not
  603. unique.
  604. * **auth.E005**: The permission codenamed ``<codename>`` clashes with a builtin
  605. permission for model ``<model>``.
  606. * **auth.E006**: The permission codenamed ``<codename>`` is duplicated for model
  607. ``<model>``.
  608. * **auth.E007**: The :attr:`verbose_name
  609. <django.db.models.Options.verbose_name>` of model ``<model>`` must be at most
  610. 244 characters for its builtin permission names
  611. to be at most 255 characters.
  612. * **auth.E008**: The permission named ``<name>`` of model ``<model>`` is longer
  613. than 255 characters.
  614. * **auth.C009**: ``<User model>.is_anonymous`` must be an attribute or property
  615. rather than a method. Ignoring this is a security issue as anonymous users
  616. will be treated as authenticated!
  617. * **auth.C010**: ``<User model>.is_authenticated`` must be an attribute or
  618. property rather than a method. Ignoring this is a security issue as anonymous
  619. users will be treated as authenticated!
  620. ``contenttypes``
  621. ----------------
  622. The following checks are performed when a model contains a
  623. :class:`~django.contrib.contenttypes.fields.GenericForeignKey` or
  624. :class:`~django.contrib.contenttypes.fields.GenericRelation`:
  625. * **contenttypes.E001**: The ``GenericForeignKey`` object ID references the
  626. nonexistent field ``<field>``.
  627. * **contenttypes.E002**: The ``GenericForeignKey`` content type references the
  628. nonexistent field ``<field>``.
  629. * **contenttypes.E003**: ``<field>`` is not a ``ForeignKey``.
  630. * **contenttypes.E004**: ``<field>`` is not a ``ForeignKey`` to
  631. ``contenttypes.ContentType``.
  632. * **contenttypes.E005**: Model names must be at most 100 characters.
  633. ``postgres``
  634. ------------
  635. The following checks are performed on :mod:`django.contrib.postgres` model
  636. fields:
  637. * **postgres.E001**: Base field for array has errors: ...
  638. * **postgres.E002**: Base field for array cannot be a related field.
  639. * **postgres.E003**: ``<field>`` default should be a callable instead of an
  640. instance so that it's not shared between all field instances.
  641. ``sites``
  642. ---------
  643. The following checks are performed on any model using a
  644. :class:`~django.contrib.sites.managers.CurrentSiteManager`:
  645. * **sites.E001**: ``CurrentSiteManager`` could not find a field named
  646. ``<field name>``.
  647. * **sites.E002**: ``CurrentSiteManager`` cannot use ``<field>`` as it is not a
  648. foreign key or a many-to-many field.
  649. ``staticfiles``
  650. ---------------
  651. The following checks verify that :mod:`django.contrib.staticfiles` is correctly
  652. configured:
  653. * **staticfiles.E001**: The :setting:`STATICFILES_DIRS` setting is not a tuple
  654. or list.
  655. * **staticfiles.E002**: The :setting:`STATICFILES_DIRS` setting should not
  656. contain the :setting:`STATIC_ROOT` setting.
  657. * **staticfiles.E003**: The prefix ``<prefix>`` in the
  658. :setting:`STATICFILES_DIRS` setting must not end with a slash.