diff options
Diffstat (limited to 'doc/user_guide/messages/messages_list.rst')
| -rw-r--r-- | doc/user_guide/messages/messages_list.rst | 539 |
1 files changed, 539 insertions, 0 deletions
diff --git a/doc/user_guide/messages/messages_list.rst b/doc/user_guide/messages/messages_list.rst new file mode 100644 index 000000000..c7674dcb7 --- /dev/null +++ b/doc/user_guide/messages/messages_list.rst @@ -0,0 +1,539 @@ +.. _messages-list: + +Overview of all Pylint messages +=============================== + +.. + NOTE This file is auto-generated. Make any changes to the associated + docs extension in 'pylint_messages.py'. + +Pylint can emit the following messages: + +Fatal +----- + +All messages in the fatal category: + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + fatal/astroid-error.rst + fatal/config-parse-error.rst + fatal/fatal.rst + fatal/method-check-failed.rst + fatal/parse-error.rst + +All renamed messages in the fatal category: + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + fatal/old-import-error.rst + + +Error +----- + +All messages in the error category: + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + error/abstract-class-instantiated.rst + error/access-member-before-definition.rst + error/assigning-non-slot.rst + error/assignment-from-no-return.rst + error/assignment-from-none.rst + error/await-outside-async.rst + error/bad-configuration-section.rst + error/bad-except-order.rst + error/bad-exception-context.rst + error/bad-format-character.rst + error/bad-option-value.rst + error/bad-plugin-value.rst + error/bad-reversed-sequence.rst + error/bad-str-strip-call.rst + error/bad-string-format-type.rst + error/bad-super-call.rst + error/bidirectional-unicode.rst + error/broken-collections-callable.rst + error/broken-noreturn.rst + error/catching-non-exception.rst + error/class-variable-slots-conflict.rst + error/continue-in-finally.rst + error/dict-iter-missing-items.rst + error/duplicate-argument-name.rst + error/duplicate-bases.rst + error/format-needs-mapping.rst + error/function-redefined.rst + error/import-error.rst + error/inconsistent-mro.rst + error/inherit-non-class.rst + error/init-is-generator.rst + error/invalid-all-format.rst + error/invalid-all-object.rst + error/invalid-bool-returned.rst + error/invalid-bytes-returned.rst + error/invalid-character-backspace.rst + error/invalid-character-carriage-return.rst + error/invalid-character-esc.rst + error/invalid-character-nul.rst + error/invalid-character-sub.rst + error/invalid-character-zero-width-space.rst + error/invalid-class-object.rst + error/invalid-enum-extension.rst + error/invalid-envvar-value.rst + error/invalid-format-returned.rst + error/invalid-getnewargs-ex-returned.rst + error/invalid-getnewargs-returned.rst + error/invalid-hash-returned.rst + error/invalid-index-returned.rst + error/invalid-length-hint-returned.rst + error/invalid-length-returned.rst + error/invalid-metaclass.rst + error/invalid-repr-returned.rst + error/invalid-sequence-index.rst + error/invalid-slice-index.rst + error/invalid-slots.rst + error/invalid-slots-object.rst + error/invalid-star-assignment-target.rst + error/invalid-str-returned.rst + error/invalid-unary-operand-type.rst + error/invalid-unicode-codec.rst + error/logging-format-truncated.rst + error/logging-too-few-args.rst + error/logging-too-many-args.rst + error/logging-unsupported-format.rst + error/method-hidden.rst + error/misplaced-bare-raise.rst + error/misplaced-format-function.rst + error/missing-format-string-key.rst + error/missing-kwoa.rst + error/mixed-format-string.rst + error/modified-iterating-dict.rst + error/modified-iterating-set.rst + error/no-member.rst + error/no-method-argument.rst + error/no-name-in-module.rst + error/no-self-argument.rst + error/no-value-for-parameter.rst + error/non-iterator-returned.rst + error/nonexistent-operator.rst + error/nonlocal-and-global.rst + error/nonlocal-without-binding.rst + error/not-a-mapping.rst + error/not-an-iterable.rst + error/not-async-context-manager.rst + error/not-callable.rst + error/not-context-manager.rst + error/not-in-loop.rst + error/notimplemented-raised.rst + error/potential-index-error.rst + error/raising-bad-type.rst + error/raising-non-exception.rst + error/redundant-keyword-arg.rst + error/relative-beyond-top-level.rst + error/repeated-keyword.rst + error/return-arg-in-generator.rst + error/return-in-init.rst + error/return-outside-function.rst + error/star-needs-assignment-target.rst + error/syntax-error.rst + error/too-few-format-args.rst + error/too-many-format-args.rst + error/too-many-function-args.rst + error/too-many-star-expressions.rst + error/truncated-format-string.rst + error/undefined-all-variable.rst + error/undefined-variable.rst + error/unexpected-keyword-arg.rst + error/unexpected-special-method-signature.rst + error/unhashable-dict-key.rst + error/unpacking-non-sequence.rst + error/unrecognized-inline-option.rst + error/unrecognized-option.rst + error/unsubscriptable-object.rst + error/unsupported-assignment-operation.rst + error/unsupported-binary-operation.rst + error/unsupported-delete-operation.rst + error/unsupported-membership-test.rst + error/used-before-assignment.rst + error/used-prior-global-declaration.rst + error/yield-inside-async-function.rst + error/yield-outside-function.rst + +All renamed messages in the error category: + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + error/bad-context-manager.rst + error/maybe-no-member.rst + error/old-non-iterator-returned-2.rst + error/old-unbalanced-tuple-unpacking.rst + + +Warning +------- + +All messages in the warning category: + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + warning/abstract-method.rst + warning/anomalous-backslash-in-string.rst + warning/anomalous-unicode-escape-in-string.rst + warning/arguments-differ.rst + warning/arguments-out-of-order.rst + warning/arguments-renamed.rst + warning/assert-on-string-literal.rst + warning/assert-on-tuple.rst + warning/attribute-defined-outside-init.rst + warning/bad-builtin.rst + warning/bad-format-string.rst + warning/bad-format-string-key.rst + warning/bad-indentation.rst + warning/bad-open-mode.rst + warning/bad-staticmethod-argument.rst + warning/bad-thread-instantiation.rst + warning/bare-except.rst + warning/binary-op-exception.rst + warning/boolean-datetime.rst + warning/broad-except.rst + warning/cell-var-from-loop.rst + warning/comparison-with-callable.rst + warning/confusing-with-statement.rst + warning/consider-ternary-expression.rst + warning/dangerous-default-value.rst + warning/deprecated-argument.rst + warning/deprecated-class.rst + warning/deprecated-decorator.rst + warning/deprecated-method.rst + warning/deprecated-module.rst + warning/deprecated-typing-alias.rst + warning/differing-param-doc.rst + warning/differing-type-doc.rst + warning/duplicate-except.rst + warning/duplicate-key.rst + warning/duplicate-string-formatting-argument.rst + warning/duplicate-value.rst + warning/eq-without-hash.rst + warning/eval-used.rst + warning/exec-used.rst + warning/expression-not-assigned.rst + warning/f-string-without-interpolation.rst + warning/fixme.rst + warning/forgotten-debug-statement.rst + warning/format-combined-specification.rst + warning/format-string-without-interpolation.rst + warning/global-at-module-level.rst + warning/global-statement.rst + warning/global-variable-not-assigned.rst + warning/global-variable-undefined.rst + warning/implicit-str-concat.rst + warning/import-self.rst + warning/inconsistent-quotes.rst + warning/invalid-envvar-default.rst + warning/invalid-format-index.rst + warning/invalid-overridden-method.rst + warning/isinstance-second-argument-not-valid-type.rst + warning/keyword-arg-before-vararg.rst + warning/logging-format-interpolation.rst + warning/logging-fstring-interpolation.rst + warning/logging-not-lazy.rst + warning/lost-exception.rst + warning/method-cache-max-size-none.rst + warning/misplaced-future.rst + warning/missing-any-param-doc.rst + warning/missing-format-argument-key.rst + warning/missing-format-attribute.rst + warning/missing-param-doc.rst + warning/missing-parentheses-for-call-in-test.rst + warning/missing-raises-doc.rst + warning/missing-return-doc.rst + warning/missing-return-type-doc.rst + warning/missing-type-doc.rst + warning/missing-yield-doc.rst + warning/missing-yield-type-doc.rst + warning/modified-iterating-list.rst + warning/multiple-constructor-doc.rst + warning/nan-comparison.rst + warning/non-ascii-file-name.rst + warning/non-parent-init-called.rst + warning/non-str-assignment-to-dunder-name.rst + warning/overlapping-except.rst + warning/overridden-final-method.rst + warning/pointless-statement.rst + warning/pointless-string-statement.rst + warning/possibly-unused-variable.rst + warning/preferred-module.rst + warning/protected-access.rst + warning/raise-missing-from.rst + warning/raising-format-tuple.rst + warning/redeclared-assigned-name.rst + warning/redefined-builtin.rst + warning/redefined-loop-name.rst + warning/redefined-outer-name.rst + warning/redefined-slots-in-subclass.rst + warning/redundant-returns-doc.rst + warning/redundant-u-string-prefix.rst + warning/redundant-unittest-assert.rst + warning/redundant-yields-doc.rst + warning/reimported.rst + warning/self-assigning-variable.rst + warning/self-cls-assignment.rst + warning/shallow-copy-environ.rst + warning/signature-differs.rst + warning/subclassed-final-class.rst + warning/subprocess-popen-preexec-fn.rst + warning/subprocess-run-check.rst + warning/super-init-not-called.rst + warning/super-without-brackets.rst + warning/too-many-try-statements.rst + warning/try-except-raise.rst + warning/unbalanced-tuple-unpacking.rst + warning/undefined-loop-variable.rst + warning/unnecessary-ellipsis.rst + warning/unnecessary-lambda.rst + warning/unnecessary-pass.rst + warning/unnecessary-semicolon.rst + warning/unreachable.rst + warning/unspecified-encoding.rst + warning/unused-argument.rst + warning/unused-format-string-argument.rst + warning/unused-format-string-key.rst + warning/unused-import.rst + warning/unused-private-member.rst + warning/unused-variable.rst + warning/unused-wildcard-import.rst + warning/useless-else-on-loop.rst + warning/useless-param-doc.rst + warning/useless-super-delegation.rst + warning/useless-type-doc.rst + warning/useless-with-lock.rst + warning/using-constant-test.rst + warning/using-f-string-in-unsupported-version.rst + warning/using-final-decorator-in-unsupported-version.rst + warning/while-used.rst + warning/wildcard-import.rst + warning/wrong-exception-operation.rst + +All renamed messages in the warning category: + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + warning/cache-max-size-none.rst + warning/implicit-str-concat-in-sequence.rst + warning/lru-cache-decorating-method.rst + warning/old-assignment-from-none.rst + warning/old-empty-docstring.rst + warning/old-missing-param-doc.rst + warning/old-missing-returns-doc.rst + warning/old-missing-type-doc.rst + warning/old-missing-yields-doc.rst + warning/old-non-iterator-returned-1.rst + warning/old-unidiomatic-typecheck.rst + warning/old-unpacking-non-sequence.rst + + +Convention +---------- + +All messages in the convention category: + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + convention/bad-classmethod-argument.rst + convention/bad-docstring-quotes.rst + convention/bad-file-encoding.rst + convention/bad-mcs-classmethod-argument.rst + convention/bad-mcs-method-argument.rst + convention/compare-to-empty-string.rst + convention/compare-to-zero.rst + convention/consider-iterating-dictionary.rst + convention/consider-using-any-or-all.rst + convention/consider-using-dict-items.rst + convention/consider-using-enumerate.rst + convention/consider-using-f-string.rst + convention/disallowed-name.rst + convention/docstring-first-line-empty.rst + convention/empty-docstring.rst + convention/import-outside-toplevel.rst + convention/import-private-name.rst + convention/invalid-characters-in-docstring.rst + convention/invalid-name.rst + convention/line-too-long.rst + convention/misplaced-comparison-constant.rst + convention/missing-class-docstring.rst + convention/missing-final-newline.rst + convention/missing-function-docstring.rst + convention/missing-module-docstring.rst + convention/mixed-line-endings.rst + convention/multiple-imports.rst + convention/multiple-statements.rst + convention/non-ascii-module-import.rst + convention/non-ascii-name.rst + convention/single-string-used-for-slots.rst + convention/singleton-comparison.rst + convention/superfluous-parens.rst + convention/too-many-lines.rst + convention/trailing-newlines.rst + convention/trailing-whitespace.rst + convention/typevar-double-variance.rst + convention/typevar-name-incorrect-variance.rst + convention/typevar-name-mismatch.rst + convention/unexpected-line-ending-format.rst + convention/ungrouped-imports.rst + convention/unidiomatic-typecheck.rst + convention/unnecessary-direct-lambda-call.rst + convention/unnecessary-dunder-call.rst + convention/unnecessary-lambda-assignment.rst + convention/unneeded-not.rst + convention/use-implicit-booleaness-not-comparison.rst + convention/use-implicit-booleaness-not-len.rst + convention/use-maxsplit-arg.rst + convention/use-sequence-for-iteration.rst + convention/useless-import-alias.rst + convention/wrong-import-order.rst + convention/wrong-import-position.rst + convention/wrong-spelling-in-comment.rst + convention/wrong-spelling-in-docstring.rst + +All renamed messages in the convention category: + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + convention/blacklisted-name.rst + convention/len-as-condition.rst + convention/missing-docstring.rst + convention/old-misplaced-comparison-constant.rst + convention/old-non-ascii-name.rst + + +Refactor +-------- + +All messages in the refactor category: + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + refactor/chained-comparison.rst + refactor/comparison-of-constants.rst + refactor/comparison-with-itself.rst + refactor/condition-evals-to-constant.rst + refactor/confusing-consecutive-elif.rst + refactor/consider-alternative-union-syntax.rst + refactor/consider-merging-isinstance.rst + refactor/consider-swap-variables.rst + refactor/consider-using-alias.rst + refactor/consider-using-assignment-expr.rst + refactor/consider-using-dict-comprehension.rst + refactor/consider-using-from-import.rst + refactor/consider-using-generator.rst + refactor/consider-using-get.rst + refactor/consider-using-in.rst + refactor/consider-using-join.rst + refactor/consider-using-max-builtin.rst + refactor/consider-using-min-builtin.rst + refactor/consider-using-namedtuple-or-dataclass.rst + refactor/consider-using-set-comprehension.rst + refactor/consider-using-sys-exit.rst + refactor/consider-using-ternary.rst + refactor/consider-using-tuple.rst + refactor/consider-using-with.rst + refactor/cyclic-import.rst + refactor/duplicate-code.rst + refactor/else-if-used.rst + refactor/empty-comment.rst + refactor/inconsistent-return-statements.rst + refactor/literal-comparison.rst + refactor/no-classmethod-decorator.rst + refactor/no-else-break.rst + refactor/no-else-continue.rst + refactor/no-else-raise.rst + refactor/no-else-return.rst + refactor/no-self-use.rst + refactor/no-staticmethod-decorator.rst + refactor/property-with-parameters.rst + refactor/redefined-argument-from-local.rst + refactor/redefined-variable-type.rst + refactor/simplifiable-condition.rst + refactor/simplifiable-if-expression.rst + refactor/simplifiable-if-statement.rst + refactor/simplify-boolean-expression.rst + refactor/stop-iteration-return.rst + refactor/super-with-arguments.rst + refactor/too-complex.rst + refactor/too-few-public-methods.rst + refactor/too-many-ancestors.rst + refactor/too-many-arguments.rst + refactor/too-many-boolean-expressions.rst + refactor/too-many-branches.rst + refactor/too-many-instance-attributes.rst + refactor/too-many-locals.rst + refactor/too-many-nested-blocks.rst + refactor/too-many-public-methods.rst + refactor/too-many-return-statements.rst + refactor/too-many-statements.rst + refactor/trailing-comma-tuple.rst + refactor/unnecessary-comprehension.rst + refactor/unnecessary-dict-index-lookup.rst + refactor/unnecessary-list-index-lookup.rst + refactor/use-a-generator.rst + refactor/use-dict-literal.rst + refactor/use-list-literal.rst + refactor/use-set-for-membership.rst + refactor/useless-object-inheritance.rst + refactor/useless-return.rst + +All renamed messages in the refactor category: + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + refactor/old-no-self-use.rst + refactor/old-simplifiable-if-statement.rst + refactor/old-too-many-nested-blocks.rst + + +Information +----------- + +All messages in the information category: + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + information/bad-inline-option.rst + information/c-extension-no-member.rst + information/deprecated-pragma.rst + information/file-ignored.rst + information/locally-disabled.rst + information/raw-checker-failed.rst + information/suppressed-message.rst + information/use-symbolic-message-instead.rst + information/useless-suppression.rst + +All renamed messages in the information category: + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + information/deprecated-disable-all.rst |