1# -*- coding: utf-8; mode: conf -*-
2# lint Python modules using external checkers.
4# This is the main checker controlling the other ones and the reports
5# generation. It is itself both a raw checker and an astng checker in order
7# * handle message activation / deactivation at the module level
8# * handle some basic but necessary stats'data (number of classes, methods...)
12# A comma-separated list of package or module names from where C extensions may
13# be loaded. Extensions are loading into the active Python interpreter and may
15extension-pkg-whitelist=lxml.etree
17# Add files or directories to the blacklist. They should be base names, not
21# Add files or directories matching the regex patterns to the blacklist. The
22# regex matches against base names, not paths.
25# Python code to execute, usually for sys.path manipulation such as
29# Use multiple processes to speed up Pylint.
32# List of plugins (as comma separated values of python modules names) to load,
33# usually to register additional checkers.
36# Pickle collected data for later comparisons.
39# Specify a configuration file.
42# Allow loading of arbitrary C extensions. Extensions are imported into the
43# active Python interpreter and may run arbitrary code.
44unsafe-load-any-extension=no
49# Only show warnings with the listed confidence levels. Leave empty to show
50# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
53# Disable the message, report, category or checker with the given id(s). You
54# can either give multiple identifiers separated by comma (,) or put this
55# option multiple times (only on the command line, not in the configuration
56# file where it should appear only once).You can also use "--disable=all" to
57# disable everything first and then reenable specific checks. For example, if
58# you want to run only the similarities checker, you can use "--disable=all
59# --enable=similarities". If you want to run only the classes checker, but have
60# no Warning level messages displayed, use"--disable=all --enable=classes
62disable=bad-whitespace, duplicate-code
64# Enable the message, report, category or checker with the given id(s). You can
65# either give multiple identifier separated by comma (,) or put this option
66# multiple time (only on the command line, not in the configuration file where
67# it should appear only once). See also the "--disable" option for examples.
73# Python expression which should return a note less than 10 (10 is the highest
74# note). You have access to the variables errors warning, statement which
75# respectively contain the number of errors / warnings messages and the total
76# number of statements analyzed. This is used by the global evaluation report
78evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
80# Template used to display messages. This is a python new-style format string
81# used to format the message information. See doc for all details
83# HINT: do not set this here, use argument --msg-template=...
84#msg-template={path}:{line}: [{msg_id}({symbol}),{obj}] {msg}
86# Set the output format. Available formats are text, parseable, colorized, json
87# and msvs (visual studio).You can also give a reporter class, eg
88# mypackage.mymodule.MyReporterClass.
90# HINT: do not set this here, use argument --output-format=...
93# Tells whether to display a full report or only the messages
96# Activate the evaluation score.
102# Maximum number of nested blocks for function / method body
108# List of builtins function names that should not be used, separated by a comma
109bad-functions=map,filter,apply,input
111# Naming hint for argument names
112argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
114# Regular expression matching correct argument names
115argument-rgx=(([a-z][a-zA-Z0-9_]{2,30})|(_[a-z0-9_]*))$
117# Naming hint for attribute names
118attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
120# Regular expression matching correct attribute names
121attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*)|([A-Z0-9_]*))$
123# Bad variable names which should always be refused, separated by a comma
124bad-names=foo,bar,baz,toto,tutu,tata
126# Naming hint for class attribute names
127class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
129# Regular expression matching correct class attribute names
130class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
132# Naming hint for class names
133class-name-hint=[A-Z_][a-zA-Z0-9]+$
135# Regular expression matching correct class names
136class-rgx=[A-Z_][a-zA-Z0-9]+$
138# Naming hint for constant names
139const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
141# Regular expression matching correct constant names
142const-rgx=(([a-zA-Z_][a-zA-Z0-9_]*)|(__.*__))$
143#const-rgx=[f]?[A-Z_][a-zA-Z0-9_]{2,30}$
145# Minimum line length for functions/classes that require docstrings, shorter
147docstring-min-length=-1
149# Naming hint for function names
150function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
152# Regular expression matching correct function names
153function-rgx=(([a-z][a-zA-Z0-9_]{2,30})|(_[a-z0-9_]*))$
155# Good variable names which should always be accepted, separated by a comma
156good-names=i,j,k,ex,Run,_,log,cfg,id
158# Include a hint for the correct naming format with invalid-name
159include-naming-hint=no
161# Naming hint for inline iteration names
162inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
164# Regular expression matching correct inline iteration names
165inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
167# Naming hint for method names
168method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
170# Regular expression matching correct method names
171method-rgx=(([a-z][a-zA-Z0-9_]{2,30})|(_[a-z0-9_]*))$
173# Naming hint for module names
174module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
176# Regular expression matching correct module names
177#module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
178module-rgx=([a-z_][a-z0-9_]*)$
180# Colon-delimited sets of names that determine each other's naming style when
181# the name regexes allow several styles.
184# Regular expression which should only match function or class names that do
185# not require a docstring.
188# List of decorators that produce properties, such as abc.abstractproperty. Add
189# to this list to register other decorators that produce valid properties.
190property-classes=abc.abstractproperty
192# Naming hint for variable names
193variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
195# Regular expression matching correct variable names
196variable-rgx=(([a-z][a-zA-Z0-9_]{2,30})|(_[a-z0-9_]*)|([a-z]))$
201# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
202expected-line-ending-format=
204# Regexp for a line that is allowed to be longer than the limit.
205ignore-long-lines=^\s*(# )?<?https?://\S+>?$
207# Number of spaces of indent required inside a hanging or continued line.
210# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
214# Maximum number of characters on a single line.
217# Maximum number of lines in a module
220# List of optional constructs for which whitespace checking is disabled. `dict-
221# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
222# `trailing-comma` allows a space between comma and closing bracket: (a, ).
223# `empty-line` allows space-only lines.
224no-space-check=trailing-comma,dict-separator
226# Allow the body of a class to be on the same line as the declaration if body
227# contains single statement.No config file found, using default configuration
229single-line-class-stmt=no
231# Allow the body of an if to be on the same line as the test if there is no
233single-line-if-stmt=no
238# Logging modules to check that the string format arguments are in logging
239# function parameter format
240logging-modules=logging
245# List of note tags to take in consideration, separated by a comma.
251# Ignore comments when computing similarities.
254# Ignore docstrings when computing similarities.
257# Ignore imports when computing similarities.
260# Minimum lines number of a similarity.
261min-similarity-lines=4
266# Spelling dictionary name. Available dictionaries: none. To make it working
267# install python-enchant package.
270# List of comma separated words that should not be checked.
271spelling-ignore-words=
273# A path to a file that contains private dictionary; one word per line.
274spelling-private-dict-file=
276# Tells whether to store unknown words to indicated private dictionary in
277# --spelling-private-dict-file option instead of raising a message.
278spelling-store-unknown-words=no
283# List of decorators that produce context managers, such as
284# contextlib.contextmanager. Add to this list to register other decorators that
285# produce valid context managers.
286contextmanager-decorators=contextlib.contextmanager
288# List of members which are set dynamically and missed by pylint inference
289# system, and so shouldn't trigger E1101 when accessed. Python regular
290# expressions are accepted.
293# Tells whether missing members accessed in mixin class should be ignored. A
294# mixin class is detected if its name ends with "mixin" (case insensitive).
295ignore-mixin-members=yes
297# This flag controls whether pylint should warn about no-member and similar
298# checks whenever an opaque object is returned when inferring. The inference
299# can return multiple potential results while evaluating a Python object, but
300# some branches might not be evaluated, which results in partial inference. In
301# that case, it might be useful to still emit no-member and other checks for
302# the rest of the inferred objects.
303ignore-on-opaque-inference=yes
305# List of class names for which member attributes should not be checked (useful
306# for classes with dynamically set attributes). This supports the use of
308ignored-classes=optparse.Values,thread._local,_thread._local
310# List of module names for which member attributes should not be checked
311# (useful for modules/projects where namespaces are manipulated during runtime
312# and thus existing member attributes cannot be deduced by static analysis. It
313# supports qualified module names, as well as Unix pattern matching.
316# Show a hint with possible names when a member name was not found. The aspect
317# of finding the hint is based on edit distance.
318missing-member-hint=yes
320# The minimum edit distance a name should have in order to be considered a
321# similar match for a missing member name.
322missing-member-hint-distance=1
324# The total number of similar names that should be taken in consideration when
325# showing a hint for a missing member.
326missing-member-max-choices=1
331# List of additional names supposed to be defined in builtins. Remember that
332# you should avoid to define new builtins when possible.
335# Tells whether unused global variables should be treated as a violation.
336allow-global-unused-variables=yes
338# List of strings which can identify a callback function by name. A callback
339# name must start or end with one of those strings.
342# A regular expression matching the name of dummy variables (i.e. expectedly
344dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
346# Argument names that match this expression will be ignored. Default to name
347# with leading underscore
348ignored-argument-names=_.*|^ignored_|^unused_
350# Tells whether we should check for unused import in __init__ files.
353# List of qualified module names which can have objects that can redefine
355redefining-builtins-modules=six.moves,future.builtins
360# List of method names used to declare (i.e. assign) instance attributes.
361defining-attr-methods=__init__,__new__,setUp
363# List of member names, which should be excluded from the protected access
365exclude-protected=_asdict,_fields,_replace,_source,_make
367# List of valid names for the first argument in a class method.
368valid-classmethod-first-arg=cls
370# List of valid names for the first argument in a metaclass class method.
371valid-metaclass-classmethod-first-arg=mcs
376# Maximum number of arguments for function / method
379# Maximum number of attributes for a class (see R0902).
382# Maximum number of boolean expressions in a if statement
385# Maximum number of branch for function / method body
388# Maximum number of locals for function / method body
391# Maximum number of parents for a class (see R0901).
394# Maximum number of public methods for a class (see R0904).
397# Maximum number of return / yield for function / method body
400# Maximum number of statements in function / method body
403# Minimum number of public methods for a class (see R0903).
409# Allow wildcard imports from modules that define __all__.
410allow-wildcard-with-all=no
412# Analyse import fallback blocks. This can be used to support both Python 2 and
413# 3 compatible code, which means that the block might have code that exists
414# only in one or another interpreter, leading to false positives when analysed.
415analyse-fallback-blocks=no
417# Deprecated modules which should not be used, separated by a comma
418deprecated-modules=optparse,tkinter.tix
420# Create a graph of external dependencies in the given file (report RP0402 must
424# Create a graph of every (i.e. internal and external) dependencies in the
425# given file (report RP0402 must not be disabled)
428# Create a graph of internal dependencies in the given file (report RP0402 must
432# Force import order to recognize a module as part of the standard
433# compatibility libraries.
434known-standard-library=
436# Force import order to recognize a module as part of a third party library.
437known-third-party=enchant
442# Exceptions that will emit a warning when being caught. Defaults to
444overgeneral-exceptions=Exception
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list