fix: Gazelle bug with merging py_binary targets in per-file mode and partial update (#2619)

This PR adds a new unit test. Currently, this is just a failing test
without a fix, and I am still trying to understand the code well enough
to find the root cause of the issue.

Our team uses Python+Gazelle in a monorepo, and we have a handful of
directories with multiple `.py` files containing `if __name__ ==
"__main__"`. Most of the time these are present for convenience or
ad-hoc invocation. We're aware of the [recommendation to split these
into separate
files](https://github.com/bazelbuild/rules_python/tree/main/gazelle#binaries),
but that can cause clutter, and it is non-obvious to most engineers what
to do when encountering this issue, which presents either as a
misleading error message or a no-op without creating the appropriate
targets.

**Update**
This bug occurs when ALL of the following are true:
* `python_generation_mode` is set to `file`.
* Multiple python binary files (files with `if __name__ == "__main__"`)
exist in the same directory.
* The directory has no `__main__.py` file.
* The `BUILD` file in the directory is partially complete, i.e. it
contains `py_binary` targets for some of the python files, but not
others.

In this situation, previously absent `py_binary` targets are merged into
existing `py_binary` targets instead of being created as new targets.

---------

Co-authored-by: Jimmy Tanner <jimmy@physicalintelligence.company>
9 files changed
tree: 52640b123deaf3240e94e4ff2e54b5f0a225001a
  1. .bazelci/
  2. .bcr/
  3. .ci/
  4. .github/
  5. docs/
  6. examples/
  7. gazelle/
  8. private/
  9. python/
  10. sphinxdocs/
  11. tests/
  12. third_party/
  13. tools/
  14. .bazelignore
  15. .bazelrc
  16. .bazelversion
  17. .git-blame-ignore-revs
  18. .gitattributes
  19. .gitignore
  20. .pre-commit-config.yaml
  21. .readthedocs.yml
  22. addlicense.sh
  23. AUTHORS
  24. BUILD.bazel
  25. BZLMOD_SUPPORT.md
  26. CHANGELOG.md
  27. CONTRIBUTING.md
  28. CONTRIBUTORS
  29. DEVELOPING.md
  30. internal_dev_deps.bzl
  31. internal_dev_setup.bzl
  32. LICENSE
  33. MODULE.bazel
  34. README.md
  35. RELEASING.md
  36. version.bzl
  37. WORKSPACE
  38. WORKSPACE.bzlmod
README.md

Python Rules for Bazel

Build status

Overview

This repository is the home of the core Python rules -- py_library, py_binary, py_test, py_proto_library, and related symbols that provide the basis for Python support in Bazel. It also contains package installation rules for integrating with PyPI and other indices.

Documentation for rules_python is at https://rules-python.readthedocs.io and in the Bazel Build Encyclopedia.

Examples live in the examples directory.

The core rules are stable. Their implementation is subject to Bazel's backward compatibility policy. This repository aims to follow semantic versioning.

The Bazel community maintains this repository. Neither Google nor the Bazel team provides support for the code. However, this repository is part of the test suite used to vet new Bazel releases. See How to contribute page for information on our development workflow.

Documentation

For detailed documentation, see https://rules-python.readthedocs.io

Bzlmod support

  • Status: Beta
  • Full Feature Parity: No

See Bzlmod support for more details.