3 # Specify a configuration file.
6 # Python code to execute, usually for sys.path manipulation such as
8 init-hook='sys.path.append(os.path.abspath(os.path.curdir))'
10 # Add files or directories to the blacklist. They should be base names, not
12 ignore=proto, tests, docs, automation
14 # Add files or directories matching the regex patterns to the blacklist. The
15 # regex matches against base names, not paths.
16 ignore-patterns=.env3/*, python3.5, .*_test.py
18 # Pickle collected data for later comparisons.
21 # List of plugins (as comma separated values of python modules names) to load,
22 # usually to register additional checkers.
25 # Use multiple processes to speed up Pylint.
28 # Allow loading of arbitrary C extensions. Extensions are imported into the
29 # active Python interpreter and may run arbitrary code.
30 unsafe-load-any-extension=no
32 # A comma-separated list of package or module names from where C extensions may
33 # be loaded. Extensions are loading into the active Python interpreter and may
35 extension-pkg-whitelist=
37 # Allow optimization of some AST trees. This will activate a peephole AST
38 # optimizer, which will apply various small optimizations. For instance, it can
39 # be used to obtain the result of joining multiple strings with the addition
40 # operator. Joining a lot of strings can lead to a maximum recursion error in
41 # Pylint and this flag can prevent that. It has one side effect, the resulting
42 # AST will be different than the one from reality. This option is deprecated
43 # and it will be removed in Pylint 2.0.
48 # Only show warnings with the listed confidence levels. Leave empty to show
49 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
52 # Enable the message, report, category or checker with the given id(s). You can
53 # either give multiple identifier separated by comma (,) or put this option
54 # multiple time (only on the command line, not in the configuration file where
55 # it should appear only once). See also the "--disable" option for examples.
58 # Disable the message, report, category or checker with the given id(s). You
59 # can either give multiple identifiers separated by comma (,) or put this
60 # option multiple times (only on the command line, not in the configuration
61 # file where it should appear only once).You can also use "--disable=all" to
62 # disable everything first and then reenable specific checks. For example, if
63 # you want to run only the similarities checker, you can use "--disable=all
64 # --enable=similarities". If you want to run only the classes checker, but have
65 # no Warning level messages displayed, use"--disable=all --enable=classes
67 disable=locally-disabled,too-few-public-methods,no-self-use,too-many-ancestors,
68 missing-docstring,old-style-class,consider-iterating-dictionary,consider-using-enumerate,
69 superfluous-parens,no-else-return,duplicate-code,wrong-import-order,
70 too-many-locals,logging-not-lazy,unnecessary-lambda,super-on-old-class,ungrouped-imports,too-many-format-args,
71 protected-access,too-many-statements,too-many-branches,too-many-return-statements,too-many-public-methods,
72 super-init-not-called,singleton-comparison,pointless-string-statement,broad-except, invalid-name
76 # Set the output format. Available formats are text, parseable, colorized, msvs
77 # (visual studio) and html. You can also give a reporter class, eg
78 # mypackage.mymodule.MyReporterClass.
81 # Put messages in a separate file for each module / package specified on the
82 # command line instead of printing them on stdout. Reports (if any) will be
83 # written in a file name "pylint_global.[txt|html]". This option is deprecated
84 # and it will be removed in Pylint 2.0.
87 # Tells whether to display a full report or only the messages
90 # Python expression which should return a note less than 10 (10 is the highest
91 # note). You have access to the variables errors warning, statement which
92 # respectively contain the number of errors / warnings messages and the total
93 # number of statements analyzed. This is used by the global evaluation report
95 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
97 # Template used to display messages. This is a python new-style format string
98 # used to format the message information. See doc for all details
104 # Logging modules to check that the string format arguments are in logging
105 # function parameter format
106 logging-modules=logging
111 # Minimum lines number of a similarity.
112 min-similarity-lines=8
114 # Ignore comments when computing similarities.
117 # Ignore docstrings when computing similarities.
118 ignore-docstrings=yes
120 # Ignore imports when computing similarities.
126 # Maximum number of characters on a single line.
129 # Regexp for a line that is allowed to be longer than the limit.
130 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
132 # Allow the body of an if to be on the same line as the test if there is no
134 single-line-if-stmt=no
136 # List of optional constructs for which whitespace checking is disabled. `dict-
137 # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
138 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
139 # `empty-line` allows space-only lines.
140 no-space-check=trailing-comma,dict-separator
142 # Maximum number of lines in a module
143 max-module-lines=1000
145 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
149 # Number of spaces of indent required inside a hanging or continued line.
152 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
153 expected-line-ending-format=
158 # Spelling dictionary name. Available dictionaries: none. To make it working
159 # install python-enchant package.
162 # List of comma separated words that should not be checked.
163 spelling-ignore-words=TF, MO, IR, IE
165 # A path to a file that contains private dictionary; one word per line.
166 spelling-private-dict-file=.pylintdict
168 # Tells whether to store unknown words to indicated private dictionary in
169 # --spelling-private-dict-file option instead of raising a message.
170 spelling-store-unknown-words=no
175 # Tells whether we should check for unused import in __init__ files.
178 # A regular expression matching the name of dummy variables (i.e. expectedly
180 dummy-variables-rgx=(_+[a-zA-Z0-9]*?$)|dummy
182 # List of additional names supposed to be defined in builtins. Remember that
183 # you should avoid to define new builtins when possible.
186 # List of strings which can identify a callback function by name. A callback
187 # name must start or end with one of those strings.
190 # List of qualified module names which can have objects that can redefine
192 redefining-builtins-modules=six.moves,future.builtins
197 # Tells whether missing members accessed in mixin class should be ignored. A
198 # mixin class is detected if its name ends with "mixin" (case insensitive).
199 ignore-mixin-members=yes
201 # List of module names for which member attributes should not be checked
202 # (useful for modules/projects where namespaces are manipulated during runtime
203 # and thus existing member attributes cannot be deduced by static analysis. It
204 # supports qualified module names, as well as Unix pattern matching.
205 ignored-modules=flask_sqlalchemy,app.extensions.flask_sqlalchemy
207 # List of class names for which member attributes should not be checked (useful
208 # for classes with dynamically set attributes). This supports the use of
210 ignored-classes=optparse.Values,thread._local,_thread._local
212 # List of members which are set dynamically and missed by pylint inference
213 # system, and so shouldn't trigger E1101 when accessed. Python regular
214 # expressions are accepted.
215 generated-members=fget,query,begin,add,merge,delete,commit,rollback
217 # List of decorators that produce context managers, such as
218 # contextlib.contextmanager. Add to this list to register other decorators that
219 # produce valid context managers.
220 contextmanager-decorators=contextlib.contextmanager
225 # List of note tags to take in consideration, separated by a comma.
231 # Good variable names which should always be accepted, separated by a comma
232 good-names=i,j,k,ex,Run,_,log,api,a,c,d,e,ei,f,hp,id,l,l2,ml,mn,n,N,op,p,pb,pb,ph,q,rt,s,s1,s2,si,u,v,wp,x,y
234 # Bad variable names which should always be refused, separated by a comma
235 bad-names=foo,bar,baz,toto,tutu,tata
237 # Colon-delimited sets of names that determine each other's naming style when
238 # the name regexes allow several styles.
241 # Include a hint for the correct naming format with invalid-name
242 include-naming-hint=no
244 # List of decorators that produce properties, such as abc.abstractproperty. Add
245 # to this list to register other decorators that produce valid properties.
246 property-classes=abc.abstractproperty
248 # Regular expression matching correct class names
249 class-rgx=[A-Z_][a-zA-Z0-9]+$
251 # Naming hint for class names
252 class-name-hint=[A-Z_][a-zA-Z0-9]+$
254 # Regular expression matching correct constant names
255 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
257 # Naming hint for constant names
258 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
260 # Regular expression matching correct argument names
261 argument-rgx=([a-z_][a-z0-9_]{2,40}$)|(fileName)|(pl)|(t)
263 # Naming hint for argument names
264 argument-name-hint=[a-z_][a-z0-9_]{2,40}$
266 # Regular expression matching correct inline iteration names
267 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
269 # Naming hint for inline iteration names
270 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
272 # Regular expression matching correct method names
273 method-rgx=[a-z_][a-z0-9_]{2,40}$
275 # Naming hint for method names
276 method-name-hint=[a-z_][a-z0-9_]{2,40}$
278 # Regular expression matching correct function names
279 function-rgx=([a-z_][a-z0-9_]{2,40}$)
281 # Naming hint for function names
282 function-name-hint=[a-z_][a-z0-9_]{2,40}$
284 # Regular expression matching correct class attribute names
285 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,40}|(__.*__))$
287 # Naming hint for class attribute names
288 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,40}|(__.*__))$
290 # Regular expression matching correct attribute names
291 attr-rgx=[a-z_][a-z0-9_]{2,40}$
293 # Naming hint for attribute names
294 attr-name-hint=[a-z_][a-z0-9_]{2,40}$
296 # Regular expression matching correct variable names
297 variable-rgx=[a-z_][a-z0-9_]{2,40}$
299 # Naming hint for variable names
300 variable-name-hint=[a-z_][a-z0-9_]{2,40}$
302 # Regular expression matching correct module names
303 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
305 # Naming hint for module names
306 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
308 # Regular expression which should only match function or class names that do
309 # not require a docstring.
312 # Minimum line length for functions/classes that require docstrings, shorter
314 docstring-min-length=5
319 # Maximum number of nested blocks for function / method body
325 # Maximum number of arguments for function / method
328 # Argument names that match this expression will be ignored. Default to name
329 # with leading underscore
330 ignored-argument-names=_.*
332 # Maximum number of locals for function / method body
335 # Maximum number of return / yield for function / method body
338 # Maximum number of branch for function / method body
341 # Maximum number of statements in function / method body
344 # Maximum number of parents for a class (see R0901).
347 # Maximum number of attributes for a class (see R0902).
350 # Minimum number of public methods for a class (see R0903).
353 # Maximum number of public methods for a class (see R0904).
354 max-public-methods=20
356 # Maximum number of boolean expressions in a if statement
362 # Deprecated modules which should not be used, separated by a comma
363 deprecated-modules=optparse
365 # Create a graph of every (i.e. internal and external) dependencies in the
366 # given file (report RP0402 must not be disabled)
369 # Create a graph of external dependencies in the given file (report RP0402 must
373 # Create a graph of internal dependencies in the given file (report RP0402 must
377 # Force import order to recognize a module as part of the standard
378 # compatibility libraries.
379 known-standard-library=
381 # Force import order to recognize a module as part of a third party library.
382 known-third-party=flask_restplus_patched
384 # Analyse import fallback blocks. This can be used to support both Python 2 and
385 # 3 compatible code, which means that the block might have code that exists
386 # only in one or another interpreter, leading to false positives when analysed.
387 analyse-fallback-blocks=no
392 # List of method names used to declare (i.e. assign) instance attributes.
393 defining-attr-methods=__init__,__new__,setUp
395 # List of valid names for the first argument in a class method.
396 valid-classmethod-first-arg=cls
398 # List of valid names for the first argument in a metaclass class method.
399 valid-metaclass-classmethod-first-arg=mcs
401 # List of member names, which should be excluded from the protected access
403 exclude-protected=_asdict,_fields,_replace,_source,_make
408 # Exceptions that will emit a warning when being caught. Defaults to
410 overgeneral-exceptions=Exception