Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 53f69bf

Browse files
committed
Added pylint config file: ignore missing-docstring messages.
1 parent 9e57ed2 commit 53f69bf

File tree

1 file changed

+280
-0
lines changed

1 file changed

+280
-0
lines changed

pylint.cfg

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

0 commit comments

Comments
 (0)