bazel-contrib / bazel-contrib/rules_python

Gazelle python_root directive only adds imports to subfolders

Open
#2,571 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Starlark
Stars
688
Forks
721
Avg merge
15h 7m
Merged PRs (30d)
76

Description

# 🐞 bug report

### Affected Rule

Gazelle plugin target generation

### Is this a regression?

No

### Description

python targets that do not share root with the workspace needs `imports = [...]` statements added for imports to work correctly. The gazelle plugin supports this through adding `# gazelle:python_root` directives in `BUILD` files that are at the root of python trees. This works great for source files in subfolders, they have attributes like `imports = ["../.."],` added. However the sources files in the root folder itself does not get any imports attribute, while they need to have `imports = ["."]` to work correctly.

## 🔬 Minimal Reproduction

## 🔥 Exception or Error

Target py_binary file fails on run due to missing import.

## 🌍 Your Environment

**Operating System:**

  

Ubuntu 24.10

**Output of `bazel version`:**

  

Bazelisk version: v1.25.0
Build label: 8.0.1
Build target: @@//src/main/java/com/google/devtools/build/lib/bazel:BazelServer
Build time: Fri Jan 17 19:16:16 2025 (1737141376)
Build timestamp: 1737141376
Build timestamp as int: 1737141376

**Rules_python version:**

  

bazel_dep(name = "rules_python", version = "1.1.0")
bazel_dep(name = "rules_python_gazelle_plugin", version = "1.1.0")

**Anything else relevant?**

Contributor guide

Open the contributing guide

Research direction

Start by tracing Gazelle plugin target generation for BUILD files containing a `# gazelle:python_root` directive, focusing on root-level Python sources and generated `py_binary` targets. Compare root-folder targets with subfolder targets and verify that completed generation adds `imports = ["."]` where needed, then confirm the target runs without the missing-import failure.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.