Skip to content
Snippets Groups Projects
Commit 9104884a authored by Nathaniel Manista's avatar Nathaniel Manista
Browse files

Clean up and opinionate .pylintrc

parent 6613f601
No related branches found
No related tags found
No related merge requests found
[VARIABLES] [VARIABLES]
# TODO(https://github.com/PyCQA/pylint/issues/1345): How does the inspection # TODO(https://github.com/PyCQA/pylint/issues/1345): How does the inspection
# not include "unused_" and "ignored_" by default? # not include "unused_" and "ignored_" by default?
dummy-variables-rgx=^ignored_|^unused_ dummy-variables-rgx=^ignored_|^unused_
[DESIGN] [DESIGN]
# NOTE(nathaniel): Not particularly attached to this value; it just seems to # NOTE(nathaniel): Not particularly attached to this value; it just seems to
# be what works for us at the moment (excepting the dead-code-walking Beta # be what works for us at the moment (excepting the dead-code-walking Beta
# API). # API).
max-args=6 max-args=6
[MISCELLANEOUS] [MISCELLANEOUS]
# NOTE(nathaniel): We are big fans of "TODO(<issue link>): " and # NOTE(nathaniel): We are big fans of "TODO(<issue link>): " and
# "NOTE(<username or issue link>): ". We do not allow "TODO:", # "NOTE(<username or issue link>): ". We do not allow "TODO:",
# "TODO(<username>):", "FIXME:", or anything else. # "TODO(<username>):", "FIXME:", or anything else.
...@@ -17,21 +20,50 @@ notes=FIXME,XXX ...@@ -17,21 +20,50 @@ notes=FIXME,XXX
[MESSAGES CONTROL] [MESSAGES CONTROL]
#TODO: Enable missing-docstring disable=
#TODO: Enable too-few-public-methods # TODO(https://github.com/PyCQA/pylint/issues/59#issuecomment-283774279):
#TODO: Enable no-init # Enable cyclic-import after a 1.7-or-later pylint release that
#TODO: Enable duplicate-code # recognizes our disable=cyclic-import suppressions.
#TODO: Enable invalid-name cyclic-import,
#TODO: Enable locally-disabled # TODO(https://github.com/grpc/grpc/issues/8622): Enable this after the
#TODO: Enable protected-access # Beta API is removed.
#TODO: Enable no-name-in-module duplicate-code,
# TODO(https://github.com/PyCQA/pylint/issues/59#issuecomment-283774279): # TODO(https://github.com/grpc/grpc/issues/261): Doesn't seem to
# enable cyclic-import after a 1.7-or-later pylint release that recognizes our # understand enum and concurrent.futures; look into this later with the
# disable=cyclic-import suppressions. # latest pylint version.
#TODO: Enable too-many-instance-attributes import-error,
#TODO: Enable too-many-lines # TODO(https://github.com/grpc/grpc/issues/261): Enable this one.
#TODO: Enable import-error # Should take a little configuration but not much.
#TODO: Enable useless-else-on-loop invalid-name,
#TODO: Enable too-many-nested-blocks # TODO(https://github.com/grpc/grpc/issues/261): This doesn't seem to
# work for now? Try with a later pylint?
disable=missing-docstring,too-few-public-methods,no-init,duplicate-code,invalid-name,locally-disabled,protected-access,no-name-in-module,cyclic-import,too-many-instance-attributes,too-many-lines,import-error,useless-else-on-loop,too-many-nested-blocks locally-disabled,
# NOTE(nathaniel): We don't write doc strings for most private code
# elements.
missing-docstring,
# NOTE(nathaniel): Our completely abstract interface classes don't have
# constructors.
no-init,
# TODO(https://github.com/grpc/grpc/issues/261): Doesn't yet play
# nicely with some of our code being implemented in Cython. Maybe in a
# later version?
no-name-in-module,
# TODO(https://github.com/grpc/grpc/issues/261): Suppress these where
# the odd shape of the authentication portion of the API forces them on
# us and enable everywhere else.
protected-access,
# NOTE(nathaniel): Pylint and I will probably never agree on this.
too-few-public-methods,
# NOTE(nathaniel): Pylint and I wil probably never agree on this for
# private classes. For public classes maybe?
too-many-instance-attributes,
# NOTE(nathaniel): Some of our modules have a lot of lines... of
# specification and documentation. Maybe if this were
# lines-of-code-based we would use it.
too-many-lines,
# TODO(https://github.com/grpc/grpc/issues/261): Maybe we could have
# this one if we extracted just a few more helper functions...
too-many-nested-blocks,
# NOTE(nathaniel): I have disputed the premise of this inspection from
# the beginning and will continue to do so until it goes away for good.
useless-else-on-loop,
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment