bazel-contrib / bazel-contrib/rules_python
[gazelle] docs issues
- Ngôn ngữ chính
- Starlark
- Star
- 688
- Fork
- 721
- Merge trung bình
- 15 giờ 7 phút
- Pull request đã merge (30 ngày)
- 76
Mô tả
# 🐞 Errors in Gazelle docs
### Description
The first code snippet in the [Adding Gazelle to Your Project](https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md#adding-gazelle-to-your-project) docs has errors.
1. It looks like `python = use_extension("@rules_python//python/extensions:python.bzl", "python")` needs to be added to avoid `ERROR: /.../MODULE.bazel:12:10: name 'python' is not defined`
2. The references to "python3_9" and "python3_9_toolchains" in the `use_repo` and `register_toolchains` calls are causing errors like `ERROR: /.../rules_python_gazelle_plugin~/modules_mapping/BUILD.bazel:3:10: While resolving toolchains for target @@rules_python_gazelle_plugin~//modules_mapping:generator (f0f11f9): invalid registered toolchain '@python3_9_toolchains//:all': No repository visible as '@python3_9_toolchains' from main repository.`
I tried adding an underscore before the "3_9" as per [this docstring](https://github.com/bazelbuild/rules_python/blob/main/python/private/bzlmod/python.bzl#L307) ("A toolchain's repository name uses the format `python_{major}_{minor}`, e.g. `python_3_10`") but that didn't help. I commented all those references out and instead added `python.toolchain(python_version="3.9", is_default=True)`, and seem to have gotten past this error, but I'm not sure if that has the exact same effect as the code that the docs intend you to add.
While in there, would be good to update to a newer version of Python, as 3.9 is several releases old (3.12 is latest stable).
## 🌍 Your Environment
**Operating System:**
reproduced on macOS and Linux
**Output of `bazel version`:**
reproduced on various versions of Bazel 7
**Rules_python version:**
0.33.1
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu với đoạn mã đầu tiên trong gazelle/README.md dưới mục “Adding Gazelle to Your Project” và tái tạo đoạn mã đó bằng rules_python 0.33.1 trên Bazel 7. So sánh đoạn mã với python/private/bzlmod/python.bzl, sau đó cập nhật tên các repository được ghi trong tài liệu và phiên bản Python để ví dụ hoạt động mà không gặp các lỗi toolchain đã được báo cáo.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- build-system, documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 48/100