bazel-contrib / bazel-contrib/rules_python

[gazelle] Support relative python imports

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

Beschreibung

# 🚀 feature request

### Relevant Rules

+ gazelle

### Description

Sometimes a python code base uses relative imports:

```python
from .baz import Baz
from .same_package_other_module import cat_in_the_hat
from ..one_level_up import thing1
from ...two_levels_up import thing2
from .. import moduleA
```

While I don't necessarily agree with this style, it's something that Python supports (see [PEP 328](https://peps.python.org/pep-0328/#guido-s-decision)) and thus I believe that Gazelle should support it too.

Right now, Gazelle simply ignores these imports. Here's an example:

```
example/
__init__.py
a.py
b.py
BUILD.bazel
```

```python
# example/a.py
from . import b
del b
```

```python
# example/b.py
pass
```

```starlark
# example/BUILD.bazel
# as generated by Gazelle with "file" generation mode
load("@rules_python//python:defs.bzl", "py_library")

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

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

If we change a.py to use an absolute import:

```python
# example/a.py
from example import b
del b
```

Gazelle will add the dep:

```starlark
# example/BUILD.bazel
# as generated by Gazelle with "file" generation mode
load("@rules_python//python:defs.bzl", "py_library")

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

...
```

### Describe the solution you'd like

I'm somewhat familiar with the Gazelle code base. I believe it will be pretty easy (for the most part - see **Issues** below) below) to generate the full target path for the current file being processed, and then adjust the target based on how many dots `.` are in the relative import.

Because of the **Issues**, I'd imagine that this would be an experimental, opt-in feature for a while. It would be guarded by a directive:

```
# gazelle:experimental_allow_relative_imports true
```

Here are some examples of the logic, assuming a slightly more complex dir structure:

```
toplevel/
__init__.py
MODULE.bazel
BUILD.bazel
foo/
__init__.py
BUILD.bazel/
bar.py
baz.py
example/
__init__.py
a.py
b.py
BUILD.bazel
```

```
# relative import of another module "b.py" in same package "example"
# from . import b
read "from . import b" in file "example/a.py"
what is our current target? "//example:a"
We have 1 dot, so trim off 1 component ":a". target_stem = "//example"
Add the import "b". dep target name = "//example:b"
```

```
# relative import of a different packages's module
# from ..foo import bar
read "from ..foo import bar" in file "example/a.py"
current target? "//example:a"
We have 2 dots, so trim off 2 components "example:a". target_stem = "//"
Add the name from the dots and from the import. dep_target_name = "//foo:bar
```

```
# relative import of the parent packages's module "baz"
# from .. import baz
read "from .. import baz" in file "example/a.py"
current target? "//example:a"
We have 2 dots, so trim off 2 components "example:a". target_stem = "//"
There's no name after the dots, so the thing we're importing is a module (probably).
dep_target_name = "//:baz"
```

The above examples assume file-level generation. More thought will be needed to support package-level generation.

### Issues

It's difficult to know if `from ..foo import bar` should be `//:foo` or `//foo:bar`. Is `bar` a class/function? Or is `bar` another module? In the example above, it's a python module, but that's not always the case.

In the `from .. import baz` case, it's possible that `baz` is an identifier defined in the parent package's `__init__.py`, and thus the dep target would be `//:__init__`.

### Describe alternatives you've considered

I tried convincing the developers to use absolute imports, but they just weren't having it :rofl:

So I also tried using the "package" generation mode, but the issue was that unit test files also used relative imports and would not include the dep.

The current workaround is to add `# gazelle:include_dep //example:b` annotations, but those are prone to diverging from the actual code and can be tedious to write for large projects.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start by tracing Gazelle's existing handling of absolute Python imports and compare its file-level and package-level generation modes. Define how each relative-import form maps to a dependency, add opt-in support behind the proposed experimental_allow_relative_imports directive, and cover the examples and ambiguous cases with tests.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
build-system, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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