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.

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

[deprecation] setup.cfgand tox.ini sections need to start by 'pylint' #8465

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
5 changes: 5 additions & 0 deletions doc/whatsnew/fragments/8464.user_action
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Following a deprecation period, it's now longer possible to use ``MASTER``
Pierre-Sassoulas marked this conversation as resolved.
Show resolved Hide resolved
or ``master`` as configuration section in ini files. It's bad practice
Pierre-Sassoulas marked this conversation as resolved.
Show resolved Hide resolved
to not start sections titles with the tool name. Please use ``pylint.main`` instead.

Refs #8464
23 changes: 6 additions & 17 deletions pylint/config/config_file_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
import configparser
import os
import sys
import warnings
from pathlib import Path
from typing import TYPE_CHECKING

Expand Down Expand Up @@ -41,23 +40,13 @@ def _parse_ini_file(self, file_path: Path) -> tuple[dict[str, str], list[str]]:

config_content: dict[str, str] = {}
options: list[str] = []
ini_file_with_sections = self._ini_file_with_sections(file_path)
Copy link
Member Author

Choose a reason for hiding this comment

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

There's a perf increase here, we calculate the boolean once instead of for each sections 😄

for section in parser.sections():
if self._ini_file_with_sections(file_path) and not section.startswith(
"pylint"
):
if section.lower() == "master":
# TODO: 3.0: Remove deprecated handling of master, only allow 'pylint.' sections
warnings.warn(
"The use of 'MASTER' or 'master' as configuration section for pylint "
"has been deprecated, as it's bad practice to not start sections titles "
"with the tool name. Please use 'pylint.main' instead.",
UserWarning,
)
else:
continue
for opt, value in parser[section].items():
config_content[opt] = value
options += [f"--{opt}", value]
if ini_file_with_sections and not section.startswith("pylint"):
continue
for option, value in parser[section].items():
config_content[option] = value
options += [f"--{option}", value]
return config_content, options

@staticmethod
Expand Down
3 changes: 0 additions & 3 deletions tests/config/functional/setup_cfg/deprecate_master/setup.cfg

This file was deleted.

This file was deleted.