21552830208

Committed 31 Jan 2026 11:40PM UTC coverage: 80.277% (-0.05%) from 80.324%

Build # 21552830208

Build Type

Pull #23062

github

Committed by

web-flow

Commit Message

Merge 808a9786c into 2c4dcf9cf

Pull Request Pull Request #23062: Remove support for Get

Run Details

18 of 25 new or added lines in 4 files covered. (72.0%)

17119 existing lines in 541 files now uncovered.

78278 of 97510 relevant lines covered (80.28%)

3.36 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/src/python/pants/backend/python/lint/add_trailing_comma/rules_integration_test.py

# Copyright 2022 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

from __future__ import annotations

import pytest

from pants.backend.python import target_types_rules
from pants.backend.python.lint.add_trailing_comma.rules import (
    AddTrailingCommaFieldSet,
    AddTrailingCommaRequest,
)
from pants.backend.python.lint.add_trailing_comma.rules import rules as add_trailing_comma_rules
from pants.backend.python.lint.add_trailing_comma.subsystem import AddTrailingComma
from pants.backend.python.lint.add_trailing_comma.subsystem import (
    rules as add_trailing_comma_subsystem_rules,
)
from pants.backend.python.target_types import PythonSourcesGeneratorTarget
from pants.core.goals.fmt import FmtResult
from pants.core.util_rules import config_files, source_files
from pants.core.util_rules.source_files import SourceFiles, SourceFilesRequest
from pants.engine.addresses import Address
from pants.engine.target import Target
from pants.testutil.python_interpreter_selection import all_major_minor_python_versions
from pants.testutil.python_rule_runner import PythonRuleRunner
from pants.testutil.rule_runner import QueryRule


@pytest.fixture
def rule_runner() -> PythonRuleRunner:
    return PythonRuleRunner(
        rules=[
            *add_trailing_comma_rules(),
            *add_trailing_comma_subsystem_rules(),
            *source_files.rules(),
            *config_files.rules(),
            *target_types_rules.rules(),
            QueryRule(FmtResult, (AddTrailingCommaRequest.Batch,)),
            QueryRule(SourceFiles, (SourceFilesRequest,)),
        ],
        target_types=[PythonSourcesGeneratorTarget],
    )


GOOD_FILE = "foobar = [1, 2]\nbazqux = [\n  1,\n  2,\n]\n"
BAD_FILE = "foobar = [1, 2,]\nbazqux = [\n  1,\n  2\n]\n"


def run_add_trailing_comma(
    rule_runner: PythonRuleRunner,
    targets: list[Target],
    *,
    extra_args: list[str] | None = None,
) -> FmtResult:
    rule_runner.set_options(
        ["--backend-packages=pants.backend.python.lint.add_trailing_comma", *(extra_args or ())],
        env_inherit={"PATH", "PYENV_ROOT", "HOME"},
    )
    field_sets = [AddTrailingCommaFieldSet.create(tgt) for tgt in targets]
    input_sources = rule_runner.request(
        SourceFiles,
        [
            SourceFilesRequest(field_set.source for field_set in field_sets),
        ],
    )
    fmt_result = rule_runner.request(
        FmtResult,
        [
            AddTrailingCommaRequest.Batch(
                "",
                input_sources.snapshot.files,
                partition_metadata=None,
                snapshot=input_sources.snapshot,
            ),
        ],
    )
    return fmt_result


@pytest.mark.platform_specific_behavior
@pytest.mark.parametrize(
    "major_minor_interpreter",
    all_major_minor_python_versions(AddTrailingComma.default_interpreter_constraints),
)
def test_passing_source(rule_runner: PythonRuleRunner, major_minor_interpreter: str) -> None:
    rule_runner.write_files({"f.py": GOOD_FILE, "BUILD": "python_sources(name='t')"})
    tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))
    fmt_result = run_add_trailing_comma(
        rule_runner,
        [tgt],
        extra_args=[
            f"--add-trailing-comma-interpreter-constraints=['=={major_minor_interpreter}.*']"
        ],
    )
    assert fmt_result.stdout == ""
    assert fmt_result.output == rule_runner.make_snapshot({"f.py": GOOD_FILE})
    assert fmt_result.did_change is False


def test_failing_source(rule_runner: PythonRuleRunner) -> None:
    rule_runner.write_files({"f.py": BAD_FILE, "BUILD": "python_sources(name='t')"})
    tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))
    fmt_result = run_add_trailing_comma(rule_runner, [tgt])
    assert fmt_result.output == rule_runner.make_snapshot({"f.py": GOOD_FILE})
    assert fmt_result.did_change is True


def test_multiple_targets(rule_runner: PythonRuleRunner) -> None:
    rule_runner.write_files(
        {"good.py": GOOD_FILE, "bad.py": BAD_FILE, "BUILD": "python_sources(name='t')"}
    )
    tgts = [
        rule_runner.get_target(Address("", target_name="t", relative_file_path="good.py")),
        rule_runner.get_target(Address("", target_name="t", relative_file_path="bad.py")),
    ]
    fmt_result = run_add_trailing_comma(rule_runner, tgts)
    assert fmt_result.output == rule_runner.make_snapshot(
        {"good.py": GOOD_FILE, "bad.py": GOOD_FILE}
    )
    assert fmt_result.did_change is True


def test_stub_files(rule_runner: PythonRuleRunner) -> None:
    rule_runner.write_files(
        {
            "good.pyi": GOOD_FILE,
            "good.py": GOOD_FILE,
            "bad.pyi": BAD_FILE,
            "bad.py": BAD_FILE,
            "BUILD": "python_sources(name='t')",
        }
    )

    good_tgts = [
        rule_runner.get_target(Address("", target_name="t", relative_file_path="good.pyi")),
        rule_runner.get_target(Address("", target_name="t", relative_file_path="good.py")),
    ]
    fmt_result = run_add_trailing_comma(rule_runner, good_tgts)
    assert fmt_result.stdout == ""
    assert fmt_result.output == rule_runner.make_snapshot(
        {"good.py": GOOD_FILE, "good.pyi": GOOD_FILE}
    )
    assert not fmt_result.did_change

    bad_tgts = [
        rule_runner.get_target(Address("", target_name="t", relative_file_path="bad.pyi")),
        rule_runner.get_target(Address("", target_name="t", relative_file_path="bad.py")),
    ]
    fmt_result = run_add_trailing_comma(rule_runner, bad_tgts)
    assert fmt_result.output == rule_runner.make_snapshot(
        {"bad.py": GOOD_FILE, "bad.pyi": GOOD_FILE}
    )
    assert fmt_result.did_change

1	# Copyright 2022 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from __future__ import annotations	3✔
5
6	import pytest	3✔
7
8	from pants.backend.python import target_types_rules	3✔
9	from pants.backend.python.lint.add_trailing_comma.rules import (	3✔
10	AddTrailingCommaFieldSet,
11	AddTrailingCommaRequest,
12	)
13	from pants.backend.python.lint.add_trailing_comma.rules import rules as add_trailing_comma_rules	3✔
14	from pants.backend.python.lint.add_trailing_comma.subsystem import AddTrailingComma	3✔
15	from pants.backend.python.lint.add_trailing_comma.subsystem import (	3✔
16	rules as add_trailing_comma_subsystem_rules,
17	)
18	from pants.backend.python.target_types import PythonSourcesGeneratorTarget	3✔
19	from pants.core.goals.fmt import FmtResult	3✔
20	from pants.core.util_rules import config_files, source_files	3✔
21	from pants.core.util_rules.source_files import SourceFiles, SourceFilesRequest	3✔
22	from pants.engine.addresses import Address	3✔
23	from pants.engine.target import Target	3✔
24	from pants.testutil.python_interpreter_selection import all_major_minor_python_versions	3✔
25	from pants.testutil.python_rule_runner import PythonRuleRunner	3✔
26	from pants.testutil.rule_runner import QueryRule	3✔
27
28
29	@pytest.fixture	3✔
30	def rule_runner() -> PythonRuleRunner:	3✔
31	return PythonRuleRunner(	3✔
32	rules=[
33	*add_trailing_comma_rules(),
34	*add_trailing_comma_subsystem_rules(),
35	*source_files.rules(),
36	*config_files.rules(),
37	*target_types_rules.rules(),
38	QueryRule(FmtResult, (AddTrailingCommaRequest.Batch,)),
39	QueryRule(SourceFiles, (SourceFilesRequest,)),
40	],
41	target_types=[PythonSourcesGeneratorTarget],
42	)
43
44
45	GOOD_FILE = "foobar = [1, 2]\nbazqux = [\n 1,\n 2,\n]\n"	3✔
46	BAD_FILE = "foobar = [1, 2,]\nbazqux = [\n 1,\n 2\n]\n"	3✔
47
48
49	def run_add_trailing_comma(	3✔
50	rule_runner: PythonRuleRunner,
51	targets: list[Target],
52	*,
53	extra_args: list[str] \| None = None,
54	) -> FmtResult:
55	rule_runner.set_options(	3✔
56	["--backend-packages=pants.backend.python.lint.add_trailing_comma", *(extra_args or ())],
57	env_inherit={"PATH", "PYENV_ROOT", "HOME"},
58	)
59	field_sets = [AddTrailingCommaFieldSet.create(tgt) for tgt in targets]	3✔
60	input_sources = rule_runner.request(	3✔
61	SourceFiles,
62	[
63	SourceFilesRequest(field_set.source for field_set in field_sets),
64	],
65	)
66	fmt_result = rule_runner.request(	3✔
67	FmtResult,
68	[
69	AddTrailingCommaRequest.Batch(
70	"",
71	input_sources.snapshot.files,
72	partition_metadata=None,
73	snapshot=input_sources.snapshot,
74	),
75	],
76	)
77	return fmt_result	3✔
78
79
80	@pytest.mark.platform_specific_behavior	3✔
81	@pytest.mark.parametrize(	3✔
82	"major_minor_interpreter",
83	all_major_minor_python_versions(AddTrailingComma.default_interpreter_constraints),
84	)
85	def test_passing_source(rule_runner: PythonRuleRunner, major_minor_interpreter: str) -> None:	3✔
86	rule_runner.write_files({"f.py": GOOD_FILE, "BUILD": "python_sources(name='t')"})	3✔
87	tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))	3✔
88	fmt_result = run_add_trailing_comma(	3✔
89	rule_runner,
90	[tgt],
91	extra_args=[
92	f"--add-trailing-comma-interpreter-constraints=['=={major_minor_interpreter}.*']"
93	],
94	)
95	assert fmt_result.stdout == ""	3✔
96	assert fmt_result.output == rule_runner.make_snapshot({"f.py": GOOD_FILE})	3✔
97	assert fmt_result.did_change is False	3✔
98
99
100	def test_failing_source(rule_runner: PythonRuleRunner) -> None:	3✔
UNCOV 101	rule_runner.write_files({"f.py": BAD_FILE, "BUILD": "python_sources(name='t')"})	1✔
UNCOV 102	tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))	1✔
UNCOV 103	fmt_result = run_add_trailing_comma(rule_runner, [tgt])	1✔
UNCOV 104	assert fmt_result.output == rule_runner.make_snapshot({"f.py": GOOD_FILE})	1✔
UNCOV 105	assert fmt_result.did_change is True	1✔
106
107
108	def test_multiple_targets(rule_runner: PythonRuleRunner) -> None:	3✔
UNCOV 109	rule_runner.write_files(	1✔
110	{"good.py": GOOD_FILE, "bad.py": BAD_FILE, "BUILD": "python_sources(name='t')"}
111	)
UNCOV 112	tgts = [	1✔
113	rule_runner.get_target(Address("", target_name="t", relative_file_path="good.py")),
114	rule_runner.get_target(Address("", target_name="t", relative_file_path="bad.py")),
115	]
UNCOV 116	fmt_result = run_add_trailing_comma(rule_runner, tgts)	1✔
UNCOV 117	assert fmt_result.output == rule_runner.make_snapshot(	1✔
118	{"good.py": GOOD_FILE, "bad.py": GOOD_FILE}
119	)
UNCOV 120	assert fmt_result.did_change is True	1✔
121
122
123	def test_stub_files(rule_runner: PythonRuleRunner) -> None:	3✔
UNCOV 124	rule_runner.write_files(	1✔
125	{
126	"good.pyi": GOOD_FILE,
127	"good.py": GOOD_FILE,
128	"bad.pyi": BAD_FILE,
129	"bad.py": BAD_FILE,
130	"BUILD": "python_sources(name='t')",
131	}
132	)
133
UNCOV 134	good_tgts = [	1✔
135	rule_runner.get_target(Address("", target_name="t", relative_file_path="good.pyi")),
136	rule_runner.get_target(Address("", target_name="t", relative_file_path="good.py")),
137	]
UNCOV 138	fmt_result = run_add_trailing_comma(rule_runner, good_tgts)	1✔
UNCOV 139	assert fmt_result.stdout == ""	1✔
UNCOV 140	assert fmt_result.output == rule_runner.make_snapshot(	1✔
141	{"good.py": GOOD_FILE, "good.pyi": GOOD_FILE}
142	)
UNCOV 143	assert not fmt_result.did_change	1✔
144
UNCOV 145	bad_tgts = [	1✔
146	rule_runner.get_target(Address("", target_name="t", relative_file_path="bad.pyi")),
147	rule_runner.get_target(Address("", target_name="t", relative_file_path="bad.py")),
148	]
UNCOV 149	fmt_result = run_add_trailing_comma(rule_runner, bad_tgts)	1✔
UNCOV 150	assert fmt_result.output == rule_runner.make_snapshot(	1✔
151	{"bad.py": GOOD_FILE, "bad.pyi": GOOD_FILE}
152	)
UNCOV 153	assert fmt_result.did_change	1✔

pantsbuild / pants / 21552830208

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous