CI: Ruff format scripts/

.pre-commit-config.yaml

@@ -32,7 +32,7 @@ repos:
         exclude: ^pandas/tests
         args: [--select, "ANN001,ANN2", --fix-only, --exit-non-zero-on-fix]
     -   id: ruff-format
-        exclude: ^scripts|^pandas/tests/frame/test_query_eval.py
+        exclude: ^pandas/tests/frame/test_query_eval.py
 -   repo: https://github.com/jendrikseipp/vulture
     rev: v2.14
     hooks:

scripts/check_for_inconsistent_pandas_namespace.py

@@ -30,8 +30,7 @@
 from typing import NamedTuple
 
 ERROR_MESSAGE = (
-    "{path}:{lineno}:{col_offset}: "
-    "Found both '{prefix}.{name}' and '{name}' in {path}"
+    "{path}:{lineno}:{col_offset}: Found both '{prefix}.{name}' and '{name}' in {path}"
 )
 
 

scripts/check_test_naming.py

@@ -8,6 +8,7 @@
 NOTE: if this finds a false positive, you can add the comment `# not a test` to the
 class or function definition. Though hopefully that shouldn't be necessary.
 """
+
 from __future__ import annotations
 
 import argparse

scripts/generate_pip_deps_from_conda.py

@@ -12,6 +12,7 @@
     generated with this script:
     $ python scripts/generate_pip_deps_from_conda.py --compare
 """
+
 import argparse
 import pathlib
 import re

scripts/pandas_errors_documented.py

@@ -6,6 +6,7 @@
 
     pre-commit run pandas-errors-documented --all-files
 """
+
 from __future__ import annotations
 
 import argparse

scripts/sort_whatsnew_note.py

@@ -23,6 +23,7 @@
 
     pre-commit run sort-whatsnew-items --all-files
 """
+
 from __future__ import annotations
 
 import argparse

scripts/tests/test_check_test_naming.py

@@ -24,10 +24,7 @@
             0,
         ),
         (
-            "class Foo:  # not a test\n"
-            "    pass\n"
-            "def test_foo():\n"
-            "    Class.foo()\n",
+            "class Foo:  # not a test\n    pass\ndef test_foo():\n    Class.foo()\n",
             "",
             0,
         ),

scripts/tests/test_inconsistent_namespace_check.py

@@ -5,14 +5,10 @@
 )
 
 BAD_FILE_0 = (
-    "from pandas import Categorical\n"
-    "cat_0 = Categorical()\n"
-    "cat_1 = pd.Categorical()"
+    "from pandas import Categorical\ncat_0 = Categorical()\ncat_1 = pd.Categorical()"
 )
 BAD_FILE_1 = (
-    "from pandas import Categorical\n"
-    "cat_0 = pd.Categorical()\n"
-    "cat_1 = Categorical()"
+    "from pandas import Categorical\ncat_0 = pd.Categorical()\ncat_1 = Categorical()"
 )
 BAD_FILE_2 = (
     "from pandas import Categorical\n"

scripts/tests/test_validate_docstrings.py

@@ -6,6 +6,7 @@
 from scripts import validate_docstrings
 
 
+# fmt: off
 class BadDocstrings:
     """Everything here has a bad docstring"""
 
@@ -88,6 +89,7 @@ def leftover_files(self) -> None:
         >>> import pathlib
         >>> pathlib.Path("foo.txt").touch()
         """
+# fmt: on
 
 
 class TestValidator:
@@ -227,13 +229,13 @@ def test_validate_all_ignore_errors(self, monkeypatch):
                 "errors": [
                     ("ER01", "err desc"),
                     ("ER02", "err desc"),
-                    ("ER03", "err desc")
+                    ("ER03", "err desc"),
                 ],
                 "warnings": [],
                 "examples_errors": "",
                 "deprecated": True,
                 "file": "file1",
-                "file_line": "file_line1"
+                "file_line": "file_line1",
             },
         )
         monkeypatch.setattr(
@@ -272,14 +274,13 @@ def test_validate_all_ignore_errors(self, monkeypatch):
                 None: {"ER03"},
                 "pandas.DataFrame.align": {"ER01"},
                 # ignoring an error that is not requested should be of no effect
-                "pandas.Index.all": {"ER03"}
-            }
+                "pandas.Index.all": {"ER03"},
+            },
         )
         # two functions * two not global ignored errors - one function ignored error
         assert exit_status == 2 * 2 - 1
 
 
-
 class TestApiItems:
     @property
     def api_doc(self):

scripts/tests/test_validate_min_versions_in_sync.py

@@ -10,34 +10,48 @@
     pin_min_versions_to_yaml_file,
 )
 
+BASE_PATH = pathlib.Path(__file__).parents[2]
+
 
 @pytest.mark.parametrize(
     "src_toml, src_yaml, expected_yaml",
     [
         (
-            pathlib.Path("scripts/tests/data/deps_minimum.toml"),
-            pathlib.Path("scripts/tests/data/deps_unmodified_random.yaml"),
-            pathlib.Path("scripts/tests/data/deps_expected_random.yaml"),
+            pathlib.Path(BASE_PATH / "scripts/tests/data/deps_minimum.toml"),
+            pathlib.Path(BASE_PATH / "scripts/tests/data/deps_unmodified_random.yaml"),
+            pathlib.Path(BASE_PATH / "scripts/tests/data/deps_expected_random.yaml"),
         ),
         (
-            pathlib.Path("scripts/tests/data/deps_minimum.toml"),
-            pathlib.Path("scripts/tests/data/deps_unmodified_same_version.yaml"),
-            pathlib.Path("scripts/tests/data/deps_expected_same_version.yaml"),
+            pathlib.Path(BASE_PATH / "scripts/tests/data/deps_minimum.toml"),
+            pathlib.Path(
+                BASE_PATH / "scripts/tests/data/deps_unmodified_same_version.yaml"
+            ),
+            pathlib.Path(
+                BASE_PATH / "scripts/tests/data/deps_expected_same_version.yaml"
+            ),
         ),
         (
-            pathlib.Path("scripts/tests/data/deps_minimum.toml"),
-            pathlib.Path("scripts/tests/data/deps_unmodified_duplicate_package.yaml"),
-            pathlib.Path("scripts/tests/data/deps_expected_duplicate_package.yaml"),
+            pathlib.Path(BASE_PATH / "scripts/tests/data/deps_minimum.toml"),
+            pathlib.Path(
+                BASE_PATH / "scripts/tests/data/deps_unmodified_duplicate_package.yaml"
+            ),
+            pathlib.Path(
+                BASE_PATH / "scripts/tests/data/deps_expected_duplicate_package.yaml"
+            ),
         ),
         (
-            pathlib.Path("scripts/tests/data/deps_minimum.toml"),
-            pathlib.Path("scripts/tests/data/deps_unmodified_no_version.yaml"),
-            pathlib.Path("scripts/tests/data/deps_expected_no_version.yaml"),
+            pathlib.Path(BASE_PATH / "scripts/tests/data/deps_minimum.toml"),
+            pathlib.Path(
+                BASE_PATH / "scripts/tests/data/deps_unmodified_no_version.yaml"
+            ),
+            pathlib.Path(
+                BASE_PATH / "scripts/tests/data/deps_expected_no_version.yaml"
+            ),
         ),
         (
-            pathlib.Path("scripts/tests/data/deps_minimum.toml"),
-            pathlib.Path("scripts/tests/data/deps_unmodified_range.yaml"),
-            pathlib.Path("scripts/tests/data/deps_expected_range.yaml"),
+            pathlib.Path(BASE_PATH / "scripts/tests/data/deps_minimum.toml"),
+            pathlib.Path(BASE_PATH / "scripts/tests/data/deps_unmodified_range.yaml"),
+            pathlib.Path(BASE_PATH / "scripts/tests/data/deps_expected_range.yaml"),
         ),
     ],
 )

scripts/validate_docstrings.py

@@ -13,6 +13,7 @@
     $ ./validate_docstrings.py
     $ ./validate_docstrings.py pandas.DataFrame.head
 """
+
 from __future__ import annotations
 
 import argparse
@@ -380,13 +381,13 @@ def print_validate_all_results(
         )
         for err_code in actual_failures - expected_failures:
             sys.stdout.write(
-                f'{prefix}{res["file"]}:{res["file_line"]}:'
+                f"{prefix}{res['file']}:{res['file_line']}:"
                 f"{err_code}:{func_name}:{error_messages[err_code]}\n"
             )
             exit_status += 1
         for err_code in ignore_errors.get(func_name, set()) - actual_failures:
             sys.stdout.write(
-                f'{prefix}{res["file"]}:{res["file_line"]}:'
+                f"{prefix}{res['file']}:{res['file_line']}:"
                 f"{err_code}:{func_name}:"
                 "EXPECTED TO FAIL, BUT NOT FAILING\n"
             )
@@ -419,7 +420,7 @@ def header(title, width=80, char="#") -> str:
 
     sys.stderr.write(header("Validation"))
     if result["errors"]:
-        sys.stderr.write(f'{len(result["errors"])} Errors found for `{func_name}`:\n')
+        sys.stderr.write(f"{len(result['errors'])} Errors found for `{func_name}`:\n")
         for err_code, err_desc in result["errors"]:
             sys.stderr.write(f"\t{err_code}\t{err_desc}\n")
     else:

scripts/validate_exception_location.py

@@ -18,6 +18,7 @@
 As a pre-commit hook:
     pre-commit run validate-errors-locations --all-files
 """
+
 from __future__ import annotations
 
 import argparse

scripts/validate_min_versions_in_sync.py

@@ -12,6 +12,7 @@
 
     pre-commit run validate-min-versions-in-sync --all-files
 """
+
 from __future__ import annotations
 
 import pathlib
@@ -23,19 +24,20 @@
 
 from scripts.generate_pip_deps_from_conda import CONDA_TO_PIP
 
-DOC_PATH = pathlib.Path("doc/source/getting_started/install.rst").resolve()
+BASE_PATH = pathlib.Path(__file__).parent.parent
+DOC_PATH = pathlib.Path(BASE_PATH / "doc/source/getting_started/install.rst").resolve()
 CI_PATH = next(
-    pathlib.Path("ci/deps").absolute().glob("actions-*-minimum_versions.yaml")
+    (BASE_PATH / "ci/deps").absolute().glob("actions-*-minimum_versions.yaml")
 )
-CODE_PATH = pathlib.Path("pandas/compat/_optional.py").resolve()
-SETUP_PATH = pathlib.Path("pyproject.toml").resolve()
-YAML_PATH = pathlib.Path("ci/deps")
-ENV_PATH = pathlib.Path("environment.yml")
+CODE_PATH = pathlib.Path(BASE_PATH / "pandas/compat/_optional.py").resolve()
+SETUP_PATH = pathlib.Path(BASE_PATH / "pyproject.toml").resolve()
+YAML_PATH = pathlib.Path(BASE_PATH / "ci/deps")
+ENV_PATH = pathlib.Path(BASE_PATH / "environment.yml")
 EXCLUDE_DEPS = {"tzdata", "pyqt", "pyqt5"}
 # pandas package is not available
 # in pre-commit environment
-sys.path.append("pandas/compat")
-sys.path.append("pandas/util")
+sys.path.append(str(BASE_PATH / "pandas/compat"))
+sys.path.append(str(BASE_PATH / "pandas/util"))
 import _exceptions
 import version
 
@@ -99,14 +101,11 @@ def get_operator_from(dependency: str) -> str | None:
 
 
 def get_yaml_map_from(
-    yaml_dic: list[str | dict[str, list[str]]]
+    yaml_dic: list[str | dict[str, list[str]]],
 ) -> dict[str, list[str] | None]:
     yaml_map: dict[str, list[str] | None] = {}
     for dependency in yaml_dic:
-        if (
-            isinstance(dependency, dict)
-            or dependency in yaml_map
-        ):
+        if isinstance(dependency, dict) or dependency in yaml_map:
             continue
         search_text = str(dependency)
         operator = get_operator_from(search_text)

scripts/validate_rst_title_capitalization.py

@@ -11,6 +11,7 @@
 From the command-line:
     python scripts/validate_rst_title_capitalization.py <rst file>
 """
+
 from __future__ import annotations
 
 import argparse
@@ -271,7 +272,8 @@ def main(source_paths: list[str]) -> int:
             if title != correct_title_capitalization(title):
                 print(
                     f"""{filename}:{line_number}:{err_msg} "{title}" to "{
-                    correct_title_capitalization(title)}" """
+                        correct_title_capitalization(title)
+                    }" """
                 )
                 number_of_errors += 1