Skip to content

Gazelle: Delete stale py_library and py_test targets #3817

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.

Sign up for GitHub

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

Open
taowang487 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Gazelle: Delete stale py_library and py_test targets #3817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26bcb8a
refactor(gazelle): rename remove_invalid_library test to remove_inval…
taowang487 Jun 9, 2026
ad0e48c
test(gazelle): add test cases for stale per-file py_library and py_te…
taowang487 Jun 9, 2026
d32fb7b
fix(gazelle): remove stale py_library and py_test targets with missin…
taowang487 Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 31 additions & 4 deletions gazelle/python/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,26 +593,53 @@ func (py *Python) getRulesWithInvalidSrcs(args language.GenerateArgs, validFiles
validFilesMap[file] = struct{}{}
}

// allFilesMap extends validFilesMap with all regular files on disk.
// py_binary uses validFilesMap (main modules + generated files), while py_library
// and py_test use allFilesMap since any file is a valid src for them.
allFilesMap := make(map[string]struct{}, len(validFilesMap)+len(args.RegularFiles))
for file := range validFilesMap {
allFilesMap[file] = struct{}{}
}
for _, file := range args.RegularFiles {
allFilesMap[file] = struct{}{}
}
Comment on lines +596 to +605

@gemini-code-assist gemini-code-assist Bot Jun 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

If __main__.py is present in the package, it is the standard entry point for py_binary targets. However, since __main__.py is not added to validFilesMap (which only contains main modules detected in appendPyLibrary and generated files), any existing py_binary target (including custom ones) that uses __main__.py as a source will be incorrectly marked as invalid and deleted by Gazelle.

We should ensure __main__.py is added to validFilesMap if it exists in args.RegularFiles.

	// allFilesMap extends validFilesMap with all regular files on disk.
	// py_binary uses validFilesMap (main modules + generated files), while py_library
	// and py_test use allFilesMap since any file is a valid src for them.
	allFilesMap := make(map[string]struct{}, len(validFilesMap)+len(args.RegularFiles))
	for file := range validFilesMap {
		allFilesMap[file] = struct{}{}
	}
	for _, file := range args.RegularFiles {
		allFilesMap[file] = struct{}{}
		if file == pyBinaryEntrypointFilename {
			validFilesMap[pyBinaryEntrypointFilename] = struct{}{}
		}
	}

@taowang487 taowang487 Jun 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I don't think this comment is correct. Also added a test case for __main__.py in commit ad0e48c and the test can pass.

This target is not deleted by Gazelle

py_binary(
    name = "remove_invalid_per_file_bin",
    srcs = ["__main__.py"],
    main = "__main__.py",
    visibility = ["//:__subpackages__"],
)


isTarget := func(src string) bool {
return strings.HasPrefix(src, "@") || strings.HasPrefix(src, "//") || strings.HasPrefix(src, ":")
}
for _, existingRule := range args.File.Rules {
if !kindMatches(args.Config, existingRule, pyBinaryKind) {
var matchedKind string
var filesMap map[string]struct{}
if kindMatches(args.Config, existingRule, pyBinaryKind) {
matchedKind = pyBinaryKind
filesMap = validFilesMap
} else if kindMatches(args.Config, existingRule, pyLibraryKind) {
matchedKind = pyLibraryKind
filesMap = allFilesMap
} else if kindMatches(args.Config, existingRule, pyTestKind) {
matchedKind = pyTestKind
filesMap = allFilesMap
} else {
continue
}

srcs := existingRule.AttrStrings("srcs")
if len(srcs) == 0 {
continue
}
var hasValidSrcs bool
for _, src := range existingRule.AttrStrings("srcs") {
for _, src := range srcs {
if isTarget(src) {
hasValidSrcs = true
break
}
if _, ok := validFilesMap[src]; ok {
if _, ok := filesMap[src]; ok {
hasValidSrcs = true
break
}
}
if !hasValidSrcs {
invalidRules = append(invalidRules, newTargetBuilder(pyBinaryKind, existingRule.Name(), "", "", nil, false).build())
invalidRules = append(invalidRules, newTargetBuilder(matchedKind, existingRule.Name(), "", "", nil, false).build())
}
}
return invalidRules
Expand Down
0 .../testdata/remove_invalid_library/BUILD.in → ...ove_invalid_library_package_mode/BUILD.in
View file
Open in desktop
File renamed without changes.
0 ...testdata/remove_invalid_library/BUILD.out → ...ve_invalid_library_package_mode/BUILD.out
View file
Open in desktop
File renamed without changes.
0 ...testdata/remove_invalid_library/README.md → ...ve_invalid_library_package_mode/README.md
View file
Open in desktop
File renamed without changes.
0 ...testdata/remove_invalid_library/WORKSPACE → ...ve_invalid_library_package_mode/WORKSPACE
View file
Open in desktop
File renamed without changes.
0 ...estdata/remove_invalid_library/my_test.py → ...e_invalid_library_package_mode/my_test.py
View file
Open in desktop
File renamed without changes.
0 ...ta/remove_invalid_library/others/BUILD.in → ...alid_library_package_mode/others/BUILD.in
View file
Open in desktop
File renamed without changes.
0 ...a/remove_invalid_library/others/BUILD.out → ...lid_library_package_mode/others/BUILD.out
View file
Open in desktop
File renamed without changes.
0 ...testdata/remove_invalid_library/test.yaml → ...ve_invalid_library_package_mode/test.yaml
View file
Open in desktop
File renamed without changes.
36 changes: 36 additions & 0 deletions gazelle/python/testdata/remove_invalid_per_file/BUILD.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

# gazelle:python_generation_mode file

py_library(
name = "bar",
srcs = ["bar.py"],
visibility = ["//:__subpackages__"],
)

py_library(
name = "deleted_lib",
srcs = ["deleted.py"],
visibility = ["//:__subpackages__"],
)

py_binary(
name = "remove_invalid_per_file_bin",
srcs = ["__main__.py"],
visibility = ["//:__subpackages__"],
)

py_binary(
name = "deleted_bin",
srcs = ["deleted_bin.py"],
)

py_test(
name = "bar_test",
srcs = ["bar_test.py"],
)

py_test(

@dougthor42 dougthor42 Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please add some test cases for aliased and mapped rules. For example, someone who has # gazelle:alias_kind my_py_test py_test or # gazelle:map_kind py_binary my_py_binary //bazel_wrappers:python.

It should be OK because you're using kindMatches, but I'd prefer the explicit test.

name = "deleted_test",
srcs = ["deleted_test.py"],
)
21 changes: 21 additions & 0 deletions gazelle/python/testdata/remove_invalid_per_file/BUILD.out
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

# gazelle:python_generation_mode file

py_library(
name = "bar",
srcs = ["bar.py"],
visibility = ["//:__subpackages__"],
)

py_test(
name = "bar_test",
srcs = ["bar_test.py"],
)

py_binary(
name = "remove_invalid_per_file_bin",
srcs = ["__main__.py"],
main = "__main__.py",
visibility = ["//:__subpackages__"],
)
1 change: 1 addition & 0 deletions gazelle/python/testdata/remove_invalid_per_file/WORKSPACE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# This is a Bazel workspace for the Gazelle test data.
Empty file added gazelle/python/testdata/remove_invalid_per_file/__main__.py
View file
Open in desktop
Empty file.
Empty file added gazelle/python/testdata/remove_invalid_per_file/bar.py
View file
Open in desktop
Empty file.
Empty file added gazelle/python/testdata/remove_invalid_per_file/bar_test.py
View file
Open in desktop
Empty file.
1 change: 1 addition & 0 deletions gazelle/python/testdata/remove_invalid_per_file/test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
---