Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix Pylint Configuration Parsing Bug Causing Incorrect Option Settings #8460 #8591

Closed
wants to merge 9 commits into from
Closed

Fix Pylint Configuration Parsing Bug Causing Incorrect Option Settings #8460 #8591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1e543fa
fixed #8460
ianrose1 Apr 18, 2023
973c6a3
Merge branch 'main' of github.com:ianrose1/pylint
ianrose1 Apr 18, 2023
70e3835
Fix(pylint): Respect values in .toml configuration files (pylint-dev#…
ianrose1 Apr 18, 2023
8547a3e
Merge branch 'main' of github.com:ianrose1/pylint
ianrose1 Apr 19, 2023
b41541c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 19, 2023
001cdb4
Update 8460.bugfix
ianrose1 Apr 19, 2023
e9d7798
Update 8460.bugfix
ianrose1 Apr 19, 2023
602c8f4
Merge branch 'main' into main
Pierre-Sassoulas Jun 14, 2023
05c496c
Merge branch 'main' into main
Pierre-Sassoulas Sep 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/whatsnew/fragments/8460.bugfix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Fixed issue of specifying options as false on .toml files.

Refs #8460
3 changes: 2 additions & 1 deletion pylint/config/config_file_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ def parse_toml_file(file_path: Path) -> PylintConfigFileData:
for config, value in values.items():
value = _parse_rich_type_value(value)
config_content[config] = value
options += [f"--{config}", value]
if value.lower() != "false":
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also check the type of the config option. If somebody put in false for a non-store_true option we don't want to this this. A test for this would also be good!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good! Do you know if there's an efficient way to check the type of config? I was looking at the function "_convert_option_to_argument" in pylint/config/utils.py, but not sure if that would work.

Copy link
Collaborator

@DanielNoord DanielNoord Apr 22, 2023 •
edited by jacobtylerwalls

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, although you could perhaps wait with parsing them until you reach:

pylint/pylint/config/arguments_manager.py

Lines 211 to 214 in 4cdf922

try:
self.config, parsed_args = self._arg_parser.parse_known_args(
arguments, self.config
)

This should have knowledge of all registered arguments.

options += [f"--{config}", value]
else:
values = _parse_rich_type_value(values)
config_content[opt] = values
Expand Down
4 changes: 4 additions & 0 deletions tests/config/functional/toml/issue_8460/toml_store_true_error.result.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"from_stdin": false,
"exit_zero": false
}
6 changes: 6 additions & 0 deletions tests/config/functional/toml/issue_8460/toml_store_true_error.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Check to see if we can specify configurations as false
# without pylint treating the presence of the key as enabling that value

[tool.pylint.main]
from_stdin = false
exit_zero = false