Skip to content

Skip indexing py_binary rules if a corresponding py_library rule contains the same srcs #2822

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.

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
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

yushan26
Copy link

@yushan26 yushan26 commented Apr 24, 2025

This PR ensures that py_binary rules are not indexed into Gazelle's IndexMap when there is a corresponding py_library rule with the same srcs. When both py_library and py_binary targets share the same file in their srcs, Gazelle previously indexed both under the same import path. This led to ambiguity and resolution errors, as Gazelle found multiple rules for the same language (py).

To resolve this, the PR updates Gazelle to skip indexing py_binary rules, allowing py_library to be the only import being indexed.

Testing
An integration test was added where both a py_library and a py_binary rule include the same script.py in their srcs. The test verifies that Gazelle correctly resolves the import to the py_library target.

@arrdem
Copy link
Contributor

arrdem commented May 7, 2025

I don't think that just not indexing py_binary sources is a workable solution. A pattern we've seen before is that users will want to consider sources part of a py_binary and explicitly not want to manage what's perceived to be a duplicate py_library target, instead expecting other use sites to depend on that fileset via the py_binary target.

This has obvious downsides in that the entrypoint script gets materialized among other things, but it's an existing and working use-case.

I think the behavior in this case should simply be to prefer the library target in case both are an option, not ignoring binaries entirely.

@linzhp
Copy link
Contributor

linzhp commented May 8, 2025

A pattern we've seen before is that users will want to consider sources part of a py_binary and explicitly not want to manage what's perceived to be a duplicate

Are you talking about the scenarios when py_binary is generated but not py_library?

@yushan26 yushan26 force-pushed the index-py-library branch from cbeaaf2 to d37082d Compare May 8, 2025 19:51
@yushan26 yushan26 changed the title Skip indexing py_binary rules Skip indexing py_binary rules if a corresponding py_library rule contains the same srcs May 8, 2025
@yushan26
Copy link
Author

yushan26 commented May 8, 2025

Gotcha, I updated the logic to skip indexing the py_binary rule only if there is a corresponding py_library rule that also has the samesrcs populated. Let me know if this makes sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants