Deprecate some file in pylint/testutils and update changelog

Author: Pierre-Sassoulas

ChangeLog

@@ -11,6 +11,8 @@ Release date: TBA
 ..
   Put new features here and also in 'doc/whatsnew/2.13.rst'
 
+* Some file in ``pylint.testutils`` were deprecated, imports should be done from the
+  ``pylint.testutils`` API directly
 
 ..
   Insert your changelog randomly, it will reduce merge conflicts

pylint/testutils/__init__.py

@@ -49,7 +49,7 @@
 from pylint.testutils.checker_test_case import CheckerTestCase
 from pylint.testutils.constants import UPDATE_FILE, UPDATE_OPTION
 from pylint.testutils.decorator import set_config
-from pylint.testutils.functional_test_file import FunctionalTestFile
+from pylint.testutils.functional.test_file import FunctionalTestFile
 from pylint.testutils.get_test_info import _get_tests_info
 from pylint.testutils.global_test_linter import linter
 from pylint.testutils.lint_module_test import LintModuleTest

pylint/testutils/functional/__init__.py

@@ -0,0 +1,14 @@
+# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
+
+__all__ = [
+    "FunctionalTestFile",
+    "NoFileError",
+    "parse_python_version",
+]
+
+from pylint.testutils.functional.test_file import (
+    FunctionalTestFile,
+    NoFileError,
+    parse_python_version,
+)

pylint/testutils/functional/test_file.py

@@ -0,0 +1,75 @@
+# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
+
+import configparser
+from os.path import basename, exists, join
+
+
+def parse_python_version(ver_str):
+    return tuple(int(digit) for digit in ver_str.split("."))
+
+
+class NoFileError(Exception):
+    pass
+
+
+class FunctionalTestFile:
+    """A single functional test case file with options."""
+
+    _CONVERTERS = {
+        "min_pyver": parse_python_version,
+        "max_pyver": parse_python_version,
+        "min_pyver_end_position": parse_python_version,
+        "requires": lambda s: s.split(","),
+    }
+
+    def __init__(self, directory, filename):
+        self._directory = directory
+        self.base = filename.replace(".py", "")
+        self.options = {
+            "min_pyver": (2, 5),
+            "max_pyver": (4, 0),
+            "min_pyver_end_position": (3, 8),
+            "requires": [],
+            "except_implementations": [],
+            "exclude_platforms": [],
+        }
+        self._parse_options()
+
+    def __repr__(self):
+        return f"FunctionalTest:{self.base}"
+
+    def _parse_options(self):
+        cp = configparser.ConfigParser()
+        cp.add_section("testoptions")
+        try:
+            cp.read(self.option_file)
+        except NoFileError:
+            pass
+
+        for name, value in cp.items("testoptions"):
+            conv = self._CONVERTERS.get(name, lambda v: v)
+            self.options[name] = conv(value)
+
+    @property
+    def option_file(self):
+        return self._file_type(".rc")
+
+    @property
+    def module(self):
+        package = basename(self._directory)
+        return ".".join([package, self.base])
+
+    @property
+    def expected_output(self):
+        return self._file_type(".txt", check_exists=False)
+
+    @property
+    def source(self):
+        return self._file_type(".py")
+
+    def _file_type(self, ext, check_exists=True):
+        name = join(self._directory, self.base + ext)
+        if not check_exists or exists(name):
+            return name
+        raise NoFileError(f"Cannot find '{name}'.")

pylint/testutils/functional_test_file.py

@@ -1,75 +1,22 @@
 # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
 
-import configparser
-from os.path import basename, exists, join
-
-
-def parse_python_version(ver_str):
-    return tuple(int(digit) for digit in ver_str.split("."))
-
-
-class NoFileError(Exception):
-    pass
-
-
-class FunctionalTestFile:
-    """A single functional test case file with options."""
-
-    _CONVERTERS = {
-        "min_pyver": parse_python_version,
-        "max_pyver": parse_python_version,
-        "min_pyver_end_position": parse_python_version,
-        "requires": lambda s: s.split(","),
-    }
-
-    def __init__(self, directory, filename):
-        self._directory = directory
-        self.base = filename.replace(".py", "")
-        self.options = {
-            "min_pyver": (2, 5),
-            "max_pyver": (4, 0),
-            "min_pyver_end_position": (3, 8),
-            "requires": [],
-            "except_implementations": [],
-            "exclude_platforms": [],
-        }
-        self._parse_options()
-
-    def __repr__(self):
-        return f"FunctionalTest:{self.base}"
-
-    def _parse_options(self):
-        cp = configparser.ConfigParser()
-        cp.add_section("testoptions")
-        try:
-            cp.read(self.option_file)
-        except NoFileError:
-            pass
-
-        for name, value in cp.items("testoptions"):
-            conv = self._CONVERTERS.get(name, lambda v: v)
-            self.options[name] = conv(value)
-
-    @property
-    def option_file(self):
-        return self._file_type(".rc")
-
-    @property
-    def module(self):
-        package = basename(self._directory)
-        return ".".join([package, self.base])
-
-    @property
-    def expected_output(self):
-        return self._file_type(".txt", check_exists=False)
-
-    @property
-    def source(self):
-        return self._file_type(".py")
-
-    def _file_type(self, ext, check_exists=True):
-        name = join(self._directory, self.base + ext)
-        if not check_exists or exists(name):
-            return name
-        raise NoFileError(f"Cannot find '{name}'.")
+__all__ = [
+    "FunctionalTestFile",
+    "NoFileError",
+    "parse_python_version",
+]
+
+import warnings
+
+from pylint.testutils.functional import (
+    FunctionalTestFile,
+    NoFileError,
+    parse_python_version,
+)
+
+warnings.warn(
+    "'pylint.testutils.functional_test_file' will be accessible by"
+    " the 'pylint.testutils.functional' API in pylint 3.0",
+    DeprecationWarning,
+)

pylint/testutils/lint_module_test.py

@@ -17,7 +17,7 @@
 from pylint.lint import PyLinter
 from pylint.message.message import Message
 from pylint.testutils.constants import _EXPECTED_RE, _OPERATORS, UPDATE_OPTION
-from pylint.testutils.functional_test_file import (
+from pylint.testutils.functional.test_file import (
     FunctionalTestFile,
     NoFileError,
     parse_python_version,

tests/test_functional.py

@@ -34,7 +34,7 @@
 
 from pylint import testutils
 from pylint.testutils import UPDATE_FILE, UPDATE_OPTION
-from pylint.testutils.functional_test_file import FunctionalTestFile
+from pylint.testutils.functional.test_file import FunctionalTestFile
 from pylint.utils import HAS_ISORT_5
 
 # TODOs