summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Kolbus <peter.kolbus@gmail.com>2019-07-09 01:48:06 -0500
committerClaudiu Popa <pcmanticore@gmail.com>2019-07-09 09:48:06 +0300
commitaf45f55d862d530e947e685a3812812fd4c61435 (patch)
tree9d89a7cd8ba9e39647e01bbb8ddc0037fa394f61
parente6cd6e35bae7d19d1264c398dafe21c758fe4747 (diff)
downloadpylint-git-af45f55d862d530e947e685a3812812fd4c61435.tar.gz
Improve help for options (#2986)
-rw-r--r--CONTRIBUTORS.txt2
-rw-r--r--ChangeLog2
-rw-r--r--examples/pylintrc474
-rw-r--r--man/pylint.1336
-rw-r--r--pylint/checkers/spelling.py12
-rw-r--r--pylint/lint.py14
6 files changed, 443 insertions, 397 deletions
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
index 383c958d4..715807932 100644
--- a/CONTRIBUTORS.txt
+++ b/CONTRIBUTORS.txt
@@ -306,6 +306,8 @@ contributors:
* Nicholas Smith: contributor
+* Peter Kolbus (Garmin): contributor
+
* Oisin Moran: contributor
* Andrzej Klajnert: contributor
diff --git a/ChangeLog b/ChangeLog
index 5bd3458c9..3fbf12fff 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -301,6 +301,8 @@ Release date: 2019-02-27
* Fix false positive ``useless-else-on-loop`` if the break is deep in the else
of an inner loop.
+* Minor improvements to the help text for a few options.
+
What's New in Pylint 2.2.2?
===========================
diff --git a/examples/pylintrc b/examples/pylintrc
index 2e35e3b89..1277bd21b 100644
--- a/examples/pylintrc
+++ b/examples/pylintrc
@@ -2,7 +2,7 @@
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code
+# run arbitrary code.
extension-pkg-whitelist=
# Add files or directories to the blacklist. They should be base names, not
@@ -21,7 +21,12 @@ ignore-patterns=
# number of processors available to use.
jobs=1
-# List of plugins (as comma separated values of python modules names) to load,
+# Control the amount of potential inferred values when inferring a single
+# object. This can help the performance when dealing with large functions or
+# complex, nested conditions.
+limit-inference-results=100
+
+# List of plugins (as comma separated values of python module names) to load,
# usually to register additional checkers.
load-plugins=
@@ -32,7 +37,7 @@ persistent=yes
#rcfile=
# When enabled, pylint would attempt to guess common misconfiguration and emit
-# user-friendly hints instead of false-positive error messages
+# user-friendly hints instead of false-positive error messages.
suggestion-mode=yes
# Allow loading of arbitrary C extensions. Extensions are imported into the
@@ -43,18 +48,18 @@ unsafe-load-any-extension=no
[MESSAGES CONTROL]
# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
confidence=
# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifiers separated by comma (,) or put this
# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once).You can also use "--disable=all" to
+# file where it should appear only once). You can also use "--disable=all" to
# disable everything first and then reenable specific checks. For example, if
# you want to run only the similarities checker, you can use "--disable=all
# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use"--disable=all --enable=classes
-# --disable=W"
+# no Warning level messages displayed, use "--disable=all --enable=classes
+# --disable=W".
disable=print-statement,
parameter-unpacking,
unpacking-in-except,
@@ -144,15 +149,15 @@ enable=c-extension-no-member
[REPORTS]
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (RP0004).
+# Python expression which should return a score less than or equal to 10. You
+# have access to the variables 'error', 'warning', 'refactor', and 'convention'
+# which contain the number of messages in each category, as well as 'statement'
+# which is the total number of statements analyzed. This score is used by the
+# global evaluation report (RP0004).
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details
+# used to format the message information. See doc for all details.
#msg-template=
# Set the output format. Available formats are text, parseable, colorized, json
@@ -160,7 +165,7 @@ evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / stateme
# mypackage.mymodule.MyReporterClass.
output-format=text
-# Tells whether to display a full report or only the messages
+# Tells whether to display a full report or only the messages.
reports=no
# Activate the evaluation score.
@@ -179,23 +184,191 @@ max-nested-blocks=5
never-returning-functions=sys.exit
+[TYPECHECK]
+
+# List of decorators that produce context managers, such as
+# contextlib.contextmanager. Add to this list to register other decorators that
+# produce valid context managers.
+contextmanager-decorators=contextlib.contextmanager
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# Tells whether to warn about missing members when the owner of the attribute
+# is inferred to be None.
+ignore-none=yes
+
+# This flag controls whether pylint should warn about no-member and similar
+# checks whenever an opaque object is returned when inferring. The inference
+# can return multiple potential results while evaluating a Python object, but
+# some branches might not be evaluated, which results in partial inference. In
+# that case, it might be useful to still emit no-member and other checks for
+# the rest of the inferred objects.
+ignore-on-opaque-inference=yes
+
+# List of class names for which member attributes should not be checked (useful
+# for classes with dynamically set attributes). This supports the use of
+# qualified names.
+ignored-classes=optparse.Values,thread._local,_thread._local
+
+# List of module names for which member attributes should not be checked
+# (useful for modules/projects where namespaces are manipulated during runtime
+# and thus existing member attributes cannot be deduced by static analysis). It
+# supports qualified module names, as well as Unix pattern matching.
+ignored-modules=
+
+# Show a hint with possible names when a member name was not found. The aspect
+# of finding the hint is based on edit distance.
+missing-member-hint=yes
+
+# The minimum edit distance a name should have in order to be considered a
+# similar match for a missing member name.
+missing-member-hint-distance=1
+
+# The total number of similar names that should be taken in consideration when
+# showing a hint for a missing member.
+missing-member-max-choices=1
+
+# List of decorators that change the signature of a decorated function.
+signature-mutators=
+
+
+[LOGGING]
+
+# Format style used to check logging format string. `old` means using %
+# formatting, while `new` is for `{}` formatting.
+logging-format-style=old
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format.
+logging-modules=logging
+
+
+[SIMILARITIES]
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+
+[VARIABLES]
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid defining new builtins when possible.
+additional-builtins=
+
+# Tells whether unused global variables should be treated as a violation.
+allow-global-unused-variables=yes
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=cb_,
+ _cb
+
+# A regular expression matching the name of dummy variables (i.e. expected to
+# not be used).
+dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore.
+ignored-argument-names=_.*|^ignored_|^unused_
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
+
+
+[SPELLING]
+
+# Limits count of emitted suggestions for spelling mistakes.
+max-spelling-suggestions=4
+
+# Spelling dictionary name. Available dictionaries: none. To make it work,
+# install the python-enchant package.
+spelling-dict=
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains the private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to the private dictionary (see the
+# --spelling-private-dict-file option) instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[FORMAT]
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=^\s*(# )?<?https?://\S+>?$
+
+# Number of spaces of indent required inside a hanging or continued line.
+indent-after-paren=4
+
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
+# tab).
+indent-string=' '
+
+# Maximum number of characters on a single line.
+max-line-length=100
+
+# Maximum number of lines in a module.
+max-module-lines=1000
+
+# List of optional constructs for which whitespace checking is disabled. `dict-
+# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
+# `trailing-comma` allows a space between comma and closing bracket: (a, ).
+# `empty-line` allows space-only lines.
+no-space-check=trailing-comma,
+ dict-separator
+
+# Allow the body of a class to be on the same line as the declaration if body
+# contains single statement.
+single-line-class-stmt=no
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=no
+
+
[BASIC]
-# Naming style matching correct argument names
+# Naming style matching correct argument names.
argument-naming-style=snake_case
# Regular expression matching correct argument names. Overrides argument-
-# naming-style
+# naming-style.
#argument-rgx=
-# Naming style matching correct attribute names
+# Naming style matching correct attribute names.
attr-naming-style=snake_case
# Regular expression matching correct attribute names. Overrides attr-naming-
-# style
+# style.
#attr-rgx=
-# Bad variable names which should always be refused, separated by a comma
+# Bad variable names which should always be refused, separated by a comma.
bad-names=foo,
bar,
baz,
@@ -203,38 +376,39 @@ bad-names=foo,
tutu,
tata
-# Naming style matching correct class attribute names
+# Naming style matching correct class attribute names.
class-attribute-naming-style=any
# Regular expression matching correct class attribute names. Overrides class-
-# attribute-naming-style
+# attribute-naming-style.
#class-attribute-rgx=
-# Naming style matching correct class names
+# Naming style matching correct class names.
class-naming-style=PascalCase
-# Regular expression matching correct class names. Overrides class-naming-style
+# Regular expression matching correct class names. Overrides class-naming-
+# style.
#class-rgx=
-# Naming style matching correct constant names
+# Naming style matching correct constant names.
const-naming-style=UPPER_CASE
# Regular expression matching correct constant names. Overrides const-naming-
-# style
+# style.
#const-rgx=
# Minimum line length for functions/classes that require docstrings, shorter
# ones are exempt.
docstring-min-length=-1
-# Naming style matching correct function names
+# Naming style matching correct function names.
function-naming-style=snake_case
# Regular expression matching correct function names. Overrides function-
-# naming-style
+# naming-style.
#function-rgx=
-# Good variable names which should always be accepted, separated by a comma
+# Good variable names which should always be accepted, separated by a comma.
good-names=i,
j,
k,
@@ -242,28 +416,28 @@ good-names=i,
Run,
_
-# Include a hint for the correct naming format with invalid-name
+# Include a hint for the correct naming format with invalid-name.
include-naming-hint=no
-# Naming style matching correct inline iteration names
+# Naming style matching correct inline iteration names.
inlinevar-naming-style=any
# Regular expression matching correct inline iteration names. Overrides
-# inlinevar-naming-style
+# inlinevar-naming-style.
#inlinevar-rgx=
-# Naming style matching correct method names
+# Naming style matching correct method names.
method-naming-style=snake_case
# Regular expression matching correct method names. Overrides method-naming-
-# style
+# style.
#method-rgx=
-# Naming style matching correct module names
+# Naming style matching correct module names.
module-naming-style=snake_case
# Regular expression matching correct module names. Overrides module-naming-
-# style
+# style.
#module-rgx=
# Colon-delimited sets of names that determine each other's naming style when
@@ -276,60 +450,17 @@ no-docstring-rgx=^_
# List of decorators that produce properties, such as abc.abstractproperty. Add
# to this list to register other decorators that produce valid properties.
+# These decorators are taken in consideration only for invalid-name.
property-classes=abc.abstractproperty
-# Naming style matching correct variable names
+# Naming style matching correct variable names.
variable-naming-style=snake_case
# Regular expression matching correct variable names. Overrides variable-
-# naming-style
+# naming-style.
#variable-rgx=
-[FORMAT]
-
-# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
-expected-line-ending-format=
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-
-# Number of spaces of indent required inside a hanging or continued line.
-indent-after-paren=4
-
-# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
-# tab).
-indent-string=' '
-
-# Maximum number of characters on a single line.
-max-line-length=100
-
-# Maximum number of lines in a module
-max-module-lines=1000
-
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,
- dict-separator
-
-# Allow the body of a class to be on the same line as the declaration if body
-# contains single statement.
-single-line-class-stmt=no
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-
-[LOGGING]
-
-# Logging modules to check that the string format arguments are in logging
-# function parameter format
-logging-modules=logging
-
-
[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma.
@@ -338,121 +469,48 @@ notes=FIXME,
TODO
-[SIMILARITIES]
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-# Ignore imports when computing similarities.
-ignore-imports=no
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-
-[SPELLING]
-
-# Limits count of emitted suggestions for spelling mistakes
-max-spelling-suggestions=4
-
-# Spelling dictionary name. Available dictionaries: none. To make it working
-# install python-enchant package.
-spelling-dict=
-
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
-
-# A path to a file that contains private dictionary; one word per line.
-spelling-private-dict-file=
-
-# Tells whether to store unknown words to indicated private dictionary in
-# --spelling-private-dict-file option instead of raising a message.
-spelling-store-unknown-words=no
-
-
-[TYPECHECK]
-
-# List of decorators that produce context managers, such as
-# contextlib.contextmanager. Add to this list to register other decorators that
-# produce valid context managers.
-contextmanager-decorators=contextlib.contextmanager
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
-# expressions are accepted.
-generated-members=
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# Tells whether to warn about missing members when the owner of the attribute
-# is inferred to be None
-ignore-none=yes
-
-# This flag controls whether pylint should warn about no-member and similar
-# checks whenever an opaque object is returned when inferring. The inference
-# can return multiple potential results while evaluating a Python object, but
-# some branches might not be evaluated, which results in partial inference. In
-# that case, it might be useful to still emit no-member and other checks for
-# the rest of the inferred objects.
-ignore-on-opaque-inference=yes
-
-# List of class names for which member attributes should not be checked (useful
-# for classes with dynamically set attributes). This supports the use of
-# qualified names.
-ignored-classes=optparse.Values,thread._local,_thread._local
-
-# List of module names for which member attributes should not be checked
-# (useful for modules/projects where namespaces are manipulated during runtime
-# and thus existing member attributes cannot be deduced by static analysis. It
-# supports qualified module names, as well as Unix pattern matching.
-ignored-modules=
+[STRING]
-# Show a hint with possible names when a member name was not found. The aspect
-# of finding the hint is based on edit distance.
-missing-member-hint=yes
+# This flag controls whether the implicit-str-concat-in-sequence should
+# generate a warning on implicit string concatenation in sequences defined over
+# several lines.
+check-str-concat-over-line-jumps=no
-# The minimum edit distance a name should have in order to be considered a
-# similar match for a missing member name.
-missing-member-hint-distance=1
-# The total number of similar names that should be taken in consideration when
-# showing a hint for a missing member.
-missing-member-max-choices=1
+[IMPORTS]
+# Allow wildcard imports from modules that define __all__.
+allow-wildcard-with-all=no
-[VARIABLES]
+# Analyse import fallback blocks. This can be used to support both Python 2 and
+# 3 compatible code, which means that the block might have code that exists
+# only in one or another interpreter, leading to false positives when analysed.
+analyse-fallback-blocks=no
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid defining new builtins when possible.
-additional-builtins=
+# Deprecated modules which should not be used, separated by a comma.
+deprecated-modules=optparse,tkinter.tix
-# Tells whether unused global variables should be treated as a violation.
-allow-global-unused-variables=yes
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled).
+ext-import-graph=
-# List of strings which can identify a callback function by name. A callback
-# name must start or end with one of those strings.
-callbacks=cb_,
- _cb
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled).
+import-graph=
-# A regular expression matching the name of dummy variables (i.e. expectedly
-# not used).
-dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled).
+int-import-graph=
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*|^ignored_|^unused_
+# Force import order to recognize a module as part of the standard
+# compatibility libraries.
+known-standard-library=
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
+# Force import order to recognize a module as part of a third party library.
+known-third-party=enchant
-# List of qualified module names which can have objects that can redefine
-# builtins.
-redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
+# Couples of modules and preferred modules, separated by a comma.
+preferred-modules=
[CLASSES]
@@ -480,7 +538,7 @@ valid-metaclass-classmethod-first-arg=cls
[DESIGN]
-# Maximum number of arguments for function / method
+# Maximum number of arguments for function / method.
max-args=5
# Maximum number of attributes for a class (see R0902).
@@ -489,10 +547,10 @@ max-attributes=7
# Maximum number of boolean expressions in an if statement (see R0916).
max-bool-expr=5
-# Maximum number of branch for function / method body
+# Maximum number of branch for function / method body.
max-branches=12
-# Maximum number of locals for function / method body
+# Maximum number of locals for function / method body.
max-locals=15
# Maximum number of parents for a class (see R0901).
@@ -501,51 +559,19 @@ max-parents=7
# Maximum number of public methods for a class (see R0904).
max-public-methods=20
-# Maximum number of return / yield for function / method body
+# Maximum number of return / yield for function / method body.
max-returns=6
-# Maximum number of statements in function / method body
+# Maximum number of statements in function / method body.
max-statements=50
# Minimum number of public methods for a class (see R0903).
min-public-methods=2
-[IMPORTS]
-
-# Allow wildcard imports from modules that define __all__.
-allow-wildcard-with-all=no
-
-# Analyse import fallback blocks. This can be used to support both Python 2 and
-# 3 compatible code, which means that the block might have code that exists
-# only in one or another interpreter, leading to false positives when analysed.
-analyse-fallback-blocks=no
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=optparse,tkinter.tix
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-# Force import order to recognize a module as part of the standard
-# compatibility libraries.
-known-standard-library=
-
-# Force import order to recognize a module as part of a third party library.
-known-third-party=enchant
-
-
[EXCEPTIONS]
# Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=Exception
+# "BaseException, Exception".
+overgeneral-exceptions=BaseException,
+ Exception
diff --git a/man/pylint.1 b/man/pylint.1
index 2514171a1..40b7c1cbc 100644
--- a/man/pylint.1
+++ b/man/pylint.1
@@ -1,4 +1,4 @@
-.TH pylint 1 "2018-06-13" pylint
+.TH pylint 1 "2019-06-29" pylint
.SH NAME
.B pylint
\- python code static checker
@@ -43,11 +43,11 @@ Specify a configuration file.
.IP "--init-hook=<code>"
Python code to execute, usually for sys.path manipulation such as pygtk.require().
.IP "--errors-only, -E"
-In error mode, checkers without error messages are disabled and for others, only the ERROR messages are displayed, and no reports are done by default
+In error mode, checkers without error messages are disabled and for others, only the ERROR messages are displayed, and no reports are done by default.
.IP "--py3k"
-In Python 3 porting mode, all checkers will be disabled and only messages emitted by the porting checker will be displayed
+In Python 3 porting mode, all checkers will be disabled and only messages emitted by the porting checker will be displayed.
.IP "--verbose, -v"
-In verbose mode, extra non-checker-related info will be displayed
+In verbose mode, extra non-checker-related info will be displayed.
.IP "--ignore=<file>[,<file>...]"
Add files or directories to the blacklist. They should be base names, not paths. [default: CVS]
.IP "--ignore-patterns=<pattern>[,<pattern>...]"
@@ -55,21 +55,27 @@ Add files or directories matching the regex patterns to the blacklist. The regex
.IP "--persistent=<y_or_n>"
Pickle collected data for later comparisons. [default: yes]
.IP "--load-plugins=<modules>"
-List of plugins (as comma separated values of python modules names) to load, usually to register additional checkers. [default: none]
+List of plugins (as comma separated values of python module names) to load, usually to register additional checkers. [default: none]
.IP "--jobs=<n-processes>, -j <n-processes>"
Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the number of processors available to use. [default: 1]
+.IP "--limit-inference-results=<number-of-results>"
+Control the amount of potential inferred values when inferring a single object. This can help the performance when dealing with large functions or complex, nested conditions. [default: 100]
.IP "--extension-pkg-whitelist=<pkg[,pkg]>"
-A comma-separated list of package or module names from where C extensions may be loaded. Extensions are loading into the active Python interpreter and may run arbitrary code [default: none]
+A comma-separated list of package or module names from where C extensions may be loaded. Extensions are loading into the active Python interpreter and may run arbitrary code. [default: none]
.IP "--suggestion-mode=<yn>"
-When enabled, pylint would attempt to guess common misconfiguration and emit user-friendly hints instead of false-positive error messages [default: yes]
+When enabled, pylint would attempt to guess common misconfiguration and emit user-friendly hints instead of false-positive error messages. [default: yes]
.IP "--exit-zero"
Always return a 0 (non-error) status code, even if lint errors are found. This is primarily useful in continuous integration scripts.
+.IP "--from-stdin"
+Interpret the stdin as a python script, whose filename needs to be passed as the module_or_package argument.
.SH COMMANDS
.IP "--help-msg=<msg-id>"
Display a help message for the given message id and exit. The value may be a comma separated list of message ids.
.IP "--list-msgs"
Generate pylint's messages.
+.IP "--list-groups"
+List pylint's message groups.
.IP "--list-conf-levels"
Generate pylint's confidence levels.
.IP "--full-documentation"
@@ -79,101 +85,217 @@ Generate a sample configuration file according to the current configuration. You
.SH MESSAGES CONTROL
.IP "--confidence=<levels>"
-Only show warnings with the listed confidence levels. Leave empty to show all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED [default: none]
+Only show warnings with the listed confidence levels. Leave empty to show all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. [default: none]
.IP "--enable=<msg ids>, -e <msg ids>"
Enable the message, report, category or checker with the given id(s). You can either give multiple identifier separated by comma (,) or put this option multiple time (only on the command line, not in the configuration file where it should appear only once). See also the "--disable" option for examples.
.IP "--disable=<msg ids>, -d <msg ids>"
-Disable the message, report, category or checker with the given id(s). You can either give multiple identifiers separated by comma (,) or put this option multiple times (only on the command line, not in the configuration file where it should appear only once).You can also use "--disable=all" to disable everything first and then reenable specific checks. For example, if you want to run only the similarities checker, you can use "--disable=all --enable=similarities". If you want to run only the classes checker, but have no Warning level messages displayed, use"--disable=all --enable=classes --disable=W"
+Disable the message, report, category or checker with the given id(s). You can either give multiple identifiers separated by comma (,) or put this option multiple times (only on the command line, not in the configuration file where it should appear only once). You can also use "--disable=all" to disable everything first and then reenable specific checks. For example, if you want to run only the similarities checker, you can use "--disable=all --enable=similarities". If you want to run only the classes checker, but have no Warning level messages displayed, use "--disable=all --enable=classes --disable=W".
.SH REPORTS
.IP "--output-format=<format>, -f <format>"
Set the output format. Available formats are text, parseable, colorized, json and msvs (visual studio). You can also give a reporter class, e.g. mypackage.mymodule.MyReporterClass. [default: text]
.IP "--reports=<y_or_n>, -r <y_or_n>"
-Tells whether to display a full report or only the messages [default: no]
+Tells whether to display a full report or only the messages. [default: no]
.IP "--evaluation=<python_expression>"
-Python expression which should return a note less than 10 (10 is the highest note). You have access to the variables errors warning, statement which respectively contain the number of errors / warnings messages and the total number of statements analyzed. This is used by the global evaluation report (RP0004). [default: 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)]
+Python expression which should return a score less than or equal to 10. You have access to the variables 'error', 'warning', 'refactor', and 'convention' which contain the number of messages in each category, as well as 'statement' which is the total number of statements analyzed. This score is used by the global evaluation report (RP0004). [default: 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)]
.IP "--score=<y_or_n>, -s <y_or_n>"
Activate the evaluation score. [default: yes]
.IP "--msg-template=<template>"
-Template used to display messages. This is a python new-style format string used to format the message information. See doc for all details
+Template used to display messages. This is a python new-style format string used to format the message information. See doc for all details.
+
+.SH TYPECHECK
+.IP "--ignore-on-opaque-inference=<y_or_n>"
+This flag controls whether pylint should warn about no-member and similar checks whenever an opaque object is returned when inferring. The inference can return multiple potential results while evaluating a Python object, but some branches might not be evaluated, which results in partial inference. In that case, it might be useful to still emit no-member and other checks for the rest of the inferred objects. [default: yes]
+.IP "--ignore-mixin-members=<y_or_n>"
+Tells whether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive). [default: yes]
+.IP "--ignore-none=<y_or_n>"
+Tells whether to warn about missing members when the owner of the attribute is inferred to be None. [default: yes]
+.IP "--ignored-modules=<module names>"
+List of module names for which member attributes should not be checked (useful for modules/projects where namespaces are manipulated during runtime and thus existing member attributes cannot be deduced by static analysis). It supports qualified module names, as well as Unix pattern matching. [default: none]
+.IP "--ignored-classes=<members names>"
+List of class names for which member attributes should not be checked (useful for classes with dynamically set attributes). This supports the use of qualified names. [default: optparse.Values,thread._local,_thread._local]
+.IP "--generated-members=<members names>"
+List of members which are set dynamically and missed by pylint inference system, and so shouldn't trigger E1101 when accessed. Python regular expressions are accepted. [default: none]
+.IP "--contextmanager-decorators=<decorator names>"
+List of decorators that produce context managers, such as contextlib.contextmanager. Add to this list to register other decorators that produce valid context managers. [default: contextlib.contextmanager]
+.IP "--missing-member-hint-distance=<member hint edit distance>"
+The minimum edit distance a name should have in order to be considered a similar match for a missing member name. [default: 1]
+.IP "--missing-member-max-choices=<member hint max choices>"
+The total number of similar names that should be taken in consideration when showing a hint for a missing member. [default: 1]
+.IP "--missing-member-hint=<missing member hint>"
+Show a hint with possible names when a member name was not found. The aspect of finding the hint is based on edit distance. [default: yes]
+.IP "--signature-mutators=<decorator names>"
+List of decorators that change the signature of a decorated function. [default: none]
+
+.SH LOGGING
+.IP "--logging-modules=<comma separated list>"
+Logging modules to check that the string format arguments are in logging function parameter format. [default: logging]
+.IP "--logging-format-style=<old (%) or new ({)>"
+Format style used to check logging format string. `old` means using % formatting, while `new` is for `{}` formatting. [default: old]
+
+.SH EXCEPTIONS
+.IP "--overgeneral-exceptions=<comma-separated class names>"
+Exceptions that will emit a warning when being caught. Defaults to "BaseException, Exception". [default: BaseException,Exception]
+
+.SH SIMILARITIES
+.IP "--min-similarity-lines=<int>"
+Minimum lines number of a similarity. [default: 4]
+.IP "--ignore-comments=<y or n>"
+Ignore comments when computing similarities. [default: yes]
+.IP "--ignore-docstrings=<y or n>"
+Ignore docstrings when computing similarities. [default: yes]
+.IP "--ignore-imports=<y or n>"
+Ignore imports when computing similarities. [default: no]
+
+.SH IMPORTS
+.IP "--deprecated-modules=<modules>"
+Deprecated modules which should not be used, separated by a comma. [default: optparse,tkinter.tix]
+.IP "--preferred-modules=<module:preferred-module>"
+Couples of modules and preferred modules, separated by a comma. [default: none]
+.IP "--import-graph=<file.dot>"
+Create a graph of every (i.e. internal and external) dependencies in the given file (report RP0402 must not be disabled). [default: none]
+.IP "--ext-import-graph=<file.dot>"
+Create a graph of external dependencies in the given file (report RP0402 must not be disabled). [default: none]
+.IP "--int-import-graph=<file.dot>"
+Create a graph of internal dependencies in the given file (report RP0402 must not be disabled). [default: none]
+.IP "--known-standard-library=<modules>"
+Force import order to recognize a module as part of the standard compatibility libraries. [default: none]
+.IP "--known-third-party=<modules>"
+Force import order to recognize a module as part of a third party library. [default: enchant]
+.IP "--analyse-fallback-blocks=<y_or_n>"
+Analyse import fallback blocks. This can be used to support both Python 2 and 3 compatible code, which means that the block might have code that exists only in one or another interpreter, leading to false positives when analysed. [default: no]
+.IP "--allow-wildcard-with-all=<y_or_n>"
+Allow wildcard imports from modules that define __all__. [default: no]
+
+.SH VARIABLES
+.IP "--init-import=<y_or_n>"
+Tells whether we should check for unused import in __init__ files. [default: no]
+.IP "--dummy-variables-rgx=<regexp>"
+A regular expression matching the name of dummy variables (i.e. expected to not be used). [default: _+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_]
+.IP "--additional-builtins=<comma separated list>"
+List of additional names supposed to be defined in builtins. Remember that you should avoid defining new builtins when possible. [default: none]
+.IP "--callbacks=<callbacks>"
+List of strings which can identify a callback function by name. A callback name must start or end with one of those strings. [default: cb_,_cb]
+.IP "--redefining-builtins-modules=<comma separated list>"
+List of qualified module names which can have objects that can redefine builtins. [default: six.moves,past.builtins,future.builtins,builtins,io]
+.IP "--ignored-argument-names=<regexp>"
+Argument names that match this expression will be ignored. Default to name with leading underscore. [default: _.*|^ignored_|^unused_]
+.IP "--allow-global-unused-variables=<y_or_n>"
+Tells whether unused global variables should be treated as a violation. [default: yes]
+
+.SH CLASSES
+.IP "--defining-attr-methods=<method names>"
+List of method names used to declare (i.e. assign) instance attributes. [default: __init__,__new__,setUp]
+.IP "--valid-classmethod-first-arg=<argument names>"
+List of valid names for the first argument in a class method. [default: cls]
+.IP "--valid-metaclass-classmethod-first-arg=<argument names>"
+List of valid names for the first argument in a metaclass class method. [default: cls]
+.IP "--exclude-protected=<protected access exclusions>"
+List of member names, which should be excluded from the protected access warning. [default: _asdict,_fields,_replace,_source,_make]
+
+.SH SPELLING
+.IP "--spelling-dict=<dict name>"
+Spelling dictionary name. Available dictionaries: none. To make it work, install the python-enchant package. [default: none]
+.IP "--spelling-ignore-words=<comma separated words>"
+List of comma separated words that should not be checked. [default: none]
+.IP "--spelling-private-dict-file=<path to file>"
+A path to a file that contains the private dictionary; one word per line. [default: none]
+.IP "--spelling-store-unknown-words=<y_or_n>"
+Tells whether to store unknown words to the private dictionary (see the --spelling-private-dict-file option) instead of raising a message. [default: no]
+.IP "--max-spelling-suggestions=N"
+Limits count of emitted suggestions for spelling mistakes. [default: 4]
+
+.SH FORMAT
+.IP "--max-line-length=<int>"
+Maximum number of characters on a single line. [default: 100]
+.IP "--ignore-long-lines=<regexp>"
+Regexp for a line that is allowed to be longer than the limit. [default: ^\\s*(# )?<?https?://\\S+>?$]
+.IP "--single-line-if-stmt=<y_or_n>"
+Allow the body of an if to be on the same line as the test if there is no else. [default: no]
+.IP "--single-line-class-stmt=<y_or_n>"
+Allow the body of a class to be on the same line as the declaration if body contains single statement. [default: no]
+.IP "--no-space-check=trailing-comma,dict-separator,empty-line"
+List of optional constructs for which whitespace checking is disabled. `dict-separator` is used to allow tabulation in dicts, etc.: {1 : 1,\\n222: 2}. `trailing-comma` allows a space between comma and closing bracket: (a, ). `empty-line` allows space-only lines. [default: trailing-comma,dict-separator]
+.IP "--max-module-lines=<int>"
+Maximum number of lines in a module. [default: 1000]
+.IP "--indent-string=<string>"
+String used as indentation unit. This is usually " " (4 spaces) or "\\t" (1 tab). [default: ' ']
+.IP "--indent-after-paren=<int>"
+Number of spaces of indent required inside a hanging or continued line. [default: 4]
+.IP "--expected-line-ending-format=<empty or LF or CRLF>"
+Expected format of line ending, e.g. empty (any line ending), LF or CRLF. [default: none]
.SH BASIC
.IP "--good-names=<names>"
-Good variable names which should always be accepted, separated by a comma [default: i,j,k,ex,Run,_]
+Good variable names which should always be accepted, separated by a comma. [default: i,j,k,ex,Run,_]
.IP "--bad-names=<names>"
-Bad variable names which should always be refused, separated by a comma [default: foo,bar,baz,toto,tutu,tata]
+Bad variable names which should always be refused, separated by a comma. [default: foo,bar,baz,toto,tutu,tata]
.IP "--name-group=<name1:name2>"
Colon-delimited sets of names that determine each other's naming style when the name regexes allow several styles. [default: none]
.IP "--include-naming-hint=<y_or_n>"
-Include a hint for the correct naming format with invalid-name [default: no]
+Include a hint for the correct naming format with invalid-name. [default: no]
.IP "--property-classes=<decorator names>"
-List of decorators that produce properties, such as abc.abstractproperty. Add to this list to register other decorators that produce valid properties. [default: abc.abstractproperty]
+List of decorators that produce properties, such as abc.abstractproperty. Add to this list to register other decorators that produce valid properties. These decorators are taken in consideration only for invalid-name. [default: abc.abstractproperty]
.IP "--argument-naming-style=<style>"
-Naming style matching correct argument names [default: snake_case]
+Naming style matching correct argument names. [default: snake_case]
.IP "--argument-rgx=<regexp>"
-Regular expression matching correct argument names. Overrides argument-naming-style
+Regular expression matching correct argument names. Overrides argument-naming-style.
.IP "--attr-naming-style=<style>"
-Naming style matching correct attribute names [default: snake_case]
+Naming style matching correct attribute names. [default: snake_case]
.IP "--attr-rgx=<regexp>"
-Regular expression matching correct attribute names. Overrides attr-naming-style
+Regular expression matching correct attribute names. Overrides attr-naming-style.
.IP "--class-naming-style=<style>"
-Naming style matching correct class names [default: PascalCase]
+Naming style matching correct class names. [default: PascalCase]
.IP "--class-rgx=<regexp>"
-Regular expression matching correct class names. Overrides class-naming-style
+Regular expression matching correct class names. Overrides class-naming-style.
.IP "--class-attribute-naming-style=<style>"
-Naming style matching correct class attribute names [default: any]
+Naming style matching correct class attribute names. [default: any]
.IP "--class-attribute-rgx=<regexp>"
-Regular expression matching correct class attribute names. Overrides class-attribute-naming-style
+Regular expression matching correct class attribute names. Overrides class-attribute-naming-style.
.IP "--const-naming-style=<style>"
-Naming style matching correct constant names [default: UPPER_CASE]
+Naming style matching correct constant names. [default: UPPER_CASE]
.IP "--const-rgx=<regexp>"
-Regular expression matching correct constant names. Overrides const-naming-style
+Regular expression matching correct constant names. Overrides const-naming-style.
.IP "--function-naming-style=<style>"
-Naming style matching correct function names [default: snake_case]
+Naming style matching correct function names. [default: snake_case]
.IP "--function-rgx=<regexp>"
-Regular expression matching correct function names. Overrides function-naming-style
+Regular expression matching correct function names. Overrides function-naming-style.
.IP "--inlinevar-naming-style=<style>"
-Naming style matching correct inline iteration names [default: any]
+Naming style matching correct inline iteration names. [default: any]
.IP "--inlinevar-rgx=<regexp>"
-Regular expression matching correct inline iteration names. Overrides inlinevar-naming-style
+Regular expression matching correct inline iteration names. Overrides inlinevar-naming-style.
.IP "--method-naming-style=<style>"
-Naming style matching correct method names [default: snake_case]
+Naming style matching correct method names. [default: snake_case]
.IP "--method-rgx=<regexp>"
-Regular expression matching correct method names. Overrides method-naming-style
+Regular expression matching correct method names. Overrides method-naming-style.
.IP "--module-naming-style=<style>"
-Naming style matching correct module names [default: snake_case]
+Naming style matching correct module names. [default: snake_case]
.IP "--module-rgx=<regexp>"
-Regular expression matching correct module names. Overrides module-naming-style
+Regular expression matching correct module names. Overrides module-naming-style.
.IP "--variable-naming-style=<style>"
-Naming style matching correct variable names [default: snake_case]
+Naming style matching correct variable names. [default: snake_case]
.IP "--variable-rgx=<regexp>"
-Regular expression matching correct variable names. Overrides variable-naming-style
+Regular expression matching correct variable names. Overrides variable-naming-style.
.IP "--no-docstring-rgx=<regexp>"
Regular expression which should only match function or class names that do not require a docstring. [default: ^_]
.IP "--docstring-min-length=<int>"
Minimum line length for functions/classes that require docstrings, shorter ones are exempt. [default: -1]
-.SH CLASSES
-.IP "--defining-attr-methods=<method names>"
-List of method names used to declare (i.e. assign) instance attributes. [default: __init__,__new__,setUp]
-.IP "--valid-classmethod-first-arg=<argument names>"
-List of valid names for the first argument in a class method. [default: cls]
-.IP "--valid-metaclass-classmethod-first-arg=<argument names>"
-List of valid names for the first argument in a metaclass class method. [default: cls]
-.IP "--exclude-protected=<protected access exclusions>"
-List of member names, which should be excluded from the protected access warning. [default: _asdict,_fields,_replace,_source,_make]
+.SH MISCELLANEOUS
+.IP "--notes=<comma separated values>"
+List of note tags to take in consideration, separated by a comma. [default: FIXME,XXX,TODO]
.SH DESIGN
.IP "--max-args=<int>"
-Maximum number of arguments for function / method [default: 5]
+Maximum number of arguments for function / method. [default: 5]
.IP "--max-locals=<int>"
-Maximum number of locals for function / method body [default: 15]
+Maximum number of locals for function / method body. [default: 15]
.IP "--max-returns=<int>"
-Maximum number of return / yield for function / method body [default: 6]
+Maximum number of return / yield for function / method body. [default: 6]
.IP "--max-branches=<int>"
-Maximum number of branch for function / method body [default: 12]
+Maximum number of branch for function / method body. [default: 12]
.IP "--max-statements=<int>"
-Maximum number of statements in function / method body [default: 50]
+Maximum number of statements in function / method body. [default: 50]
.IP "--max-parents=<num>"
Maximum number of parents for a class (see R0901). [default: 7]
.IP "--max-attributes=<num>"
@@ -183,57 +305,7 @@ Minimum number of public methods for a class (see R0903). [default: 2]
.IP "--max-public-methods=<num>"
Maximum number of public methods for a class (see R0904). [default: 20]
.IP "--max-bool-expr=<num>"
-Maximum number of boolean expressions in an if statement [default: 5]
-
-.SH EXCEPTIONS
-.IP "--overgeneral-exceptions=<comma-separated class names>"
-Exceptions that will emit a warning when being caught. Defaults to "Exception" [default: Exception]
-
-.SH FORMAT
-.IP "--max-line-length=<int>"
-Maximum number of characters on a single line. [default: 100]
-.IP "--ignore-long-lines=<regexp>"
-Regexp for a line that is allowed to be longer than the limit. [default: ^\\s*(# )?<?https?://\\S+>?$]
-.IP "--single-line-if-stmt=<y_or_n>"
-Allow the body of an if to be on the same line as the test if there is no else. [default: no]
-.IP "--single-line-class-stmt=<y_or_n>"
-Allow the body of a class to be on the same line as the declaration if body contains single statement. [default: no]
-.IP "--no-space-check=trailing-comma,dict-separator,empty-line"
-List of optional constructs for which whitespace checking is disabled. `dict-separator` is used to allow tabulation in dicts, etc.: {1 : 1,\\n222: 2}. `trailing-comma` allows a space between comma and closing bracket: (a, ). `empty-line` allows space-only lines. [default: trailing-comma,dict-separator]
-.IP "--max-module-lines=<int>"
-Maximum number of lines in a module [default: 1000]
-.IP "--indent-string=<string>"
-String used as indentation unit. This is usually " " (4 spaces) or "\\t" (1 tab). [default: ' ']
-.IP "--indent-after-paren=<int>"
-Number of spaces of indent required inside a hanging or continued line. [default: 4]
-.IP "--expected-line-ending-format=<empty or LF or CRLF>"
-Expected format of line ending, e.g. empty (any line ending), LF or CRLF. [default: none]
-
-.SH IMPORTS
-.IP "--deprecated-modules=<modules>"
-Deprecated modules which should not be used, separated by a comma [default: optparse,tkinter.tix]
-.IP "--import-graph=<file.dot>"
-Create a graph of every (i.e. internal and external) dependencies in the given file (report RP0402 must not be disabled) [default: none]
-.IP "--ext-import-graph=<file.dot>"
-Create a graph of external dependencies in the given file (report RP0402 must not be disabled) [default: none]
-.IP "--int-import-graph=<file.dot>"
-Create a graph of internal dependencies in the given file (report RP0402 must not be disabled) [default: none]
-.IP "--known-standard-library=<modules>"
-Force import order to recognize a module as part of the standard compatibility libraries. [default: none]
-.IP "--known-third-party=<modules>"
-Force import order to recognize a module as part of a third party library. [default: enchant]
-.IP "--analyse-fallback-blocks=<y_or_n>"
-Analyse import fallback blocks. This can be used to support both Python 2 and 3 compatible code, which means that the block might have code that exists only in one or another interpreter, leading to false positives when analysed. [default: no]
-.IP "--allow-wildcard-with-all=<y_or_n>"
-Allow wildcard imports from modules that define __all__. [default: no]
-
-.SH LOGGING
-.IP "--logging-modules=<comma separated list>"
-Logging modules to check that the string format arguments are in logging function parameter format [default: logging]
-
-.SH MISCELLANEOUS
-.IP "--notes=<comma separated values>"
-List of note tags to take in consideration, separated by a comma. [default: FIXME,XXX,TODO]
+Maximum number of boolean expressions in an if statement (see R0916). [default: 5]
.SH REFACTORING
.IP "--max-nested-blocks=<int>"
@@ -241,65 +313,9 @@ Maximum number of nested blocks for function / method body [default: 5]
.IP "--never-returning-functions=NEVER_RETURNING_FUNCTIONS"
Complete name of functions that never returns. When checking for inconsistent-return-statements if a never returning function is called then it will be considered as an explicit return statement and no message will be printed. [default: sys.exit]
-.SH SIMILARITIES
-.IP "--min-similarity-lines=<int>"
-Minimum lines number of a similarity. [default: 4]
-.IP "--ignore-comments=<y or n>"
-Ignore comments when computing similarities. [default: yes]
-.IP "--ignore-docstrings=<y or n>"
-Ignore docstrings when computing similarities. [default: yes]
-.IP "--ignore-imports=<y or n>"
-Ignore imports when computing similarities. [default: no]
-
-.SH SPELLING
-.IP "--spelling-dict=<dict name>"
-Spelling dictionary name. Available dictionaries: none. To make it working install python-enchant package. [default: none]
-.IP "--spelling-ignore-words=<comma separated words>"
-List of comma separated words that should not be checked. [default: none]
-.IP "--spelling-private-dict-file=<path to file>"
-A path to a file that contains private dictionary; one word per line. [default: none]
-.IP "--spelling-store-unknown-words=<y_or_n>"
-Tells whether to store unknown words to indicated private dictionary in --spelling-private-dict-file option instead of raising a message. [default: no]
-.IP "--max-spelling-suggestions=N"
-Limits count of emitted suggestions for spelling mistakes [default: 4]
-
-.SH TYPECHECK
-.IP "--ignore-on-opaque-inference=<y_or_n>"
-This flag controls whether pylint should warn about no-member and similar checks whenever an opaque object is returned when inferring. The inference can return multiple potential results while evaluating a Python object, but some branches might not be evaluated, which results in partial inference. In that case, it might be useful to still emit no-member and other checks for the rest of the inferred objects. [default: yes]
-.IP "--ignore-mixin-members=<y_or_n>"
-Tells whether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive). [default: yes]
-.IP "--ignore-none=<y_or_n>"
-Tells whether to warn about missing members when the owner of the attribute is inferred to be None [default: yes]
-.IP "--ignored-modules=<module names>"
-List of module names for which member attributes should not be checked (useful for modules/projects where namespaces are manipulated during runtime and thus existing member attributes cannot be deduced by static analysis. It supports qualified module names, as well as Unix pattern matching. [default: none]
-.IP "--ignored-classes=<members names>"
-List of class names for which member attributes should not be checked (useful for classes with dynamically set attributes). This supports the use of qualified names. [default: optparse.Values,thread._local,_thread._local]
-.IP "--generated-members=<members names>"
-List of members which are set dynamically and missed by pylint inference system, and so shouldn't trigger E1101 when accessed. Python regular expressions are accepted. [default: none]
-.IP "--contextmanager-decorators=<decorator names>"
-List of decorators that produce context managers, such as contextlib.contextmanager. Add to this list to register other decorators that produce valid context managers. [default: contextlib.contextmanager]
-.IP "--missing-member-hint-distance=<member hint edit distance>"
-The minimum edit distance a name should have in order to be considered a similar match for a missing member name. [default: 1]
-.IP "--missing-member-max-choices=<member hint max choices>"
-The total number of similar names that should be taken in consideration when showing a hint for a missing member. [default: 1]
-.IP "--missing-member-hint=<missing member hint>"
-Show a hint with possible names when a member name was not found. The aspect of finding the hint is based on edit distance. [default: yes]
-
-.SH VARIABLES
-.IP "--init-import=<y_or_n>"
-Tells whether we should check for unused import in __init__ files. [default: no]
-.IP "--dummy-variables-rgx=<regexp>"
-A regular expression matching the name of dummy variables (i.e. expectedly not used). [default: _+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_]
-.IP "--additional-builtins=<comma separated list>"
-List of additional names supposed to be defined in builtins. Remember that you should avoid to define new builtins when possible. [default: none]
-.IP "--callbacks=<callbacks>"
-List of strings which can identify a callback function by name. A callback name must start or end with one of those strings. [default: cb_,_cb]
-.IP "--redefining-builtins-modules=<comma separated list>"
-List of qualified module names which can have objects that can redefine builtins. [default: six.moves,past.builtins,future.builtins,builtins,io]
-.IP "--ignored-argument-names=<regexp>"
-Argument names that match this expression will be ignored. Default to name with leading underscore [default: _.*|^ignored_|^unused_]
-.IP "--allow-global-unused-variables=<y_or_n>"
-Tells whether unused global variables should be treated as a violation. [default: yes]
+.SH STRING
+.IP "--check-str-concat-over-line-jumps=<y_or_n>"
+This flag controls whether the implicit-str-concat-in-sequence should generate a warning on implicit string concatenation in sequences defined over several lines. [default: no]
.SH ENVIRONMENT VARIABLES
diff --git a/pylint/checkers/spelling.py b/pylint/checkers/spelling.py
index 2674078b9..b1a533482 100644
--- a/pylint/checkers/spelling.py
+++ b/pylint/checkers/spelling.py
@@ -57,7 +57,7 @@ if enchant is not None:
else:
dicts = "none"
dict_choices = [""]
- instr = " To make it working install python-enchant package."
+ instr = " To make it work, install the python-enchant package."
class WordsWithDigigtsFilter(Filter):
@@ -184,7 +184,7 @@ class SpellingChecker(BaseTokenChecker):
"metavar": "<dict name>",
"choices": dict_choices,
"help": "Spelling dictionary name. "
- "Available dictionaries: %s.%s." % (dicts, instr),
+ "Available dictionaries: %s.%s" % (dicts, instr),
},
),
(
@@ -202,7 +202,7 @@ class SpellingChecker(BaseTokenChecker):
"default": "",
"type": "string",
"metavar": "<path to file>",
- "help": "A path to a file that contains private "
+ "help": "A path to a file that contains the private "
"dictionary; one word per line.",
},
),
@@ -212,9 +212,9 @@ class SpellingChecker(BaseTokenChecker):
"default": "n",
"type": "yn",
"metavar": "<y_or_n>",
- "help": "Tells whether to store unknown words to "
- "indicated private dictionary in "
- "--spelling-private-dict-file option instead of "
+ "help": "Tells whether to store unknown words to the "
+ "private dictionary (see the "
+ "--spelling-private-dict-file option) instead of "
"raising a message.",
},
),
diff --git a/pylint/lint.py b/pylint/lint.py
index a19865343..af0048dfe 100644
--- a/pylint/lint.py
+++ b/pylint/lint.py
@@ -374,7 +374,7 @@ class PyLinter(
"default": (),
"level": 1,
"help": "List of plugins (as comma separated values of "
- "python modules names) to load, usually to register "
+ "python module names) to load, usually to register "
"additional checkers.",
},
),
@@ -413,12 +413,12 @@ class PyLinter(
"level": 1,
"default": "10.0 - ((float(5 * error + warning + refactor + "
"convention) / statement) * 10)",
- "help": "Python expression which should return a note less "
- "than 10 (10 is the highest note). You have access "
- "to the variables errors warning, statement which "
- "respectively contain the number of errors / "
- "warnings messages and the total number of "
- "statements analyzed. This is used by the global "
+ "help": "Python expression which should return a score less "
+ "than or equal to 10. You have access to the variables "
+ "'error', 'warning', 'refactor', and 'convention' which "
+ "contain the number of messages in each category, as well as "
+ "'statement' which is the total number of statements "
+ "analyzed. This score is used by the global "
"evaluation report (RP0004).",
},
),