PyO3/pyo3

`pyo3-build-config` cleanups

Open

#4761 aperta il 3 dic 2024

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Rust (668 fork)batch import
Good First Issuerefactoring

Metriche repository

Star
 (10.152 star)
Metriche merge PR
 (Merge medio 12g 19h) (64 PR mergiate in 30 g)

Descrizione

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 .

Guida contributor

Direzione di ricerca
Rivedi le modifiche nella PR #4758 per comprendere la correzione urgente del bug e la gestione delle variabili d'ambiente in pyo3 build config. Quindi progetta e implementa una struct BuildScriptContext che raccolga gli accessi all'ambiente per un tracciamento e test affidabili, e opzionalmente aggiungi un lint di Clippy per vietare l'accesso diretto alle variabili d'ambiente. Testa la nuova struct con la logica di ricompilazione di cargo per assicurarsi che non ci siano regressioni.
Tech stack
rust
Dominio
build systemdeveloper experience
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Rust programmingPyO3 build systemCargo build scripts
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40