bazel-contrib / bazel-contrib/rules_python

Have `python_binary_naming_convention` directive also apply to `if __name__ == "__main__":` files

未关闭
#1,815 2 条评论 4 个 reaction 已指派 0 人 在 GitHub 查看
Can Close? gazelle
主要语言
Starlark
星标
688
派生
721
平均合并
15 小时 7 分钟
30 天内合并 PR
76

描述

# 🚀 feature request

### Relevant Rules

+ gazelle

### Description

The `python_binary_naming_convention` directive currently only applies to binaries that are generated from `__main__.py` files.

`py_binary` targets that are generated from files that contain `if __name__ == "__main__":` are named after their source file. From the [README](https://github.com/bazelbuild/rules_python/blob/e86252ffd6d1a1bf32ae99933acc5ab49b78ec1e/gazelle/README.md#binaries) (emphasis mine):

> If `python_generation_mode` is set to `file`, then instead of one `py_binary` target per module, Gazelle will create one `py_binary` target for each file with such a line, and **the name of the target will match the name of the script**.

This results in name collisions when a single file is both a binary and a library and gazelle will report:

> gazelle: failed to generate target "//foobar" of kind "py_binary": a target of kind "py_library" with the same name already exists

The readme also says:

> Note that it's possible for another script to depend on a py_binary target and import from the py_binary's scripts. This can have possible negative effects on Bazel analysis time and runfiles size compared to depending on a py_library target. The simplest way to avoid these negative effects is to extract library code into a separate script without a main line. Gazelle will then create a py_library target for that library code, and other scripts can depend on that py_library target.

However, for existing projects that might not be feasible.

### Describe the solution you'd like

Have `python_binary_naming_convention` directive also apply to files that contain `if __name__ ...`.

Or add another directive that accomplishes such.

### Describe alternatives you've considered

Right now I'm just manually making all ~450 or so `py_binary` targets that our monorepo has :sob:

```starlark
# libs are generated by gazelle
py_library(
name = "foo",
srcs = ["foo.py"],
deps = [
":bar",
"//bin/bom:boo",
"@pypi:hello",
],
)

# binaries are manually added, using the lib as a dependency so that I don't have to keep `deps` in sync.
py_binary(
name = "foo_bin",
srcs = ["foo.py"],
deps = [":foo"],
)
```

贡献指南

打开贡献指南

调研方向

从 Gazelle 的 `python_binary_naming_convention` 指令和 Gazelle README 的 Binaries 部分开始,比较从 `__main__.py` 生成与包含 `if __name__ == "__main__":` 的文件的生成方式。完成标准是该约定适用于这两种情况,并防止报告中的 `py_library`/`py_binary` 名称冲突。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
build-system, tooling
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
活跃
描述清晰度
基本清楚
新手友好度
55/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。