290N/A# The contents of this file are subject to the terms of the
290N/A# Common Development and Distribution License (the "License").
290N/A# You may not use this file except in compliance with the License.
290N/A# See the License for the specific language governing permissions
290N/A# and limitations under the License.
290N/A# When distributing Covered Code, include this CDDL HEADER in each
290N/A# If applicable, add the following below this CDDL HEADER, with the
290N/A# fields enclosed by brackets "[]" replaced with your own identifying
290N/A# information: Portions Copyright [yyyy] [name of copyright owner]
3455N/A# Copyright (c) 2008, 2016, Oracle
and/or its affiliates. All rights reserved.
290N/A# This file is used to control pylint when checking python source
290N/A# Add <file or directory> to the black list. It should be a base name, not a
290N/A# path. You may set this option multiple times.
290N/A# Pickle collected data for later comparisons.
290N/A# List of plugins (as comma separated values of python modules names) to load,
290N/A# usually to register additional checkers.
3253N/A# A comma-separated list of package or module names from where C extensions may
3253N/A# be loaded. Extensions are loading into the active Python interpreter and may
290N/A# Enable all checker(s) except those with the given id(s). This option
290N/A# conflicts with the enable-checker option
290N/Adisable-checker=similarities
290N/A# Disable the message(s) with the given id(s).
2690N/A# C0302 Too many lines in module
2690N/A# R0901 Too many ancestors (%s/%s)
2690N/A# R0902 Too many instance attributes
2690N/A# R0904 Too many public methods
2690N/A# R0911 Too many return statements
2690N/A# R0914 Too many local variables
2690N/A# R0923 Interface not implemented
2690N/A# W0141 Used builtin function '%s'
2690N/A# W0614 Unused import %s from wildcard import
2828N/A# I0011 Locally disabling %r
3253N/A# I0012 Locally enabling %s (%s)
3455N/A# R0204 Redefined variable type
3455N/A# C0123 Unidiomatic typecheck
3455N/Adisable=C0103,C0302,C0326,C0330,R0901,R0902,R0904,R0911,R0912,R0913,R0914,R0915,R0923,W0141,W0142,W0614,I0011,I0012,R0204,C0123
290N/A# set the output format. Available formats are text, parseable, colorized, msvs
290N/A# (visual studio) and html
3253N/A# Deprecated. It was used to include message's id in output. Use --msg-template
290N/A# Put messages in a separate file for each module / package specified on the
290N/A# command line instead of printing them on stdout. Reports (if any) will be
290N/A# written in a file name "pylint_global.[txt|html]".
290N/A# Tells wether to display a full report or only the messages
290N/A# Python expression which should return a note less than 10 (10 is the highest
290N/A# note).You have access to the variables errors warning, statement which
290N/A# respectivly contain the number of errors / warnings messages and the total
290N/A# number of statements analyzed. This is used by the global evaluation report
290N/Aevaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
290N/A# Add a comment according to your evaluation note. This is used by the global
290N/A# evaluation report (R0004).
3253N/A# Template used to display messages. This is a python new-style format string
3253N/A# used to format the message information. See doc for all details
3253N/Amsg-template='{msg_id}:{line:3d},{column:2d}: {msg} ({symbol})'
290N/A# * modules / classes / functions / methods / arguments / variables name
290N/A# * number of arguments, local variables, branchs, returns and statements in
290N/A# * required module attributes
290N/A# * dangerous default values as arguments
290N/A# * redefinition of function / method / class
290N/A# * uses of the global statement
290N/A# Regular expression which should only match functions or classes name which do
290N/A# not require a docstring
290N/A# Regular expression which should only match correct module names
290N/Amodule-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
290N/A# Regular expression which should only match correct module level names
290N/Aconst-rgx=(([A-Z_][A-Z1-9_]*)|(__.*__))$
290N/A# Regular expression which should only match correct class names
290N/Aclass-rgx=[A-Z_][a-zA-Z0-9]+$
290N/A# Regular expression which should only match correct function names
290N/Afunction-rgx=[a-z_][a-z0-9_]{2,30}$
290N/A# Regular expression which should only match correct method names
290N/Amethod-rgx=[a-z_][a-z0-9_]{2,30}$
290N/A# Regular expression which should only match correct instance attribute names
290N/Aattr-rgx=[a-z_][a-z0-9_]{2,30}$
290N/A# Regular expression which should only match correct argument names
290N/Aargument-rgx=[a-z_][a-z0-9_]{2,30}$
290N/A# Regular expression which should only match correct variable names
290N/Avariable-rgx=[a-z_][a-z0-9_]{2,30}$
290N/A# Regular expression which should only match correct list comprehension /
290N/A# generator expression variable names
290N/Ainlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
290N/A# Good variable names which should always be accepted, separated by a comma
290N/Agood-names=i,j,k,ex,Run,_
290N/A# Bad variable names which should always be refused, separated by a comma
290N/Abad-names=foo,bar,baz,toto,tutu,tata
290N/A# List of builtins function names that should not be used, separated by a comma
290N/Abad-functions=map,filter,apply,input
290N/A# try to find bugs in the code using type inference
290N/A# Tells wether missing members accessed in mixin class should be ignored. A
290N/A# mixin class is detected if its name ends with "mixin" (case insensitive).
290N/Aignore-mixin-members=yes
290N/A# When zope mode is activated, consider the acquired-members option to ignore
290N/A# access to some undefined attributes.
290N/A# List of members which are usually get through zope's acquisition mecanism and
290N/A# so shouldn't trigger E0201 when accessed (need zope=yes to be considered).
290N/Aacquired-members=REQUEST,acl_users,aq_parent
290N/A# * unused variables / imports
290N/A# * redefinition of variable from builtins or from an outer scope
290N/A# * use of variable before assigment
290N/A# Tells wether we should check for unused import in __init__ files.
290N/A# A regular expression matching names used for dummy variables (
i.e. not used).
290N/Adummy-variables-rgx=_|dummy
290N/A# List of additional names supposed to be defined in builtins. Remember that
290N/A# you should avoid to define new builtins when possible.
290N/A# In this case we define '_' (the function name for gettext) so that pylint
290N/A# doesn't complain about things like _("this is i18n string")
290N/A# * methods without self as first argument
290N/A# * overridden methods signature
290N/A# * access only to existant members via self
290N/A# * attributes not defined in the __init__ method
290N/A# * supported interfaces implementation
290N/A# List of method names used to declare (
i.e. assign) instance attributes.
290N/Adefining-attr-methods=__init__,__new__,setUp
290N/A# * number of methods, attributes, local variables...
290N/A# * size, complexity of functions, methods
290N/A# Maximum number of arguments for function / method
290N/A# Maximum number of locals for function / method body
290N/A# Maximum number of return / yield for function / method body
290N/A# Maximum number of branch for function / method body
290N/A# Maximum number of statements in function / method body
290N/A# Maximum number of parents for a class (see R0901).
290N/A# Maximum number of attributes for a class (see R0902).
290N/A# Minimum number of public methods for a class (see R0903).
290N/A# Maximum number of public methods for a class (see R0904).
290N/A# * external modules dependencies
290N/A# * relative / wildcard imports
290N/A# * uses of deprecated modules
290N/A# Deprecated modules which should not be used, separated by a comma
290N/Adeprecated-modules=regsub,string,TERMIOS,Bastion,rexec
290N/A# Create a graph of every (
i.e. internal and external) dependencies in the
290N/A# given file (report R0402 must not be disabled)
290N/A# Create a graph of external dependencies in the given file (report R0402 must
290N/A# Create a graph of internal dependencies in the given file (report R0402 must
290N/A# * unauthorized constructions
290N/A# * use of <> instead of !=
290N/A# Maximum number of characters on a single line.
290N/A# Maximum number of lines in a module
290N/A# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
290N/A# * warning notes in the code like FIXME, XXX
290N/A# * PEP 263: source code with non ascii character but no encoding declaration
290N/A# List of note tags to take in consideration, separated by a comma.
290N/A# checks for similarities and duplicated code. This computation may be
290N/A# memory / CPU intensive, so you should disable it if you experiments some
290N/A# Minimum lines number of a similarity.
290N/A# Ignore comments when computing similarities.
290N/A# Ignore docstrings when computing similarities.