Home | History | Annotate | Download | only in Python3
      1 # lint Python modules using external checkers
      2 
      3 [MASTER]
      4 
      5 # Specify a configuration file.
      6 #rcfile=
      7 
      8 # Python code to execute, usually for sys.path manipulation such as
      9 # pygtk.require().
     10 #init-hook=
     11 
     12 # Profiled execution.
     13 profile=no
     14 
     15 # Add <file or directory> to the black list. It should be a base name, not a
     16 # path. You may set this option multiple times.
     17 ignore=CVS
     18 
     19 # Pickle collected data for later comparisons.
     20 persistent=yes
     21 
     22 # List of plugins (as comma separated values of python modules names) to load,
     23 # usually to register additional checkers.
     24 load-plugins=
     25 
     26 
     27 [MESSAGES CONTROL]
     28 
     29 # Enable the message, report, category or checker with the given id(s). You can
     30 # either give multiple identifier separated by comma (,) or put this option
     31 # multiple time.
     32 #enable=
     33 
     34 # Disable the message, report, category or checker with the given id(s). You
     35 # can either give multiple identifier separated by comma (,) or put this option
     36 # multiple time (only on the command line, not in the configuration file where
     37 # it should appear only once).
     38 # W0622: Redefining built-in '...'
     39 # C0103: Invalid name
     40 # R0904: Too many public methods
     41 # R0201: Method could be a function
     42 # C0302: Too many lines in a module
     43 # R0902: Too many instance attributes
     44 # R0913: Too many arguments
     45 # R0912: Too many branches
     46 # R0903: Too few public methods
     47 # C0111: Missing docstring
     48 # W0403: Relative import
     49 # W0401: Wildcard import
     50 # W0142: */** magic
     51 disable=W0622,C0103,R0904,R0201,C0302,R0902,R0913,R0912,R0903,C0111,W0403,W0401,W0142
     52 
     53 
     54 [REPORTS]
     55 
     56 # Set the output format. Available formats are text, parseable, colorized, msvs
     57 # (visual studio) and html
     58 output-format=text
     59 
     60 # Include message's id in output
     61 include-ids=yes
     62 
     63 # Put messages in a separate file for each module / package specified on the
     64 # command line instead of printing them on stdout. Reports (if any) will be
     65 # written in a file name "pylint_global.[txt|html]".
     66 files-output=no
     67 
     68 # Tells whether to display a full report or only the messages
     69 reports=yes
     70 
     71 # Python expression which should return a note less than 10 (10 is the highest
     72 # note). You have access to the variables errors warning, statement which
     73 # respectively contain the number of errors / warnings messages and the total
     74 # number of statements analyzed. This is used by the global evaluation report
     75 # (RP0004).
     76 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
     77 
     78 # Add a comment according to your evaluation note. This is used by the global
     79 # evaluation report (RP0004).
     80 comment=no
     81 
     82 
     83 [BASIC]
     84 
     85 # Required attributes for module, separated by a comma
     86 required-attributes=
     87 
     88 # List of builtins function names that should not be used, separated by a comma
     89 bad-functions=map,filter,apply,input
     90 
     91 # Regular expression which should only match correct module names
     92 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
     93 
     94 # Regular expression which should only match correct module level names
     95 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
     96 
     97 # Regular expression which should only match correct class names
     98 class-rgx=[A-Z_][a-zA-Z0-9]+$
     99 
    100 # Regular expression which should only match correct function names
    101 function-rgx=[a-z_][a-z0-9_]{2,30}$
    102 
    103 # Regular expression which should only match correct method names
    104 method-rgx=[a-z_][a-z0-9_]{2,30}$
    105 
    106 # Regular expression which should only match correct instance attribute names
    107 attr-rgx=[a-z_][a-z0-9_]{2,30}$
    108 
    109 # Regular expression which should only match correct argument names
    110 argument-rgx=[a-z_][a-z0-9_]{2,30}$
    111 
    112 # Regular expression which should only match correct variable names
    113 variable-rgx=[a-z_][a-z0-9_]{2,30}$
    114 
    115 # Regular expression which should only match correct list comprehension /
    116 # generator expression variable names
    117 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
    118 
    119 # Good variable names which should always be accepted, separated by a comma
    120 good-names=i,j,k,ex,Run,_
    121 
    122 # Bad variable names which should always be refused, separated by a comma
    123 bad-names=foo,bar,baz,toto,tutu,tata
    124 
    125 # Regular expression which should only match functions or classes name which do
    126 # not require a docstring
    127 no-docstring-rgx=__.*__
    128 
    129 
    130 [FORMAT]
    131 
    132 # Maximum number of characters on a single line.
    133 max-line-length=80
    134 
    135 # Maximum number of lines in a module
    136 max-module-lines=1000
    137 
    138 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
    139 # tab).
    140 indent-string='    '
    141 
    142 
    143 [MISCELLANEOUS]
    144 
    145 # List of note tags to take in consideration, separated by a comma.
    146 notes=FIXME,XXX,TODO
    147 
    148 
    149 [VARIABLES]
    150 
    151 # Tells whether we should check for unused import in __init__ files.
    152 init-import=no
    153 
    154 # A regular expression matching the beginning of the name of dummy variables
    155 # (i.e. not used).
    156 dummy-variables-rgx=_|dummy
    157 
    158 # List of additional names supposed to be defined in builtins. Remember that
    159 # you should avoid to define new builtins when possible.
    160 additional-builtins=
    161 
    162 
    163 [SIMILARITIES]
    164 
    165 # Minimum lines number of a similarity.
    166 min-similarity-lines=4
    167 
    168 # Ignore comments when computing similarities.
    169 ignore-comments=yes
    170 
    171 # Ignore docstrings when computing similarities.
    172 ignore-docstrings=yes
    173 
    174 
    175 [TYPECHECK]
    176 
    177 # Tells whether missing members accessed in mixin class should be ignored. A
    178 # mixin class is detected if its name ends with "mixin" (case insensitive).
    179 ignore-mixin-members=yes
    180 
    181 # List of classes names for which member attributes should not be checked
    182 # (useful for classes with attributes dynamically set).
    183 ignored-classes=SQLObject
    184 
    185 # When zope mode is activated, add a predefined set of Zope acquired attributes
    186 # to generated-members.
    187 zope=no
    188 
    189 # List of members which are set dynamically and missed by pylint inference
    190 # system, and so shouldn't trigger E0201 when accessed.
    191 generated-members=REQUEST,acl_users,aq_parent
    192 
    193 
    194 [CLASSES]
    195 
    196 # List of interface methods to ignore, separated by a comma. This is used for
    197 # instance to not check methods defines in Zope's Interface base class.
    198 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
    199 
    200 # List of method names used to declare (i.e. assign) instance attributes.
    201 defining-attr-methods=__init__,__new__,setUp
    202 
    203 
    204 [DESIGN]
    205 
    206 # Maximum number of arguments for function / method
    207 max-args=5
    208 
    209 # Argument names that match this expression will be ignored. Default to name
    210 # with leading underscore
    211 ignored-argument-names=_.*
    212 
    213 # Maximum number of locals for function / method body
    214 max-locals=15
    215 
    216 # Maximum number of return / yield for function / method body
    217 max-returns=6
    218 
    219 # Maximum number of branch for function / method body
    220 max-branchs=12
    221 
    222 # Maximum number of statements in function / method body
    223 max-statements=50
    224 
    225 # Maximum number of parents for a class (see R0901).
    226 max-parents=7
    227 
    228 # Maximum number of attributes for a class (see R0902).
    229 max-attributes=7
    230 
    231 # Minimum number of public methods for a class (see R0903).
    232 min-public-methods=2
    233 
    234 # Maximum number of public methods for a class (see R0904).
    235 max-public-methods=20
    236 
    237 
    238 [IMPORTS]
    239 
    240 # Deprecated modules which should not be used, separated by a comma
    241 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
    242 
    243 # Create a graph of every (i.e. internal and external) dependencies in the
    244 # given file (report RP0402 must not be disabled)
    245 import-graph=
    246 
    247 # Create a graph of external dependencies in the given file (report RP0402 must
    248 # not be disabled)
    249 ext-import-graph=
    250 
    251 # Create a graph of internal dependencies in the given file (report RP0402 must
    252 # not be disabled)
    253 int-import-graph=
    254