feat: support MATURIN_PGO env var to activate --pgo

guide/src/distribution.md

@@ -55,6 +55,10 @@ Options:
 
           Requires `pgo-command` to be set in `[tool.maturin]` in pyproject.toml. This performs a three-phase build: instrumented build, profile training, and optimized rebuild.
 
+          Can also be enabled via the MATURIN_PGO environment variable.
+
+          [env: MATURIN_PGO=]
+
   -i, --interpreter [<INTERPRETER>...]
           The python versions to build wheels for, given as the executables of interpreters such as `python3.9` or `/usr/bin/python3.8`
 

guide/src/environment-variables.md

@@ -73,6 +73,7 @@ Config-settings take priority over `MATURIN_PEP517_ARGS`; the environment variab
   `MATURIN_PYODIDE_ABI_VERSION` when possible — wheels built with the legacy
   tag are not installable on PEP 783-compliant runtimes.
 * `MATURIN_STRIP`: Strip the library for minimum file size
+* `MATURIN_PGO`: Build with Profile-Guided Optimization (same as `--pgo`), works with `maturin build`, `maturin develop` and PEP 517 builds (e.g. `pip install .`). Set to `0`, `false`, `no` or `off` to disable, any other value enables it
 * `MATURIN_NO_MISSING_BUILD_BACKEND_WARNING`: Suppress missing build backend warning
 * `MATURIN_USE_XWIN`: Set to `1` to force to use `xwin` for cross compiling even on Windows that supports native compilation
 * `ANDROID_API_LEVEL`: The Android API level to target when cross compiling for Android

guide/src/local_development.md

@@ -27,6 +27,10 @@ Options:
 
           Implies `--release` unless `--profile` is specified.
 
+          Can also be enabled via the MATURIN_PGO environment variable.
+
+          [env: MATURIN_PGO=]
+
       --strip
           Strip the library for minimum file size
 

src/commands/pep517.rs

@@ -26,6 +26,9 @@ pub enum Pep517Command {
         metadata_directory: PathBuf,
         #[command(flatten)]
         strip_opt: StripOption,
+        /// Build with Profile-Guided Optimization (PGO)
+        #[arg(long, env = "MATURIN_PGO", value_parser = clap::builder::FalseyValueParser::new())]
+        pgo: bool,
     },
     #[command(name = "build-wheel")]
     /// Implementation of build_wheel
@@ -34,6 +37,9 @@ pub enum Pep517Command {
         build_options: BuildOptions,
         #[command(flatten)]
         strip_opt: StripOption,
+        /// Build with Profile-Guided Optimization (PGO)
+        #[arg(long, env = "MATURIN_PGO", value_parser = clap::builder::FalseyValueParser::new())]
+        pgo: bool,
         /// Build editable wheels
         #[arg(long)]
         editable: bool,
@@ -86,12 +92,14 @@ pub fn pep517(subcommand: Pep517Command) -> Result<()> {
             mut build_options,
             metadata_directory,
             strip_opt,
+            pgo,
         } => {
             require_single_interpreter(&mut build_options, "write-dist-info")?;
             let mut context = build_options
                 .into_build_context()
                 .strip(strip_opt.strip)
                 .editable(false)
+                .pgo(pgo)
                 .build()?;
             ensure_release_profile(&mut context);
 
@@ -111,13 +119,15 @@ pub fn pep517(subcommand: Pep517Command) -> Result<()> {
         Pep517Command::BuildWheel {
             mut build_options,
             strip_opt,
+            pgo,
             editable,
         } => {
             require_single_interpreter(&mut build_options, "build-wheel")?;
             let mut build_context = build_options
                 .into_build_context()
                 .strip(strip_opt.strip)
                 .editable(editable)
+                .pgo(pgo)
                 .build()?;
             ensure_release_profile(&mut build_context);
 

src/develop/mod.rs

@@ -46,7 +46,9 @@ pub struct DevelopOptions {
     /// and optimized rebuild.
     ///
     /// Implies `--release` unless `--profile` is specified.
-    #[arg(long)]
+    ///
+    /// Can also be enabled via the MATURIN_PGO environment variable.
+    #[arg(long, env = "MATURIN_PGO", value_parser = clap::builder::FalseyValueParser::new())]
     pub pgo: bool,
     /// Strip the library for minimum file size
     #[arg(long)]

src/main.rs

@@ -77,7 +77,9 @@ enum Command {
         /// Requires `pgo-command` to be set in `[tool.maturin]` in pyproject.toml.
         /// This performs a three-phase build: instrumented build, profile training,
         /// and optimized rebuild.
-        #[arg(long)]
+        ///
+        /// Can also be enabled via the MATURIN_PGO environment variable.
+        #[arg(long, env = "MATURIN_PGO", value_parser = clap::builder::FalseyValueParser::new())]
         pgo: bool,
         #[command(flatten)]
         build: BuildOptions,
@@ -98,7 +100,9 @@ enum Command {
         /// Build with Profile-Guided Optimization (PGO).
         ///
         /// Requires `pgo-command` to be set in `[tool.maturin]` in pyproject.toml.
-        #[arg(long)]
+        ///
+        /// Can also be enabled via the MATURIN_PGO environment variable.
+        #[arg(long, env = "MATURIN_PGO", value_parser = clap::builder::FalseyValueParser::new())]
         pgo: bool,
         #[command(flatten)]
         publish: PublishOpt,

tests/cmd/build.stdout

@@ -25,6 +25,10 @@ Options:
 
           Requires `pgo-command` to be set in `[tool.maturin]` in pyproject.toml. This performs a
           three-phase build: instrumented build, profile training, and optimized rebuild.
+
+          Can also be enabled via the MATURIN_PGO environment variable.
+
+          [env: MATURIN_PGO=]
 
   -i, --interpreter [<INTERPRETER>...]
           The python versions to build wheels for, given as the executables of interpreters such as

tests/cmd/develop.stdout

@@ -19,6 +19,10 @@ Options:
           three-phase build: instrumented build, profile training, and optimized rebuild.
 
           Implies `--release` unless `--profile` is specified.
+
+          Can also be enabled via the MATURIN_PGO environment variable.
+
+          [env: MATURIN_PGO=]
 
       --strip
           Strip the library for minimum file size

tests/cmd/publish.stdout

@@ -20,6 +20,10 @@ Options:
           Build with Profile-Guided Optimization (PGO).
 
           Requires `pgo-command` to be set in `[tool.maturin]` in pyproject.toml.
+
+          Can also be enabled via the MATURIN_PGO environment variable.
+
+          [env: MATURIN_PGO=]
 
   -r, --repository <REPOSITORY>
           The repository (package index) to upload the package to. Should be a section in the config