Fix misleading comments.
[tor-bridgedb.git] / .pylintrc
blob8bf60a05b1671eaca59553f8ea44d1b9ae1ecab7
1 [MASTER]
3 # Specify a configuration file.
4 #rcfile=./.pylintrc
6 # Python code to execute, usually for sys.path manipulation such as
7 # pygtk.require().
8 #init-hook='import sys,os; venv = os.environ.get("VIRTUAL_ENV"); v = os.path.join(venv, "lib", "python" + str(sys.version_info.major) + "." + str(sys.version_info.micro), "site-packages") if venv is not None else None; sys.path.insert(0, v);'
9 init-hook="import sys,os;a=os.getcwd();print a;sys.path.insert(0, a));"
11 # Profiled execution.
12 profile=no
14 # Add files or directories to the blacklist. They should be base names, not
15 # paths.
16 ignore=CVS,test,templates
18 # Pickle collected data for later comparisons.
19 persistent=yes
21 # List of plugins (as comma separated values of python modules names) to load,
22 # usually to register additional checkers.
23 load-plugins=
26 [MESSAGES CONTROL]
28 # Enable the message, report, category or checker with the given id(s). You can
29 # either give multiple identifier separated by comma (,) or put this option
30 # multiple time. See also the "--disable" option for examples.
31 #enable=
33 # Disable the message, report, category or checker with the given id(s). You
34 # can either give multiple identifiers separated by comma (,) or put this
35 # option multiple times (only on the command line, not in the configuration
36 # file where it should appear only once).You can also use "--disable=all" to
37 # disable everything first and then reenable specific checks. For example, if
38 # you want to run only the similarities checker, you can use "--disable=all
39 # --enable=similarities". If you want to run only the classes checker, but have
40 # no Warning level messages displayed, use"--disable=all --enable=classes
41 # --disable=W"
42 disable=W1201,W1401,F0401
45 [REPORTS]
47 # Set the output format. Available formats are text, parseable, colorized, msvs
48 # (visual studio) and html. You can also give a reporter class, eg
49 # mypackage.mymodule.MyReporterClass.
50 output-format=text
52 # Include message's id in output
53 include-ids=yes
55 # Put messages in a separate file for each module / package specified on the
56 # command line instead of printing them on stdout. Reports (if any) will be
57 # written in a file name "pylint_global.[txt|html]".
58 files-output=no
60 # Tells whether to display a full report or only the messages
61 reports=yes
63 # Python expression which should return a note less than 10 (10 is the highest
64 # note). You have access to the variables errors warning, statement which
65 # respectively contain the number of errors / warnings messages and the total
66 # number of statements analyzed. This is used by the global evaluation report
67 # (RP0004).
68 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
70 # Add a comment according to your evaluation note. This is used by the global
71 # evaluation report (RP0004).
72 comment=no
74 # Template used to display messages. This is a python new-style format string
75 # used to format the message information. See doc for all details
76 #msg-template=
79 [SIMILARITIES]
81 # Minimum lines number of a similarity.
82 min-similarity-lines=4
84 # Ignore comments when computing similarities.
85 ignore-comments=yes
87 # Ignore docstrings when computing similarities.
88 ignore-docstrings=yes
90 # Ignore imports when computing similarities.
91 ignore-imports=no
94 [LOGGING]
96 # Logging modules to check that the string format arguments are in logging
97 # function parameter format
98 logging-modules=logging
101 [FORMAT]
103 # Maximum number of characters on a single line.
104 max-line-length=79
106 # Regexp for a line that is allowed to be longer than the limit.
107 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
109 # Allow the body of an if to be on the same line as the test if there is no
110 # else.
111 single-line-if-stmt=yes
113 # List of optional constructs for which whitespace checking is disabled
114 no-space-check=trailing-comma,dict-separator
116 # Maximum number of lines in a module
117 max-module-lines=1500
119 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
120 # tab).
121 indent-string='    '
123 # Number of spaces of indent required inside a hanging or continued line.
124 indent-after-paren=4
127 [BASIC]
129 # Required attributes for module, separated by a comma
130 required-attributes=
132 # List of builtins function names that should not be used, separated by a comma
133 bad-functions=filter,apply,input
135 # Good variable names which should always be accepted, separated by a comma
136 good-names=i,j,k,ex,Run,_,err,exc,func,fn,fh
138 # Bad variable names which should always be refused, separated by a comma
139 bad-names=foo,bar,baz,toto,tutu,tata
141 # Colon-delimited sets of names that determine each other's naming style when
142 # the name regexes allow several styles.
143 name-group=
145 # Include a hint for the correct naming format with invalid-name
146 include-naming-hint=no
148 # Regular expression matching correct function names
149 function-rgx=[a-z_][a-zA-Z0-9_]{1,30}$
151 # Naming hint for function names
152 function-name-hint=[a-z_][a-z0-9_]{2,30}$
154 # Regular expression matching correct variable names
155 variable-rgx=[a-z_][a-zA-Z0-9_]{1,30}$
157 # Naming hint for variable names
158 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
160 # Regular expression matching correct constant names
161 const-rgx=(([a-zA-Z0-9_]*)|(__.*__))$
163 # Naming hint for constant names
164 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
166 # Regular expression matching correct attribute names
167 attr-rgx=[a-z_][a-zA-Z0-9_]{1,30}$
169 # Naming hint for attribute names
170 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
172 # Regular expression matching correct argument names
173 argument-rgx=[a-z_][a-zA-Z0-9_]{1,30}$
175 # Naming hint for argument names
176 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
178 # Regular expression matching correct class attribute names
179 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
181 # Naming hint for class attribute names
182 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
184 # Regular expression matching correct inline iteration names
185 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
187 # Naming hint for inline iteration names
188 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
190 # Regular expression matching correct class names
191 class-rgx=[A-Z_][a-zA-Z0-9]+$
193 # Naming hint for class names
194 class-name-hint=[A-Z_][a-zA-Z0-9]+$
196 # Regular expression matching correct module names
197 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
199 # Naming hint for module names
200 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
202 # Regular expression matching correct method names
203 method-rgx=[a-z_][a-zA-Z0-9_]{1,30}$
205 # Naming hint for method names
206 method-name-hint=[a-z_][a-z0-9_]{2,30}$
208 # Regular expression which should only match function or class names that do
209 # not require a docstring.
210 no-docstring-rgx=__.*__
212 # Minimum line length for functions/classes that require docstrings, shorter
213 # ones are exempt.
214 docstring-min-length=-1
217 [TYPECHECK]
219 # Tells whether missing members accessed in mixin class should be ignored. A
220 # mixin class is detected if its name ends with "mixin" (case insensitive).
221 ignore-mixin-members=yes
223 # List of module names for which member attributes should not be checked
224 # (useful for modules/projects where namespaces are manipulated during runtime
225 # and thus extisting member attributes cannot be deduced by static analysis
226 ignored-modules=twisted.internet.reactor
228 # List of classes names for which member attributes should not be checked
229 # (useful for classes with attributes dynamically set).
230 ignored-classes=SQLObject
232 # When zope mode is activated, add a predefined set of Zope acquired attributes
233 # to generated-members.
234 zope=yes
236 # List of members which are set dynamically and missed by pylint inference
237 # system, and so shouldn't trigger E0201 when accessed. Python regular
238 # expressions are accepted.
239 generated-members=REQUEST,acl_users,aq_parent
242 [VARIABLES]
244 # Tells whether we should check for unused import in __init__ files.
245 init-import=yes
247 # A regular expression matching the name of dummy variables (i.e. expectedly
248 # not used).
249 dummy-variables-rgx=_|dummy
251 # List of additional names supposed to be defined in builtins. Remember that
252 # you should avoid to define new builtins when possible.
253 additional-builtins=
256 [MISCELLANEOUS]
258 # List of note tags to take in consideration, separated by a comma.
259 notes=FIXME,XXX,DOC
262 [CLASSES]
264 # List of interface methods to ignore, separated by a comma. This is used for
265 # instance to not check methods defines in Zope's Interface base class.
266 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
268 # List of method names used to declare (i.e. assign) instance attributes.
269 defining-attr-methods=__init__,__new__,setUp
271 # List of valid names for the first argument in a class method.
272 valid-classmethod-first-arg=cls
274 # List of valid names for the first argument in a metaclass class method.
275 valid-metaclass-classmethod-first-arg=mcs
278 [IMPORTS]
280 # Deprecated modules which should not be used, separated by a comma
281 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec,sha
283 # Create a graph of every (i.e. internal and external) dependencies in the
284 # given file (report RP0402 must not be disabled)
285 import-graph=
287 # Create a graph of external dependencies in the given file (report RP0402 must
288 # not be disabled)
289 ext-import-graph=
291 # Create a graph of internal dependencies in the given file (report RP0402 must
292 # not be disabled)
293 int-import-graph=
296 [DESIGN]
298 # Maximum number of arguments for function / method
299 max-args=9
301 # Argument names that match this expression will be ignored. Default to name
302 # with leading underscore
303 ignored-argument-names=_.*
305 # Maximum number of locals for function / method body
306 max-locals=15
308 # Maximum number of return / yield for function / method body
309 max-returns=6
311 # Maximum number of branch for function / method body
312 max-branches=12
314 # Maximum number of statements in function / method body
315 max-statements=50
317 # Maximum number of parents for a class (see R0901).
318 max-parents=7
320 # Maximum number of attributes for a class (see R0902).
321 max-attributes=7
323 # Minimum number of public methods for a class (see R0903).
324 min-public-methods=2
326 # Maximum number of public methods for a class (see R0904).
327 max-public-methods=20
330 [EXCEPTIONS]
332 # Exceptions that will emit a warning when being caught. Defaults to
333 # "Exception"
334 overgeneral-exceptions=Exception