bazel-contrib / bazel-contrib/rules_python

pipy dependency generated py_library ignores .pyc files in installed package.

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

描述

# 🐞 bug report

### Affected Rule

https://github.com/bazelbuild/rules_python/blob/main/docs/pypi-dependencies.md
Specifically `py_library` with `name = "pkg"` generated by
```
pip = use_extension("@rules_python//python/extensions:pip.bzl", "pip")
pip.parse(
hub_name = "my_deps",
python_version = "3.11",
requirements_lock = "//:requirements_lock_3_11.txt",
)
use_repo(pip, "my_deps")
```

### Is this a regression?

I don't know.

### Description

I couldn't import a module from pip package that ships python modules with .pyi and .pyc files.
For example, I have a example_package that ships with the following file structure
```
/example_package
__init__.py
foo.pyc
foo.pyi
```
According to https://peps.python.org/pep-3147/#flow-chart,
```
import foo from example_package
```
Should be successful. But the `py_library` generated specifically excludes `"**/*.pyc"` from `data`. If I manually remove the `"**/*.pyc"` exclusion, the import statement works.
```
py_library(
name = "pkg",
srcs = glob(
["site-packages/**/*.py"],
exclude=[],
# Empty sources are allowed to support wheels that don't have any
# pure-Python code, e.g. pymssql, which is written in Cython.
allow_empty = True,
),
data = [] + glob(
["site-packages/**/*"],
exclude=["**/* *", "**/*.py", "**/*.pyc", "**/*.pyc.*", "**/*.dist-info/RECORD"],
),
# This makes this directory a top-level in the python import
# search path for anything that depends on this.
imports = ["site-packages"],
deps = [],
tags = ["pypi_name=example_package", "pypi_version=3.21.0"],
visibility = ["//visibility:public"],
)
```

How
## 🔬 Minimal Reproduction

1. Creating a pip package following https://packaging.python.org/en/latest/ but replace the foo.py with compiled foo.pyc file.
2. Add pip dependency to a bazel workspace following guides in https://github.com/bazelbuild/rules_python/blob/main/docs/pypi-dependencies.md
3. In a py_library or py_binary, `import foo from example_package` should work but errors out with module not found error.

## 🔥 Exception or Error

```
ImportError: cannot import name 'foo' from 'example_package'
```

## 🌍 Your Environment

**Operating System:**

```
Linux
```

**Output of `bazel version`:**

  

Bazelisk version: v1.20.0
Build label: 7.0.2
Build target: @@//src/main/java/com/google/devtools/build/lib/bazel:BazelServer
Build time: Thu Jan 25 16:13:35 2024 (1706199215)
Build timestamp: 1706199215
Build timestamp as int: 1706199215

**Rules_python version:**

  

bazel_dep(name = "rules_python", version = "0.31.0")

**Anything else relevant?**

贡献指南

打开贡献指南

调研方向

先查看 docs/pypi-dependencies.md 以及其中所示的 pip.parse 配置,然后使用包含 foo.pyc 和 foo.pyi 的 package 重现生成的 py_library。将生成的 data glob 与报告中的 package 内容进行比较,并验证修复该问题后,在 Bazel 下从 example_package 导入 foo 是否成功。

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

评估

技术栈
python
领域
build-system
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

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