Add `tox.ini` to the default discovered config files (right after setup.cfg) #9728

mbyrnepr2 · 2024-06-12T14:04:03Z

Type of Changes

	Type
✓	🐛 Bug fix
	✨ New feature
	🔨 Refactoring
	📜 Docs

Description

Fix a bug where a tox.ini file with pylint configuration was ignored and it exists in the current directory.

Closes #9727

…red and it exists in the current directory. Closes pylint-dev#9727

for more information, see https://pre-commit.ci

codecov · 2024-06-12T14:15:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.85%. Comparing base (2ba88b9) to head (e0a456d).
Report is 131 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #9728   +/-   ##
=======================================
  Coverage   95.85%   95.85%           
=======================================
  Files         174      174           
  Lines       18873    18873           
=======================================
  Hits        18090    18090           
  Misses        783      783

Files with missing lines	Coverage Δ
pylint/config/find_default_config_files.py	`91.30% <100.00%> (ø)`

... and 2 files with indirect coverage changes

DanielNoord · 2024-06-12T14:59:08Z

pylint/config/find_default_config_files.py

@@ -22,7 +22,8 @@
    Path(".pylintrc.toml"),
 )
 PYPROJECT_NAME = Path("pyproject.toml")
-CONFIG_NAMES = (*RC_NAMES, PYPROJECT_NAME, Path("setup.cfg"))
+TOX_NAME = Path("tox.ini")


Why make this a constant? Can't it be like setup.cfg?

Thanks @DanielNoord. Agreed.
While I have your attention, what's your opinion on this logic and the associated comments around the inconsistencies mentioned on the issue? It does feel like we should allow [pylint] and not necessarily [pylint.something] but there could be some rationale for that.

Our own documentation has this: setup.cfg in the current working directory, providing it has at least one pylint. section

Yes, we previously only allowed pylint. because the way optparse worked required sections. I removed that when migrating to argparse and improving support for toml.

I would support changing this to be 1. exactly "pylint" or 2. anything that starts with "pylint.". To make sure we are not starting to parse "pylint-internal-plugin" etc.

FYI @Pierre-Sassoulas and also may need to wait/further refactor before merging.

Thanks for the ping :) I think anything starting with pylint. is closer to what's happening in pyproject.toml so I would favor that.

In .toml we support [tool.pylint]. I think making .ini in line with this makes sense.

Should we make the tool mandatory ? As in [tool.pylint], or [tool.pylint.main], [tool.pylint.basic] (etc.). We don't in ini file currently, but the ini file is pylint specific so it doesn't need the "pylint" / "tool.pylint" part.

pylint/examples/pylintrc

Line 119 in 2ba88b9

[BASIC]

So maybe [pylint], or [pylint.main], [pylint.basic]. for consistency in tox.ini (consistency with file of the same format above consistency with toml), and backward compatibility in ini ?

tool is a thing because of the pyproject.toml spec I think.

Seeing other tox.ini files I think nobody would be surprised that [pylint] would be parsed as the configuration for pylint. We currently require people to do[pylint.some_section_that_isnt_even_validated] which feels cumbersome and inconsistent. That's why I proposed changing it from only [pylint\..+] to also allow [pylint].

Ok thanks folks! I've tried to match Daniel's vision with the latest commit; accept [pylint] or [pylint.<something_arbitrary>]. Let me know if I've gotten anything wrong!

Pierre-Sassoulas

Just a nit then LGTM. I classified as enhancement because it can make pylint start behaving unexpectedly if a tox.ini is present and this should probably not happen in a patch. (We can release 3.3.0 fast however).

tests/config/test_find_default_config_files.py

Co-authored-by: Pierre Sassoulas <[email protected]>

for more information, see https://pre-commit.ci

Co-authored-by: Pierre Sassoulas <[email protected]>

sections are named `[pylint]` or `[pylint.X]`, where `X` is an arbitrary value.

rlalik · 2024-06-13T09:55:39Z

Hi, original issue reporter here.

Upon request of @mbyrnepr2 in #9727 I tested the PR-version and it works fine for my case for both tox.ini and setup.cfg with proper config files autodetection.

Pierre-Sassoulas

Great 👌

DanielNoord · 2024-06-17T07:07:24Z

doc/whatsnew/fragments/9727.bugfix

@@ -0,0 +1,3 @@
+Fix a bug where a ``tox.ini`` file with pylint configuration was ignored and it exists in the current directory.


We should probably include the change about accepted sections here as well.

DanielNoord · 2024-06-17T07:08:16Z

pylint/config/find_default_config_files.py

@@ -71,7 +74,9 @@ def _yield_default_files() -> Iterator[Path]:
            if config_name.is_file():
                if config_name.suffix == ".toml" and not _toml_has_config(config_name):
                    continue
-                if config_name.suffix == ".cfg" and not _cfg_has_config(config_name):
+                if config_name.suffix in {".cfg", ".ini"} and not _cfg_has_config(


Suggested change

if config_name.suffix in {".cfg", ".ini"} and not _cfg_has_config(

if config_name.suffix in {".cfg", ".ini"} and not _cfg_or_ini_has_config(

configuration section naming for `.cfg` and `.ini` files.

Co-authored-by: Daniël van Noord <[email protected]>

for more information, see https://pre-commit.ci

github-actions · 2024-06-17T14:26:51Z

🤖 According to the primer, this change has no effect on the checked open source code. 🤖🎉

This comment was generated for commit e0a456d

mbyrnepr2 and others added 3 commits June 12, 2024 16:02

Fix a bug where a tox.ini file with pylint configuration was igno…

63ed122

…red and it exists in the current directory. Closes pylint-dev#9727

[pre-commit.ci] auto fixes from pre-commit.com hooks

b8b4444

for more information, see https://pre-commit.ci

Pylint: Use set for membership test.

d5f4bbf

mbyrnepr2 marked this pull request as ready for review June 12, 2024 14:40

DanielNoord reviewed Jun 12, 2024

View reviewed changes

Refactor - no need for constant.

307a4c3

Pierre-Sassoulas added the Enhancement ✨ Improvement to a component label Jun 12, 2024

Pierre-Sassoulas added this to the 3.3.0 milestone Jun 12, 2024

Pierre-Sassoulas reviewed Jun 12, 2024

View reviewed changes

tests/config/test_find_default_config_files.py Outdated Show resolved Hide resolved

tests/config/test_find_default_config_files.py Outdated Show resolved Hide resolved

mbyrnepr2 and others added 4 commits June 12, 2024 21:36

Update tests/config/test_find_default_config_files.py

30850c7

Co-authored-by: Pierre Sassoulas <[email protected]>

[pre-commit.ci] auto fixes from pre-commit.com hooks

64e2c66

for more information, see https://pre-commit.ci

Refactor the test using Pierre's suggestion.

5084f0f

Co-authored-by: Pierre Sassoulas <[email protected]>

Identify Pylint configuration in .ini and .cfg files where the

6aeba71

sections are named `[pylint]` or `[pylint.X]`, where `X` is an arbitrary value.

mbyrnepr2 force-pushed the tox_ini_default_config_file branch from 75580c9 to 6aeba71 Compare June 12, 2024 21:24

Pierre-Sassoulas previously approved these changes Jun 13, 2024

View reviewed changes

DanielNoord reviewed Jun 17, 2024

View reviewed changes

mbyrnepr2 and others added 2 commits June 17, 2024 16:03

Update news fragment to include the enhancement to the Pylint

99195b4

configuration section naming for `.cfg` and `.ini` files.

Rename the function to be more explicit.

9e597be

Co-authored-by: Daniël van Noord <[email protected]>

mbyrnepr2 dismissed Pierre-Sassoulas’s stale review via 9e597be June 17, 2024 14:10

[pre-commit.ci] auto fixes from pre-commit.com hooks

e0a456d

for more information, see https://pre-commit.ci

DanielNoord approved these changes Jun 18, 2024

View reviewed changes

DanielNoord merged commit fc9bdeb into pylint-dev:main Jun 18, 2024
44 checks passed

mbyrnepr2 deleted the tox_ini_default_config_file branch June 18, 2024 07:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `tox.ini` to the default discovered config files (right after setup.cfg) #9728

Add `tox.ini` to the default discovered config files (right after setup.cfg) #9728

mbyrnepr2 commented Jun 12, 2024

codecov bot commented Jun 12, 2024 •

edited

Loading

DanielNoord Jun 12, 2024

mbyrnepr2 Jun 12, 2024 •

edited

Loading

DanielNoord Jun 12, 2024

mbyrnepr2 Jun 12, 2024

Pierre-Sassoulas Jun 12, 2024

DanielNoord Jun 12, 2024

Pierre-Sassoulas Jun 12, 2024

DanielNoord Jun 12, 2024

mbyrnepr2 Jun 12, 2024

Pierre-Sassoulas left a comment

rlalik commented Jun 13, 2024 •

edited

Loading

Pierre-Sassoulas left a comment

DanielNoord Jun 17, 2024

DanielNoord Jun 17, 2024

github-actions bot commented Jun 17, 2024

		@@ -0,0 +1,3 @@
		Fix a bug where a ``tox.ini`` file with pylint configuration was ignored and it exists in the current directory.

	if config_name.suffix in {".cfg", ".ini"} and not _cfg_has_config(
	if config_name.suffix in {".cfg", ".ini"} and not _cfg_or_ini_has_config(

Add tox.ini to the default discovered config files (right after setup.cfg) #9728

Add tox.ini to the default discovered config files (right after setup.cfg) #9728

Conversation

mbyrnepr2 commented Jun 12, 2024

Type of Changes

Description

codecov bot commented Jun 12, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

mbyrnepr2 Jun 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

rlalik commented Jun 13, 2024 • edited Loading

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jun 17, 2024

Add `tox.ini` to the default discovered config files (right after setup.cfg) #9728

Add `tox.ini` to the default discovered config files (right after setup.cfg) #9728

codecov bot commented Jun 12, 2024 •

edited

Loading

mbyrnepr2 Jun 12, 2024 •

edited

Loading

rlalik commented Jun 13, 2024 •

edited

Loading