PyO3/pyo3

`pyo3-build-config` cleanups

Open

#4,761 opened on Dec 3, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (10,152 stars) (668 forks)batch import
Good First Issuerefactoring

Description

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 .

Contributor guide

Tech stack
rust
Domain
build systemdeveloper experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust programmingPyO3 build systemCargo build scripts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.
`pyo3-build-config` cleanups · PyO3/pyo3#4761 | Good First Issue