PyO3/pyo3

`pyo3-build-config` cleanups

Open

#4,761 创建于 2024年12月3日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Rust (10,152 star) (668 fork)batch import
Good First Issuerefactoring

描述

In https://github.com/PyO3/pyo3/pull/4758 I fixed the urgent bug with PYO3_CONFIG_FILE changes not correctly triggering rebuilds.

I think we can take action to ensure we don't have a similar accident again. I was playing around with various ideas, I've seen two so far which I think make sense:

  • A lot of pyo3-build-config APIs require being run in a build script. I wonder if we should have something like a BuildScriptContext struct which all those APIs take, and it can collect info about environment accesses so that we can both test them and emit to cargo reliably.
  • We can add clippy configuration to ban direct environment variable access, as suggested by @alex .

贡献者指南

技术栈
rust
领域
build systemdeveloper experience
议题类型
refactor
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Rust programmingPyO3 build systemCargo build scripts
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Review the changes in PR #4758 to understand the urgent bug fix and the environment variable handling in pyo3 build config. Then design and implement a BuildScriptContext struct that collects environment accesses for reliable tracking and testing, and optionally add a Clippy lint to ban direct environment variable access. Test the new struct with cargo's rebuild logic to ensure no regression.