xref: /aosp_15_r20/external/grpc-grpc/.pylintrc (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1*cc02d7e2SAndroid Build Coastguard Worker[MASTER]
2*cc02d7e2SAndroid Build Coastguard Workerignore=
3*cc02d7e2SAndroid Build Coastguard Worker	src/python/grpcio/grpc/beta,
4*cc02d7e2SAndroid Build Coastguard Worker	src/python/grpcio/grpc/framework,
5*cc02d7e2SAndroid Build Coastguard Worker	src/python/grpcio/grpc/framework/common,
6*cc02d7e2SAndroid Build Coastguard Worker	src/python/grpcio/grpc/framework/foundation,
7*cc02d7e2SAndroid Build Coastguard Worker	src/python/grpcio/grpc/framework/interfaces,
8*cc02d7e2SAndroid Build Coastguard Worker
9*cc02d7e2SAndroid Build Coastguard Workerextension-pkg-whitelist=grpc._cython.cygrpc
10*cc02d7e2SAndroid Build Coastguard Worker
11*cc02d7e2SAndroid Build Coastguard Worker[VARIABLES]
12*cc02d7e2SAndroid Build Coastguard Worker
13*cc02d7e2SAndroid Build Coastguard Worker# TODO(https://github.com/PyCQA/pylint/issues/1345): How does the inspection
14*cc02d7e2SAndroid Build Coastguard Worker# not include "unused_" and "ignored_" by default?
15*cc02d7e2SAndroid Build Coastguard Workerdummy-variables-rgx=^ignored_|^unused_|_
16*cc02d7e2SAndroid Build Coastguard Worker
17*cc02d7e2SAndroid Build Coastguard Worker[DESIGN]
18*cc02d7e2SAndroid Build Coastguard Worker
19*cc02d7e2SAndroid Build Coastguard Worker# NOTE(nathaniel): Not particularly attached to this value; it just seems to
20*cc02d7e2SAndroid Build Coastguard Worker# be what works for us at the moment (excepting the dead-code-walking Beta
21*cc02d7e2SAndroid Build Coastguard Worker# API).
22*cc02d7e2SAndroid Build Coastguard Workermax-args=14
23*cc02d7e2SAndroid Build Coastguard Workermax-parents=8
24*cc02d7e2SAndroid Build Coastguard Worker
25*cc02d7e2SAndroid Build Coastguard Worker[MISCELLANEOUS]
26*cc02d7e2SAndroid Build Coastguard Worker
27*cc02d7e2SAndroid Build Coastguard Worker# NOTE(nathaniel): We are big fans of "TODO(<issue link>): " and
28*cc02d7e2SAndroid Build Coastguard Worker# "NOTE(<username or issue link>): ". We do not allow "TODO:",
29*cc02d7e2SAndroid Build Coastguard Worker# "TODO(<username>):", "FIXME:", or anything else.
30*cc02d7e2SAndroid Build Coastguard Workernotes=FIXME,XXX
31*cc02d7e2SAndroid Build Coastguard Worker
32*cc02d7e2SAndroid Build Coastguard Worker[MESSAGES CONTROL]
33*cc02d7e2SAndroid Build Coastguard Worker
34*cc02d7e2SAndroid Build Coastguard Workerdisable=
35*cc02d7e2SAndroid Build Coastguard Worker	# TODO(https://github.com/PyCQA/pylint/issues/59#issuecomment-283774279):
36*cc02d7e2SAndroid Build Coastguard Worker	# Enable cyclic-import after a 1.7-or-later pylint release that
37*cc02d7e2SAndroid Build Coastguard Worker	# recognizes our disable=cyclic-import suppressions.
38*cc02d7e2SAndroid Build Coastguard Worker	cyclic-import,
39*cc02d7e2SAndroid Build Coastguard Worker	# TODO(https://github.com/grpc/grpc/issues/8622): Enable this after the
40*cc02d7e2SAndroid Build Coastguard Worker	# Beta API is removed.
41*cc02d7e2SAndroid Build Coastguard Worker	duplicate-code,
42*cc02d7e2SAndroid Build Coastguard Worker	# TODO(https://github.com/grpc/grpc/issues/261): Doesn't seem to
43*cc02d7e2SAndroid Build Coastguard Worker	# understand enum and concurrent.futures; look into this later with the
44*cc02d7e2SAndroid Build Coastguard Worker	# latest pylint version.
45*cc02d7e2SAndroid Build Coastguard Worker	import-error,
46*cc02d7e2SAndroid Build Coastguard Worker	# TODO(https://github.com/grpc/grpc/issues/261): Enable this one.
47*cc02d7e2SAndroid Build Coastguard Worker	# Should take a little configuration but not much.
48*cc02d7e2SAndroid Build Coastguard Worker	invalid-name,
49*cc02d7e2SAndroid Build Coastguard Worker	# TODO(https://github.com/grpc/grpc/issues/261): This doesn't seem to
50*cc02d7e2SAndroid Build Coastguard Worker	# work for now? Try with a later pylint?
51*cc02d7e2SAndroid Build Coastguard Worker	locally-disabled,
52*cc02d7e2SAndroid Build Coastguard Worker	# NOTE(nathaniel): What even is this? *Enabling* an inspection results
53*cc02d7e2SAndroid Build Coastguard Worker	# in a warning? How does that encourage more analysis and coverage?
54*cc02d7e2SAndroid Build Coastguard Worker	locally-enabled,
55*cc02d7e2SAndroid Build Coastguard Worker	# NOTE(nathaniel): We don't write doc strings for most private code
56*cc02d7e2SAndroid Build Coastguard Worker	# elements.
57*cc02d7e2SAndroid Build Coastguard Worker	missing-docstring,
58*cc02d7e2SAndroid Build Coastguard Worker	# NOTE(nathaniel): In numeric comparisons it is better to have the
59*cc02d7e2SAndroid Build Coastguard Worker	# lesser (or lesser-or-equal-to) quantity on the left when the
60*cc02d7e2SAndroid Build Coastguard Worker	# expression is true than it is to worry about which is an identifier
61*cc02d7e2SAndroid Build Coastguard Worker	# and which a literal value.
62*cc02d7e2SAndroid Build Coastguard Worker	misplaced-comparison-constant,
63*cc02d7e2SAndroid Build Coastguard Worker	# NOTE(nathaniel): Our completely abstract interface classes don't have
64*cc02d7e2SAndroid Build Coastguard Worker	# constructors.
65*cc02d7e2SAndroid Build Coastguard Worker	no-init,
66*cc02d7e2SAndroid Build Coastguard Worker	# TODO(https://github.com/grpc/grpc/issues/261): Doesn't yet play
67*cc02d7e2SAndroid Build Coastguard Worker	# nicely with some of our code being implemented in Cython. Maybe in a
68*cc02d7e2SAndroid Build Coastguard Worker	# later version?
69*cc02d7e2SAndroid Build Coastguard Worker	no-name-in-module,
70*cc02d7e2SAndroid Build Coastguard Worker	# TODO(https://github.com/grpc/grpc/issues/261): Suppress these where
71*cc02d7e2SAndroid Build Coastguard Worker	# the odd shape of the authentication portion of the API forces them on
72*cc02d7e2SAndroid Build Coastguard Worker	# us and enable everywhere else.
73*cc02d7e2SAndroid Build Coastguard Worker	protected-access,
74*cc02d7e2SAndroid Build Coastguard Worker	# NOTE(nathaniel): Pylint and I will probably never agree on this.
75*cc02d7e2SAndroid Build Coastguard Worker	too-few-public-methods,
76*cc02d7e2SAndroid Build Coastguard Worker	# NOTE(nathaniel): Pylint and I wil probably never agree on this for
77*cc02d7e2SAndroid Build Coastguard Worker	# private classes. For public classes maybe?
78*cc02d7e2SAndroid Build Coastguard Worker	too-many-instance-attributes,
79*cc02d7e2SAndroid Build Coastguard Worker	# NOTE(nathaniel): Some of our modules have a lot of lines... of
80*cc02d7e2SAndroid Build Coastguard Worker	# specification and documentation. Maybe if this were
81*cc02d7e2SAndroid Build Coastguard Worker	# lines-of-code-based we would use it.
82*cc02d7e2SAndroid Build Coastguard Worker	too-many-lines,
83*cc02d7e2SAndroid Build Coastguard Worker	# TODO(https://github.com/grpc/grpc/issues/261): Maybe we could have
84*cc02d7e2SAndroid Build Coastguard Worker	# this one if we extracted just a few more helper functions...
85*cc02d7e2SAndroid Build Coastguard Worker	too-many-nested-blocks,
86*cc02d7e2SAndroid Build Coastguard Worker	# TODO(https://github.com/grpc/grpc/issues/261): Disable unnecessary
87*cc02d7e2SAndroid Build Coastguard Worker	# super-init requirement for abstract class implementations for now.
88*cc02d7e2SAndroid Build Coastguard Worker	super-init-not-called,
89*cc02d7e2SAndroid Build Coastguard Worker	# NOTE(nathaniel): A single statement that always returns program
90*cc02d7e2SAndroid Build Coastguard Worker	# control is better than two statements the first of which sometimes
91*cc02d7e2SAndroid Build Coastguard Worker	# returns program control and the second of which always returns
92*cc02d7e2SAndroid Build Coastguard Worker	# program control. Probably generally, but definitely in the cases of
93*cc02d7e2SAndroid Build Coastguard Worker	# if:/else: and for:/else:.
94*cc02d7e2SAndroid Build Coastguard Worker	useless-else-on-loop,
95*cc02d7e2SAndroid Build Coastguard Worker	no-else-return,
96*cc02d7e2SAndroid Build Coastguard Worker	# NOTE(lidiz): Python 3 make object inheritance default, but not PY2
97*cc02d7e2SAndroid Build Coastguard Worker	useless-object-inheritance,
98*cc02d7e2SAndroid Build Coastguard Worker	# NOTE(lidiz): the import order will be enforced by isort instead
99*cc02d7e2SAndroid Build Coastguard Worker	wrong-import-order,
100*cc02d7e2SAndroid Build Coastguard Worker	# TODO(https://github.com/PyCQA/pylint/issues/3882): Upgrade Pylint
101*cc02d7e2SAndroid Build Coastguard Worker	unsubscriptable-object,
102*cc02d7e2SAndroid Build Coastguard Worker  # NOTE(sergiitk): yapf compatibility, ref #25071
103*cc02d7e2SAndroid Build Coastguard Worker  bad-continuation,
104