[DOC] Fix doc-rules build
[oom.git] / .pylintrc
1 # Copyright © 2021 Orange
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
16 [MASTER]
17 # Specify a score threshold to be exceeded before program exits with error.
18 fail-under=3.43
19
20 [MESSAGES CONTROL]
21 # Disable the message, report, category or checker with the given id(s). You
22 # can either give multiple identifiers separated by comma (,) or put this
23 # option multiple times (only on the command line, not in the configuration
24 # file where it should appear only once). You can also use "--disable=all" to
25 # disable everything first and then reenable specific checks. For example, if
26 # you want to run only the similarities checker, you can use "--disable=all
27 # --enable=similarities". If you want to run only the classes checker, but have
28 # no Warning level messages displayed, use "--disable=all --enable=classes
29 # --disable=W".
30 disable=raw-checker-failed,
31         bad-inline-option,
32         locally-disabled,
33         file-ignored,
34         suppressed-message,
35         useless-suppression,
36         deprecated-pragma,
37         use-symbolic-message-instead,
38         missing-docstring
39
40
41 [REPORTS]
42 # Set the output format. Available formats are text, parseable, colorized, json
43 # and msvs (visual studio). You can also give a reporter class, e.g.
44 # mypackage.mymodule.MyReporterClass.
45 output-format=colorized
46
47 # Tells whether to display a full report or only the messages.
48 reports=yes
49
50 # Activate the evaluation score.
51 score=yes
52
53 [FORMAT]
54 # Maximum number of characters on a single line.
55 max-line-length=120
56
57 [BASIC]
58
59 # Regular expression matching correct method names. Overrides method-naming-
60 # style.
61 method-rgx="(([a-z_][a-zA-Z0-9_]{2,})|(_[a-z0-9_]*)|(__[a-zA-Z][a-zA-Z0-9_]+__))$"
62
63 # Regular expression matching correct variable names. Overrides variable-
64 # naming-style.
65 variable-rgx="[a-zA-Z_][a-zA-Z0-9_]{1,30}$"
66