parpg-core: pylintrc annotate

annotate pylintrc @ 7:af8e90c22758

Patch by aspidites: - fixed paths in config file template. - removed test file

author	Edwin Marshall <emarshall85@gmail.com>
date	Mon, 23 May 2011 20:24:14 -0500
parents	1fd2201f5c36
children

rev	line source
0 1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	1 # lint Python modules using external checkers.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	2 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	3 # This is the main checker controlling the other ones and the reports
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	4 # generation. It is itself both a raw checker and an astng checker in order
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	5 # to:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	6 # * handle message activation / deactivation at the module level
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	7 # * handle some basic but necessary stats'data (number of classes, methods...)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	8 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	9 [MASTER]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	10
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	11 # Specify a configuration file.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	12 #rcfile=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	13
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	14 # Python code to execute, usually for sys.path manipulation such as
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	15 # pygtk.require().
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	16 #init-hook=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	17
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	18 # Profiled execution.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	19 profile=no
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	20
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	21 # Add <file or directory> to the black list. It should be a base name, not a
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	22 # path. You may set this option multiple times.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	23 ignore=CVS
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	24
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	25 # Pickle collected data for later comparisons.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	26 persistent=yes
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	27
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	28 # Set the cache size for astng objects.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	29 cache-size=500
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	30
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	31 # List of plugins (as comma separated values of python modules names) to load,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	32 # usually to register additional checkers.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	33 load-plugins=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	34
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	35
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	36 [MESSAGES CONTROL]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	37
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	38 # Enable only checker(s) with the given id(s). This option conflicts with the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	39 # disable-checker option
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	40 #enable-checker=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	41
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	42 # Enable all checker(s) except those with the given id(s). This option
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	43 # conflicts with the enable-checker option
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	44 #disable-checker=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	45
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	46 # Enable all messages in the listed categories (IRCWEF).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	47 #enable-msg-cat=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	48
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	49 # Disable all messages in the listed categories (IRCWEF).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	50 disable-msg-cat=I
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	51
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	52 # Enable the message(s) with the given id(s).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	53 #enable-msg=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	54
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	55 # Disable the message(s) with the given id(s).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	56 disable-msg=W0704,W0105,W0142,R0901,R0913,W0221,W0613,R0903,R0902,R0201,R0904,R0914,R0912,W0511,R0915,R0911
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	57
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	58
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	59 [REPORTS]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	60
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	61 # Set the output format. Available formats are text, parseable, colorized, msvs
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	62 # (visual studio) and html
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	63 output-format=text
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	64
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	65 # Include message's id in output
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	66 include-ids=yes
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	67
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	68 # Put messages in a separate file for each module / package specified on the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	69 # command line instead of printing them on stdout. Reports (if any) will be
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	70 # written in a file name "pylint_global.[txt\|html]".
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	71 files-output=no
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	72
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	73 # Tells wether to display a full report or only the messages
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	74 reports=yes
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	75
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	76 # Python expression which should return a note less than 10 (10 is the highest
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	77 # note). You have access to the variables errors warning, statement which
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	78 # respectivly contain the number of errors / warnings messages and the total
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	79 # number of statements analyzed. This is used by the global evaluation report
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	80 # (R0004).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	81 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	82
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	83 # Add a comment according to your evaluation note. This is used by the global
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	84 # evaluation report (R0004).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	85 comment=no
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	86
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	87 # Enable the report(s) with the given id(s).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	88 #enable-report=R0004
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	89
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	90 # Disable the report(s) with the given id(s).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	91 disable-report=R0001,R0002,R0003,R0101,R0401,R0402,R0701,R0801
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	92
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	93
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	94 # checks for :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	95 # * doc strings
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	96 # * modules / classes / functions / methods / arguments / variables name
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	97 # * number of arguments, local variables, branchs, returns and statements in
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	98 # functions, methods
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	99 # * required module attributes
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	100 # * dangerous default values as arguments
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	101 # * redefinition of function / method / class
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	102 # * uses of the global statement
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	103 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	104 [BASIC]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	105
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	106 # Required attributes for module, separated by a comma
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	107 required-attributes=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	108
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	109 # Regular expression which should only match functions or classes name which do
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	110 # not require a docstring
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	111 no-docstring-rgx=__.*__
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	112
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	113 # Regular expression which should only match correct module names
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	114 module-rgx=(([a-z_][a-z0-9_]*)\|([A-Z][a-zA-Z0-9]+))$
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	115
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	116 # Regular expression which should only match correct module level names
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	117 const-rgx=(([A-Z_][A-Z0-9_])\|(__.__))$
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	118
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	119 # Regular expression which should only match correct class names
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	120 class-rgx=[A-Z_][a-zA-Z0-9]+$
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	121
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	122 # Regular expression which should only match correct function names
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	123 function-rgx=[a-z_][a-zA-Z0-9]{2,30}$
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	124
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	125 # Regular expression which should only match correct method names
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	126 method-rgx=[a-z_][a-zA-Z0-9]{2,30}$
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	127
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	128 # Regular expression which should only match correct instance attribute names
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	129 attr-rgx=[a-z_][a-z0-9_]{2,30}$
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	130
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	131 # Regular expression which should only match correct argument names
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	132 argument-rgx=[a-z_][a-z0-9_]{2,30}$
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	133
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	134 # Regular expression which should only match correct variable names
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	135 variable-rgx=[a-z_][a-z0-9_]{2,30}$
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	136
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	137 # Regular expression which should only match correct list comprehension /
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	138 # generator expression variable names
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	139 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	140
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	141 # Good variable names which should always be accepted, separated by a comma
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	142 good-names=k,ex,Run,_,__init__,__getstate__,__setstate__,ID,__repr__,x,y,z,X,Y,Z,__str__,__getitem__
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	143
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	144 # Bad variable names which should always be refused, separated by a comma
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	145 bad-names=foo,bar,baz,toto,tutu,tata
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	146
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	147 # List of builtins function names that should not be used, separated by a comma
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	148 bad-functions=map,filter,apply,input
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	149
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	150
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	151 # try to find bugs in the code using type inference
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	152 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	153 [TYPECHECK]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	154
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	155 # Tells wether missing members accessed in mixin class should be ignored. A
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	156 # mixin class is detected if its name ends with "mixin" (case insensitive).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	157 ignore-mixin-members=yes
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	158
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	159 # List of classes names for which member attributes should not be checked
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	160 # (useful for classes with attributes dynamicaly set).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	161 ignored-classes=SQLObject
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	162
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	163 # When zope mode is activated, add a predefined set of Zope acquired attributes
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	164 # to generated-members.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	165 zope=no
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	166
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	167 # List of members which are set dynamically and missed by pylint inference
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	168 # system, and so shouldn't trigger E0201 when accessed.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	169 generated-members=REQUEST,acl_users,aq_parent
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	170
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	171
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	172 # checks for
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	173 # * unused variables / imports
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	174 # * undefined variables
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	175 # * redefinition of variable from builtins or from an outer scope
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	176 # * use of variable before assigment
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	177 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	178 [VARIABLES]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	179
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	180 # Tells wether we should check for unused import in __init__ files.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	181 init-import=no
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	182
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	183 # A regular expression matching names used for dummy variables (i.e. not used).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	184 dummy-variables-rgx=_\|dummy
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	185
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	186 # List of additional names supposed to be defined in builtins. Remember that
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	187 # you should avoid to define new builtins when possible.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	188 additional-builtins=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	189
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	190
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	191 # checks for :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	192 # * methods without self as first argument
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	193 # * overridden methods signature
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	194 # * access only to existant members via self
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	195 # * attributes not defined in the __init__ method
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	196 # * supported interfaces implementation
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	197 # * unreachable code
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	198 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	199 [CLASSES]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	200
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	201 # List of interface methods to ignore, separated by a comma. This is used for
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	202 # instance to not check methods defines in Zope's Interface base class.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	203 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	204
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	205 # List of method names used to declare (i.e. assign) instance attributes.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	206 defining-attr-methods=__init__,__new__,setUp
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	207
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	208
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	209 # checks for sign of poor/misdesign:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	210 # * number of methods, attributes, local variables...
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	211 # * size, complexity of functions, methods
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	212 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	213 [DESIGN]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	214
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	215 # Maximum number of arguments for function / method
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	216 max-args=5
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	217
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	218 # Maximum number of locals for function / method body
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	219 max-locals=15
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	220
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	221 # Maximum number of return / yield for function / method body
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	222 max-returns=6
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	223
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	224 # Maximum number of branch for function / method body
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	225 max-branchs=12
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	226
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	227 # Maximum number of statements in function / method body
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	228 max-statements=50
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	229
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	230 # Maximum number of parents for a class (see R0901).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	231 max-parents=7
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	232
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	233 # Maximum number of attributes for a class (see R0902).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	234 max-attributes=7
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	235
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	236 # Minimum number of public methods for a class (see R0903).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	237 min-public-methods=2
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	238
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	239 # Maximum number of public methods for a class (see R0904).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	240 max-public-methods=20
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	241
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	242
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	243 # checks for
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	244 # * external modules dependencies
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	245 # * relative / wildcard imports
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	246 # * cyclic imports
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	247 # * uses of deprecated modules
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	248 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	249 [IMPORTS]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	250
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	251 # Deprecated modules which should not be used, separated by a comma
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	252 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	253
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	254 # Create a graph of every (i.e. internal and external) dependencies in the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	255 # given file (report R0402 must not be disabled)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	256 import-graph=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	257
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	258 # Create a graph of external dependencies in the given file (report R0402 must
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	259 # not be disabled)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	260 ext-import-graph=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	261
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	262 # Create a graph of internal dependencies in the given file (report R0402 must
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	263 # not be disabled)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	264 int-import-graph=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	265
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	266
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	267 # checks for :
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	268 # * unauthorized constructions
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	269 # * strict indentation
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	270 # * line length
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	271 # * use of <> instead of !=
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	272 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	273 [FORMAT]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	274
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	275 # Maximum number of characters on a single line.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	276 max-line-length=80
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	277
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	278 # Maximum number of lines in a module
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	279 max-module-lines=1000
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	280
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	281 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	282 # tab).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	283 indent-string=' '
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	284
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	285
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	286 # checks for:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	287 # * warning notes in the code like FIXME, XXX
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	288 # * PEP 263: source code with non ascii character but no encoding declaration
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	289 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	290 [MISCELLANEOUS]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	291
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	292 # List of note tags to take in consideration, separated by a comma.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	293 notes=FIXME,XXX,TODO
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	294
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	295
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	296 # checks for similarities and duplicated code. This computation may be
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	297 # memory / CPU intensive, so you should disable it if you experiments some
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	298 # problems.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	299 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	300 [SIMILARITIES]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	301
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	302 # Minimum lines number of a similarity.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	303 min-similarity-lines=4
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	304
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	305 # Ignore comments when computing similarities.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	306 ignore-comments=yes
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	307
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	308 # Ignore docstrings when computing similarities.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	309 ignore-docstrings=yes

Mercurial > parpg-core

annotate pylintrc @ 7:af8e90c22758