Fix recognition of files named `setup.cfg` (#3630) #6577

Pierre-Sassoulas · 2022-05-11T08:48:26Z

Type of Changes

	Type
✓	🐛 Bug fix
✓	📜 Docs

Description

Closes #3630. It seems there's still some oddity, init_hook is not treated the same as other option apparentely.

coveralls · 2022-05-11T08:56:39Z

Pull Request Test Coverage Report for Build 2582528056

4 of 4 (100.0%) changed or added relevant lines in 1 file are covered.
13 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.01%) to 95.342%

Files with Coverage Reduction	New Missed Lines	%
pylint/testutils/_primer/primer_command.py	1	93.75%
pylint/testutils/_primer/primer_run_command.py	12	39.02%

Totals
Change from base Build 2581704758:	0.01%
Covered Lines:	16682
Relevant Lines:	17497

💛 - Coveralls

Pierre-Sassoulas · 2022-05-11T09:25:20Z

tests/config/functional/setup_cfg/issue_3630/1.result.json

@@ -0,0 +1 @@
+{}


Here's it's strange that we have no value set for init-hook

Yeah, this should have a value I think. But I'm not 100% sure since this is one of the "pre-processed" options so it might be a bit broken.

DanielNoord

Other than the first test (which I agree seems like it is still broken) I don't think the other tests add much value? Those regressions are covered by other tests I think.

If anything, we should probably add comments or change the file names to reflect the issues.

Also note, with the migration to argparse there is now slightly different behaviour between setup.cfg and myconfig.cfg. As for setup we require pylint. section names (although we still support [MASTER]. It might be necessary to use a setup.cfg name instead.

DanielNoord · 2022-05-16T06:43:09Z

tests/config/functional/setup_cfg/issue_3630/1.cfg

@@ -0,0 +1,3 @@
+# Wrong header ?
+[tool.pylint.MASTER]
+init-hook="from pylint.config import find_pylintrc;"


Shall we use something like print() so we can actually check the init-hook is executed?

DanielNoord · 2022-05-16T06:44:05Z

tests/config/functional/setup_cfg/issue_3630/1.result.json

@@ -0,0 +1 @@
+{}


Yeah, this should have a value I think. But I'm not 100% sure since this is one of the "pre-processed" options so it might be a bit broken.

DanielNoord · 2022-05-16T06:44:43Z

tests/config/functional/setup_cfg/issue_3630/2.2.out

@@ -0,0 +1,2 @@
+************* Module Command line or configuration file


What is this testing? This seems a little redundant with all the other tests that check for (incorrect) section headers.

Just took all the example from the issue :)

…-oddity

DanielNoord · 2022-06-29T09:29:01Z

@Pierre-Sassoulas This is ready for review!

Pierre-Sassoulas · 2022-06-29T10:43:09Z

tests/config/functional/setup_cfg/issue_3630/not_setup.2.out

@@ -0,0 +1,3 @@
+I should just print


This way of testing the init-hook option is not new, but it's still clever and beautiful 😄

tests/config/functional/setup_cfg/issue_3630/setup.cfg

Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>

Pierre-Sassoulas · 2022-06-29T10:48:34Z

Can't approve the MR I opened myself but let's merge this 👍

github-actions · 2022-06-29T11:33:36Z

🤖 Effect of this PR on checked open source code: 🤖

Effect on pandas:
The following messages are now emitted:

unsupported-assignment-operation:
'mangled_aggspec' does not support item assignment
https://github.com/pandas-dev/pandas/blob/main/pandas/core/apply.py#L1537
redefined-variable-type:
Redefinition of mangled_aggspec type from str to list
https://github.com/pandas-dev/pandas/blob/main/pandas/core/apply.py#L1539
no-member:
Instance of 'RangeIndex' has no 'levels' member; maybe 'nlevels'?
https://github.com/pandas-dev/pandas/blob/main/pandas/core/indexes/base.py#L2187
no-member:
Instance of 'RangeIndex' has no 'codes' member
https://github.com/pandas-dev/pandas/blob/main/pandas/core/indexes/base.py#L2188
no-member:
Instance of 'Table' has no 'write_data' member
https://github.com/pandas-dev/pandas/blob/main/pandas/io/pytables.py#L4367

The following messages are no longer emitted:

no-member:
Instance of 'Index' has no 'levels' member; maybe 'nlevels'?
https://github.com/pandas-dev/pandas/blob/main/pandas/core/indexes/base.py#L2187
no-member:
Instance of 'Index' has no 'codes' member
https://github.com/pandas-dev/pandas/blob/main/pandas/core/indexes/base.py#L2188

Effect on pytest:
The following messages are now emitted:

consider-using-dict-items:
Consider iterating with .items()
https://github.com/pytest-dev/pytest/blob/main/src/_pytest/reports.py#L513
unsubscriptable-object:
Value 'location' is unsubscriptable
https://github.com/pytest-dev/pytest/blob/main/src/_pytest/nodes.py#L510

The following messages are no longer emitted:

no-member:
Class 'Config' has no 'ArgsSource' member
https://github.com/pytest-dev/pytest/blob/main/src/_pytest/terminal.py#L735

This comment was generated for commit 604deac

…pylint-dev#6577) Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>

Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>

Add regression tests for inconsistencies in setup.cfg (pylint-dev#3630)

4524853

Pierre-Sassoulas added Bug 🪲 Documentation 📗 labels May 11, 2022

Pierre-Sassoulas added this to the 2.15.0 milestone May 11, 2022

DanielNoord self-requested a review May 11, 2022 08:53

Pierre-Sassoulas commented May 11, 2022

View reviewed changes

DanielNoord requested changes May 16, 2022

View reviewed changes

DanielNoord marked this pull request as draft June 21, 2022 07:35

DanielNoord added 2 commits June 29, 2022 11:15

Merge branch 'main' of https://github.com/PyCQA/pylint into setup-cfg…

6bb1edb

…-oddity

Fix the actual issues

68f8f12

DanielNoord added Needs review 🔍 Needs to be reviewed by one or multiple more persons Needs backport Needs to be cherry-picked on the current patch version by a pylint's maintainer labels Jun 29, 2022

DanielNoord marked this pull request as ready for review June 29, 2022 09:28

DanielNoord modified the milestones: 2.15.0, 2.14.4 Jun 29, 2022

DanielNoord changed the title ~~Add regression tests for inconsistencies in setup.cfg (#3630)~~ Fix recognition of files named setup.cfg (#3630) Jun 29, 2022

This comment has been minimized.

Sign in to view

Pierre-Sassoulas commented Jun 29, 2022

View reviewed changes

Pierre-Sassoulas removed the Needs review 🔍 Needs to be reviewed by one or multiple more persons label Jun 29, 2022

Update tests/config/functional/setup_cfg/issue_3630/setup.cfg

604deac

Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>

Pierre-Sassoulas requested a review from DanielNoord June 29, 2022 10:47

DanielNoord approved these changes Jun 29, 2022

View reviewed changes

DanielNoord merged commit 63f7c09 into pylint-dev:main Jun 29, 2022

Pierre-Sassoulas added a commit to Pierre-Sassoulas/pylint that referenced this pull request Jun 29, 2022

Fix recognition of config files named setup.cfg (pylint-dev#3630) (…

0ad210e

…pylint-dev#6577) Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>

Pierre-Sassoulas added a commit that referenced this pull request Jun 29, 2022

Fix recognition of config files named setup.cfg (#3630) (#6577)

15470d1

Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>

Pierre-Sassoulas deleted the setup-cfg-oddity branch June 29, 2022 14:35

Pierre-Sassoulas added Backported and removed Needs backport Needs to be cherry-picked on the current patch version by a pylint's maintainer labels Sep 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix recognition of files named `setup.cfg` (#3630) #6577

Fix recognition of files named `setup.cfg` (#3630) #6577

Pierre-Sassoulas commented May 11, 2022 •

edited

coveralls commented May 11, 2022 •

edited

Pierre-Sassoulas May 11, 2022

DanielNoord May 16, 2022

DanielNoord left a comment

DanielNoord May 16, 2022

DanielNoord May 16, 2022

DanielNoord May 16, 2022

Pierre-Sassoulas May 16, 2022

DanielNoord commented Jun 29, 2022

This comment has been minimized.

Pierre-Sassoulas Jun 29, 2022

Pierre-Sassoulas commented Jun 29, 2022

github-actions bot commented Jun 29, 2022

		@@ -0,0 +1,2 @@
		************* Module Command line or configuration file

Fix recognition of files named setup.cfg (#3630) #6577

Fix recognition of files named setup.cfg (#3630) #6577

Conversation

Pierre-Sassoulas commented May 11, 2022 • edited

Type of Changes

Description

coveralls commented May 11, 2022 • edited

Pull Request Test Coverage Report for Build 2582528056

💛 - Coveralls

Pierre-Sassoulas May 11, 2022

Choose a reason for hiding this comment

DanielNoord May 16, 2022

Choose a reason for hiding this comment

DanielNoord left a comment

Choose a reason for hiding this comment

DanielNoord May 16, 2022

Choose a reason for hiding this comment

DanielNoord May 16, 2022

Choose a reason for hiding this comment

DanielNoord May 16, 2022

Choose a reason for hiding this comment

Pierre-Sassoulas May 16, 2022

Choose a reason for hiding this comment

DanielNoord commented Jun 29, 2022

This comment has been minimized.

Pierre-Sassoulas Jun 29, 2022

Choose a reason for hiding this comment

Pierre-Sassoulas commented Jun 29, 2022

github-actions bot commented Jun 29, 2022

Fix recognition of files named `setup.cfg` (#3630) #6577

Fix recognition of files named `setup.cfg` (#3630) #6577

Pierre-Sassoulas commented May 11, 2022 •

edited

coveralls commented May 11, 2022 •

edited