Debian Codegraph @

doc/misc/pylintrc

raw
1 # PyLint configuration file for the project nibabel.
2 #
3 # This pylintrc file will use the default settings except for the
4 # naming conventions, which will allow for camel case naming as found
5 # in Java code or several libraries such as PyQt, etc.
6 #
7 # At some moment it was modified by yoh from the original one
8 # which can be found on debian systems at
9 # /usr/share/doc/pylint/examples/pylintrc_camelcase
10 #
11 # Just place it in ~/.pylintrc for user-wide installation or simply
12 # use within a call to pylint or export environment variable
13 # export PYLINTRC=$PWD/doc/misc/pylintrc
14
15
16 [BASIC]
17 # Regular expression which should only match correct module names
18 module-rgx=([a-z][a-z0-9_]*)$
19
20 attr-rgx=[a-z_][a-z0-9_]{,30}
21
22 # Regular expression which should only match correct class names
23 class-rgx=[A-Z_]+[a-zA-Z0-9]+$
24
25 # Regular expression which should only match correct function names
26 function-rgx=[a-z_]+[a-z0-9_][a-z0-9]*$
27
28 # Regular expression which should only match correct method names
29 method-rgx=(([a-z_]|__)[a-z0-9_]*(__)?|test[a-zA-Z0-9_]*)$
30
31 # Regular expression which should only match correct argument names
32 argument-rgx=[a-z][a-z0-9]*_*[a-z0-9]*_*[a-z0-9]*_?$
33
34 # Regular expression which should only match correct variable names
35 variable-rgx=([a-z_]+[a-z0-9]*_*[a-z0-9]*_*[a-z0-9]*_?||(__[a-zA-Z0-9_]*__))$||[A-Z]+
36
37 # Regular expression which should only match correct module level names
38 # Default: (([A-Z_][A-Z1-9_]*)|(__.*__))$
39 const-rgx=([a-z_]+[a-z0-9]*_*[a-z0-9]*_*[a-z0-9]*_?|__[a-zA-Z0-9_]*__)$||[A-Z]+
40
41
42 [FORMAT]
43 indent-string=' '
44
45
46 [DESIGN]
47
48 # We are capable to follow that many, yes!
49 max-branchs = 20
50
51 # some base class constructors have quite a few arguments
52 max-args = 14
53
54 # and due to ClassWithCollections and conditional attributes classes by default have lots
55 # of attributes
56 max-attributes = 14
57
58 # some sci computation can't be handled efficiently without having
59 #lots of locals
60 max-locals = 35
61
62 [MESSAGES CONTROL]
63 # Disable the following PyLint messages:
64 # R0903 - Not enough public methods
65 # W0105 - String statement has no effect # often used for after-line doc
66 # W0142 - Used * or ** magic
67 # W0232 - Class has no __init__ method
68 # W0212 - Access to a protected member ... of a client class
69 # W0613 - Unused argument
70 # E1101 - Has no member (countless false-positives)
71 disable-msg=R0903,W0142,W0105,W0212,W0613,E1101
72
73 [REPORTS]
74
75 # set the output format. Available formats are text, parseable, colorized and
76 # html
77 output-format=colorized
78
79 # Include message's id in output
80 include-ids=yes
81
82 # Tells whether to display a full report or only the messages
83 reports=yes
84
85 [MISCELLANEOUS]
86
87 # List of note tags to take in consideration, separated by a comma.
88 # FIXME -- something which needs fixing
89 # TODO -- future plan
90 # XXX -- some concern
91 # YYY -- comment/answer to above mentioned concern
92 notes=FIXME,TODO,XXX,YYY