Search pylint configuration in setup.cfg and pyproject.toml

[pylint-bot]

Originally reported by: Fabio C. Barrionuevo da Luz (BitBucket: luzfcb, GitHub: @luzfcb?)

---

It would be great if pylint also seek the settings in a special section in setup.cfg file.

the same reasons as described by @bittner in
https://bitbucket.org/logilab/pylint/issues/121/search-pylintrc-in-config-directory#comment-13136390

---

• Bitbucket: https://bitbucket.org/logilab/pylint/issue/617

[pylint-bot]

Original comment by Claudiu Popa (BitBucket: PCManticore, GitHub: @PCManticore):

---

Why? This would complicate the configuration parsing and requires a lot of work to accommodate the internal implementation for little benefit. It will be yet another way to look for the configuration options, which increases the maintenance burden. And it will not be obvious where pylint will look first, in the setup.cfg or in pylintrc.

[pylint-bot]

Original comment by Fabio C. Barrionuevo da Luz (BitBucket: luzfcb, GitHub: @luzfcb?):

---

if the "pylintrc" file exist, stop search and get settings .

if the "pylintrc" file does not exist, verify that "setup.cfg" file exists.

If "setup.cfg" exist, get the settings.

if "pylintrc" file and "setup.cfg" exist, ignore "setup.cfg"

to make obvious what order the pylint use, just enter in the documentation something like:

pylint seeks the configuration file in the following order:

1 - project_dir/pylintrc
2 - project_dir/setup.cfg 
3 - ~/.pylintrc
4 - foo another location

[pylint-bot]

Original comment by Peter Bittner (BitBucket: bittner, GitHub: @bittner?):

---

JFYI, I had prepared pull request #276 to implement those changes. It was rejected, though.

[matrixik]

https://github.com/python/mypy added support for setup.cfg in python/mypy#2761

[sobolevn]

setup.cfg should be the default place to configure things.

[NeilGirdhar]

@PCManticore It might be good to take a look at this again if you haven't recently.

[PCManticore]

If pylint should support an additional format, that should be pyproject.toml not setup.cfg. setup.cfg doesn't seem to support nested sections, as our INI structure does, unless I'm missing something.

[sobolevn]

@PCManticore it is possible via something like this:

[pytest]
general_options = ...

[pytest.messages]
messages = ...

But supporting pyproject.toml is a good thing too.

[PCManticore]

If that's the case then, I don't mind supporting setup.cfg and pyproject.toml.

[pradyunsg]

@PCManticore Could you update the issue title to reflect the current plan moving forward?

[flying-sheep]

@PCManticore should we file a new issue for pyproject.toml or will you update the title for this one?

[PCManticore]

@flying-sheep Done! Thanks again for the reminder.

[fgimian]

Huge thanks for supporting this. Just one little thought. Since TOML is more advanced than INI, you could actually support a list of disables for message control like so:

[tool.pylint."messages control"]
disable = [
    "too-many-ancestors",
    "too-many-arguments",
    "too-many-boolean-expressions",
    "too-many-branches",

I believe this would be more elegant than a comma separated list in TOML personally. What do you think?

It may also be worth replacing underscores with spaces in section headings so we could do this:

[tool.pylint.messages_control]
disable = [
    "too-many-ancestors",
    "too-many-arguments",
    "too-many-boolean-expressions",
    "too-many-branches",

Huge love
Fotis

[laike9m]

Huge thanks for supporting this. Just one little thought. Since TOML is more advanced than INI, you could actually support a list of disables for message control like so:

[tool.pylint."messages control"]
disable = [
    "too-many-ancestors",
    "too-many-arguments",
    "too-many-boolean-expressions",
    "too-many-branches",

I believe this would be more elegant than a comma separated list in TOML personally. What do you think?

It may also be worth replacing underscores with spaces in section headings so we could do this:

[tool.pylint.messages_control]
disable = [
    "too-many-ancestors",
    "too-many-arguments",
    "too-many-boolean-expressions",
    "too-many-branches",

Huge love
Fotis

@fgimian It seems the list version does not work, but this does
I misunderstand your comment. Yes, I think the list form should be supported.

After some trials and errors, I found this works

[tool.pylint.messages_control]
disable = "bad-continuation"

This also works

[tool.pylint.'MESSAGES CONTROL']
disable = "bad-continuation"

[impredicative]

Does anyone have a decent working example of pylint configuration in pyproject.toml and/or setup.cfg, or does everyone have to trial-and-error their way around it?

Also, why was support for this implemented without an option for --generate-rcfile to generate a sample config in the above formats?

[laike9m]

@impredicative https://github.com/laike9m/Cyberbrain/blob/master/pyproject.toml#L41-L45
Took me quite a while to figure out.

[AWhetter]

Also, why was support for this implemented without an option for --generate-rcfile to generate a sample config in the above formats?

This is a good suggestion! Feel free to make a separate issue for it.

[HitLuca]

It seems that pylint correctly parses the [tool.pylint.messages_control] section from setup.cfg, but fails to also parse [tool.pylint.logging] and [tool.pylint.master]

[HitLuca]

@laike9m please make sure that if you are using this structure for your entries in pyproject.toml

disable = """,
    bad-continuation,
    wrong-import-position,
    invalid-name,
    line-too-long,
    too-few-public-methods,
    import-outside-toplevel,
    logging-format-interpolation,
    """

you add a comma after the first three double quotes, otherwise the first message won't be disabled. Similarly, add a comma after the last message for the same reason

[K3UL]

For anyone looking for examples with pyproject.toml, here is a suggestion ; it is simple but took me a minute before thinking of it :
https://github.com/search?l=TOML&q="tool.pylint"&type=Code

[alexchandel]

pylint fails to find init-hook in setup.cfg.

[su1hang2]

for others looking for how to include an init-hook in setup.cfg: it worked after I took out the quotes around the command, e.g. in my case it was

[pylint.master]
init-hook = import sys; sys.path.append("/your/path/here");

[fgimian]

I'm not sure when this happened, but pylint now seems to support lists in message_control. Here's an excerpt of my pyproject.toml if it helps anyone.

[tool.pylint.basic]
# Allow shorter and longer variable names than the default.
argument-rgx = "[a-z_][a-z0-9_]*$"
attr-rgx = "[a-z_][a-z0-9_]*$"
variable-rgx = "[a-z_][a-z0-9_]*$"

# Ensure that orjson is analysed as a C extension by pylint.
extension-pkg-whitelist = "orjson"

[tool.pylint.messages_control]
disable = [
    # Disable too many and too few checks.
    "too-many-ancestors",
    "too-many-arguments",
    "too-many-boolean-expressions",
    "too-many-branches",
    "too-many-function-args",
    "too-many-instance-attributes",
    "too-many-lines",
    "too-many-locals",
    "too-many-nested-blocks",
    "too-many-public-methods",
    "too-many-return-statements",
    "too-many-statements",
    "too-few-public-methods",

    # Similar lines in files (often the case in tests).
    "duplicate-code",

    # Many functions (e.g. callbacks) will naturally have unused arguments.
    "unused-argument",

    # Disable checking that method could be a function in classes (often used for organisation).
    "no-self-use",

    # Disable failure for TODO items in the codebase (code will always have TODOs).
    "fixme",

    # Disable docstrings checks as we don't require excessive documentation.
    "missing-docstring"
]

[tool.pylint.format]
# Maximum number of characters on a single line.
max-line-length = 99

And yup, I find the defaults in pylint too noisy 😄