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