bazel-contrib / bazel-contrib/rules_python

Gazelle: Presence of `__main__.py` prevents other `*.py` files from being mapped as `py_binary` targets

Offen
#3,337 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Starlark
Sterne
688
Forks
721
Ø Merge
15 Std. 7 Min.
Gemergte PRs (30 T.)
76

Beschreibung

# 🐞 bug report

### Affected Rule

Gazelle

### Is this a regression?

Still checking

### Description

Presence of `__main__.py` prevents other `*.py` files from being mapped as `py_binary` targets.

## 🔬 Minimal Reproduction

Add one file to `gazelle/python/testdata/per_file`:

```python
# gazelle/python/testdata/per_file/my_binary.py
if __name__ == "__main__":
print("hey")
```

Run the test (from the `gazelle/` dir) `bazel test //python:python_test_per_file` and see that a `py_binary` target is added. So far so good!

Now add a `__main__.py` file, no content needed: `touch gazelle/python/testdata/per_file/__main__.py`

And run the test again. You'll see that `my_binary.py` was incorrectly added as a `py_library` target.

## Other

This is the "correct" `BUILD.out` file:

```diff
--- a/gazelle/python/testdata/per_file/BUILD.out
+++ b/gazelle/python/testdata/per_file/BUILD.out
@@ -1,4 +1,4 @@
-load("@rules_python//python:defs.bzl", "py_library", "py_test")
+load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

# gazelle:python_generation_mode file

@@ -23,6 +23,19 @@ py_library(
deps = [":custom"],
)

+py_binary(
+ name = "my_binary",
+ srcs = ["my_binary.py"],
+ visibility = ["//:__subpackages__"],
+)
+
+py_binary(
+ name = "per_file_bin",
+ srcs = ["__main__.py"],
+ main = "__main__.py",
+ visibility = ["//:__subpackages__"],
+)
+
py_test(
name = "bar_test",
srcs = ["bar_test.py"],
```

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start by running bazel test //python:python_test_per_file from the gazelle/ directory, using gazelle/python/testdata/per_file and its BUILD.out expectation as the fixture. Compare the output with and without __main__.py, then update the relevant Gazelle behavior and test expectation so my_binary.py remains a py_binary and the __main__.py target is also generated correctly.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
build-system
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.