Add explicit 'stack_level' keyword in Deprecation/User warnings

Author: Pierre-Sassoulas

pylint/checkers/similar.py

@@ -848,12 +848,14 @@ def process_module(self, node: nodes.Module) -> None:
         stream must implement the readlines method
         """
         if self.linter.current_name is None:
+            # TODO: 3.0 Fix current_name
             warnings.warn(
                 (
                     "In pylint 3.0 the current_name attribute of the linter object should be a string. "
                     "If unknown it should be initialized as an empty string."
                 ),
                 DeprecationWarning,
+                stacklevel=2,
             )
         with node.stream() as stream:
             self.append_stream(self.linter.current_name, stream, node.file_encoding)

pylint/config/deprecation_actions.py

@@ -104,4 +104,5 @@ def __call__(
             f"{self.option_strings[0]} has been deprecated. Please look into "
             f"using any of the following options: {', '.join(self.new_names)}.",
             DeprecationWarning,
+            stacklevel=2,
         )

pylint/lint/caching.py

@@ -45,6 +45,7 @@ def load_results(
                     "You're using an old pylint cache with invalid data following "
                     f"an upgrade, please delete '{data_file}'.",
                     UserWarning,
+                    stacklevel=2,
                 )
                 raise TypeError
             return data

pylint/lint/run.py

@@ -175,6 +175,7 @@ def __init__(
             warnings.warn(
                 "NOTE: The 'pylint-config' command is experimental and usage can change",
                 UserWarning,
+                stacklevel=2,
             )
             code = _handle_pylint_config_commands(linter)
             if exit:
@@ -216,9 +217,11 @@ def __init__(
             score_value = linter.generate_reports()
 
         if do_exit is not UNUSED_PARAM_SENTINEL:
+            # TODO: 3.0
             warnings.warn(
                 "do_exit is deprecated and it is going to be removed in a future version.",
                 DeprecationWarning,
+                stacklevel=2,
             )
             exit = do_exit
 

pylint/message/message_definition.py

@@ -80,13 +80,15 @@ def may_be_emitted(
         """Return True if message may be emitted using the configured py_version."""
         if py_version is None:
             py_version = sys.version_info
+            # TODO: 3.0
             warnings.warn(
                 "'py_version' will be a required parameter of "
                 "'MessageDefinition.may_be_emitted' in pylint 3.0. The most likely "
                 "solution is to use 'linter.config.py_version' if you need to keep "
                 "using this function, or to use 'MessageDefinition.is_message_enabled'"
                 " instead.",
                 DeprecationWarning,
+                stacklevel=2,
             )
         if self.minversion is not None and self.minversion > py_version:
             return False

pylint/reporters/text.py

@@ -137,7 +137,8 @@ def on_set_current_module(self, module: str, filepath: str | None) -> None:
             if argument[0] not in MESSAGE_FIELDS:
                 warnings.warn(
                     f"Don't recognize the argument '{argument[0]}' in the --msg-template. "
-                    "Are you sure it is supported on the current version of pylint?"
+                    "Are you sure it is supported on the current version of pylint?",
+                    stacklevel=2,
                 )
                 template = re.sub(r"\{" + argument[0] + r"(:.*?)?\}", "", template)
         self._fixed_template = template

pylint/testutils/_primer/primer_run_command.py

@@ -96,6 +96,7 @@ def _lint_package(
             if fatal_msgs:
                 warnings.warn(
                     f"Encountered fatal errors while priming {package_name} !\n"
-                    f"{self._print_msgs(fatal_msgs)}\n\n"
+                    f"{self._print_msgs(fatal_msgs)}\n\n",
+                    stacklevel=2,
                 )
         return messages, fatal_msgs

pylint/testutils/output_line.py

@@ -94,6 +94,7 @@ def from_csv(
         try:
             column = cls._get_column(row[2])
             if len(row) == 5:
+                # TODO: 3.0
                 warnings.warn(
                     "In pylint 3.0 functional tests expected output should always include the "
                     "expected confidence level, expected end_line and expected end_column. "
@@ -112,6 +113,7 @@ def from_csv(
                     UNDEFINED.name,
                 )
             if len(row) == 6:
+                # TODO: 3.0
                 warnings.warn(
                     "In pylint 3.0 functional tests expected output should always include the "
                     "expected end_line and expected end_column. An OutputLine should thus have "
@@ -142,6 +144,7 @@ def from_csv(
                 f"CONFIDENCE' but we got '{':'.join(row)}'. Try updating the expected"
                 f" output with:\npython tests/test_functional.py {UPDATE_OPTION}",
                 UserWarning,
+                stacklevel=2,
             )
             return cls("", 0, 0, None, None, "", "", "")