bazel-contrib / bazel-contrib/rules_python

[gazelle] `python_ignore_files` directive incorrectly (?) ignores files with the same name in subpackages

Aperta
#2,147 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
gazelle help wanted
Lingua principale
Starlark
Stelle
688
Fork
721
Merge medio
15h 7m
PR unite (30g)
76

Descrizione

# 🐞 bug report

### Affected Rule

+ gazelle

### Is this a regression?

No, I think this is as-built.

### Description

If you set `# gazelle:python_ignore_files foo.py` in your root dir, **all** files named `foo.py` will be ignored.

I'm not sure if this is WAI or not, but either way it's unexpected/undocumented behavior.

Instead, the `python_ignore_files` should do **one** of the following:
1. only act on the current Bazel package
2. only act on non-wildcard paths relative to the Bazel package that the directive is defined in
3. only act on glob expansions relative to the Bazel package that the directive is defined in

(1) is the behavior that _I_[^1] expected based on the limited documentation.

(2) is pretty nice because then you could put all of your ignores in a toplevel BUILD file, but it could mean a lot of duplication if you always want to ignore all "foo.py" that exist

(3) is the most complex to implement but also the most flexible. And even being "most complex", I don't imagine it's all that complicated.

[^1]: I can't say what other people expected, haha

## 🔬 Minimal Reproduction

1. Make this directory structure:

```
.
├── bar
│   ├── baz.py
│   ├── BUILD
│   └── some_other.py
├── foo
│   ├── baz.py
│   └── BUILD
├── __init__.py
└── BUILD
```

2. Set these directives:

```starlark
# ./BUILD
# gazelle:ignore baz.py
```

3. Run Gazelle

### Expected Behavior

There is no `./baz.py` file, so targets are generated for `bar/baz.py`, `bar/some_other.py`, and `foo/baz.py` in their respective BUILD files.

### Actual Behavior

Only `bar/some_other.py` has a target generated.

## 🔥 Exception or Error

N/A

## 🌍 Your Environment

**Operating System:**

gLinux (Debian Bookworm-based)

**Output of `bazel version`:**

7.2.0

**Rules_python version:**

0.33.1

**Anything else relevant?**

Related to #2108.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dal file BUILD root e dai file BUILD sotto bar/ e foo/ nella riproduzione minima, quindi esegui Gazelle per osservare come viene applicata la direttiva root `gazelle:ignore baz.py`. Determina quale dei tre comportamenti di ambito proposti dovrebbe essere supportato e verifica che vengano generati targets per bar/baz.py e foo/baz.py, mentre il comportamento previsto del file a livello root rimane corretto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
build-system, tooling
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.