Rename 'environ' to 'env'

cibuildwheel/__main__.py

@@ -231,7 +231,7 @@ def build_in_directory(args: CommandLineArguments) -> None:
             )
             sys.exit(2)
 
-    options = compute_options(platform=platform, command_line_arguments=args, environ=os.environ)
+    options = compute_options(platform=platform, command_line_arguments=args, env=os.environ)
 
     package_dir = options.globals.package_dir
     package_files = {"setup.py", "setup.cfg", "pyproject.toml"}

cibuildwheel/options.py

@@ -192,11 +192,11 @@ def __init__(
         config_file_path: Path | None = None,
         *,
         platform: PlatformName,
-        environ: Mapping[str, str],
+        env: Mapping[str, str],
         disallow: dict[str, set[str]] | None = None,
     ) -> None:
         self.platform = platform
-        self.environ = environ
+        self.env = env
         self.disallow = disallow or {}
 
         # Open defaults.toml, loading both global and platform sections
@@ -337,8 +337,8 @@ def get(
         # get the option from the environment, then the config file, then finally the default.
         # platform-specific options are preferred, if they're allowed.
         result = _dig_first(
-            (self.environ if env_plat else {}, plat_envvar),
-            (self.environ, envvar),
+            (self.env if env_plat else {}, plat_envvar),
+            (self.env, envvar),
             *[(o.options, name) for o in active_config_overrides],
             (self.config_platform_options, name),
             (self.config_options, name),
@@ -384,17 +384,17 @@ def __init__(
         self,
         platform: PlatformName,
         command_line_arguments: CommandLineArguments,
-        environ: Mapping[str, str],
+        env: Mapping[str, str],
         read_config_file: bool = True,
     ):
         self.platform = platform
         self.command_line_arguments = command_line_arguments
-        self.environ = environ
+        self.env = env
 
         self.reader = OptionsReader(
             self.config_file_path if read_config_file else None,
             platform=platform,
-            environ=environ,
+            env=env,
             disallow=DISALLOWED_OPTIONS,
         )
 
@@ -428,13 +428,13 @@ def globals(self) -> GlobalOptions:
         test_skip = self.reader.get("test-skip", env_plat=False, sep=" ")
 
         prerelease_pythons = args.prerelease_pythons or strtobool(
-            self.environ.get("CIBW_PRERELEASE_PYTHONS", "0")
+            self.env.get("CIBW_PRERELEASE_PYTHONS", "0")
         )
 
         # This is not supported in tool.cibuildwheel, as it comes from a standard location.
         # Passing this in as an environment variable will override pyproject.toml, setup.cfg, or setup.py
         requires_python_str: str | None = (
-            self.environ.get("CIBW_PROJECT_REQUIRES_PYTHON") or self.package_requires_python_str
+            self.env.get("CIBW_PROJECT_REQUIRES_PYTHON") or self.package_requires_python_str
         )
         requires_python = None if requires_python_str is None else SpecifierSet(requires_python_str)
 
@@ -523,7 +523,7 @@ def build_options(self, identifier: str | None) -> BuildOptions:
             if self.platform == "linux":
                 for env_var_name in environment_pass:
                     with contextlib.suppress(KeyError):
-                        environment.add(env_var_name, self.environ[env_var_name])
+                        environment.add(env_var_name, self.env[env_var_name])
 
             if dependency_versions == "pinned":
                 dependency_constraints: None | (
@@ -625,7 +625,7 @@ def defaults(self) -> Options:
         return Options(
             platform=self.platform,
             command_line_arguments=CommandLineArguments.defaults(),
-            environ={},
+            env={},
             read_config_file=False,
         )
 
@@ -730,11 +730,9 @@ def option_summary_value(self, option_value: Any) -> str:
 def compute_options(
     platform: PlatformName,
     command_line_arguments: CommandLineArguments,
-    environ: Mapping[str, str],
+    env: Mapping[str, str],
 ) -> Options:
-    options = Options(
-        platform=platform, command_line_arguments=command_line_arguments, environ=environ
-    )
+    options = Options(platform=platform, command_line_arguments=command_line_arguments, env=env)
     options.check_for_deprecated_options()
     return options
 

unit_test/linux_build_steps_test.py

@@ -40,7 +40,7 @@ def test_linux_container_split(tmp_path: Path, monkeypatch):
     )
 
     monkeypatch.chdir(tmp_path)
-    options = Options("linux", command_line_arguments=args, environ={})
+    options = Options("linux", command_line_arguments=args, env={})
 
     python_configurations = cibuildwheel.linux.get_python_configurations(
         options.globals.build_selector, options.globals.architectures

unit_test/options_test.py

@@ -47,7 +47,7 @@ def test_options_1(tmp_path, monkeypatch):
 
     monkeypatch.setattr(platform_module, "machine", lambda: "x86_64")
 
-    options = Options(platform="linux", command_line_arguments=args, environ={})
+    options = Options(platform="linux", command_line_arguments=args, env={})
 
     identifiers = get_build_identifiers(
         platform="linux",
@@ -89,7 +89,7 @@ def test_passthrough(tmp_path, monkeypatch):
 
     monkeypatch.setattr(platform_module, "machine", lambda: "x86_64")
 
-    options = Options(platform="linux", command_line_arguments=args, environ={"EXAMPLE_ENV": "ONE"})
+    options = Options(platform="linux", command_line_arguments=args, env={"EXAMPLE_ENV": "ONE"})
 
     default_build_options = options.build_options(identifier=None)
 
@@ -118,7 +118,7 @@ def test_passthrough_evil(tmp_path, monkeypatch, env_var_value):
     options = Options(
         platform="linux",
         command_line_arguments=args,
-        environ={"CIBW_ENVIRONMENT_PASS_LINUX": "ENV_VAR", "ENV_VAR": env_var_value},
+        env={"CIBW_ENVIRONMENT_PASS_LINUX": "ENV_VAR", "ENV_VAR": env_var_value},
     )
 
     parsed_environment = options.build_options(identifier=None).environment
@@ -153,7 +153,7 @@ def test_toml_environment_evil(tmp_path, monkeypatch, env_var_value):
         )
     )
 
-    options = Options(platform="linux", command_line_arguments=args, environ={})
+    options = Options(platform="linux", command_line_arguments=args, env={})
     parsed_environment = options.build_options(identifier=None).environment
     assert parsed_environment.as_dictionary(prev_environment={}) == {"EXAMPLE": env_var_value}
 
@@ -189,7 +189,7 @@ def test_toml_environment_quoting(tmp_path: Path, toml_assignment, result_value)
         )
     )
 
-    options = Options(platform="linux", command_line_arguments=args, environ={})
+    options = Options(platform="linux", command_line_arguments=args, env={})
     parsed_environment = options.build_options(identifier=None).environment
     environment_values = parsed_environment.as_dictionary(
         prev_environment={**os.environ, "PARAM": "spam"},

unit_test/options_toml_test.py

@@ -35,7 +35,7 @@ def test_simple_settings(tmp_path, platform, fname):
     config_file_path: Path = tmp_path / fname
     config_file_path.write_text(PYPROJECT_1)
 
-    options_reader = OptionsReader(config_file_path, platform=platform, environ={})
+    options_reader = OptionsReader(config_file_path, platform=platform, env={})
 
     assert options_reader.get("build", env_plat=False, sep=" ") == "cp39*"
 
@@ -78,7 +78,7 @@ def test_envvar_override(tmp_path, platform, monkeypatch):
     options_reader = OptionsReader(
         config_file_path,
         platform=platform,
-        environ={
+        env={
             "CIBW_BUILD": "cp38*",
             "CIBW_MANYLINUX_X86_64_IMAGE": "manylinux_2_24",
             "CIBW_TEST_COMMAND": "mytest",
@@ -108,13 +108,13 @@ def test_project_global_override_default_platform(tmp_path, platform):
 repair-wheel-command = "repair-project-global"
 """
     )
-    options_reader = OptionsReader(pyproject_toml, platform=platform, environ={})
+    options_reader = OptionsReader(pyproject_toml, platform=platform, env={})
     assert options_reader.get("repair-wheel-command") == "repair-project-global"
 
 
 def test_env_global_override_default_platform(tmp_path, platform, monkeypatch):
     options_reader = OptionsReader(
-        platform=platform, environ={"CIBW_REPAIR_WHEEL_COMMAND": "repair-env-global"}
+        platform=platform, env={"CIBW_REPAIR_WHEEL_COMMAND": "repair-env-global"}
     )
     assert options_reader.get("repair-wheel-command") == "repair-env-global"
 
@@ -134,7 +134,7 @@ def test_env_global_override_project_platform(tmp_path, platform, monkeypatch):
     options_reader = OptionsReader(
         pyproject_toml,
         platform=platform,
-        environ={
+        env={
             "CIBW_REPAIR_WHEEL_COMMAND": "repair-env-global",
         },
     )
@@ -155,7 +155,7 @@ def test_global_platform_order(tmp_path, platform):
 repair-wheel-command = "repair-project-global"
 """
     )
-    options_reader = OptionsReader(pyproject_toml, platform=platform, environ={})
+    options_reader = OptionsReader(pyproject_toml, platform=platform, env={})
     assert options_reader.get("repair-wheel-command") == f"repair-project-{platform}"
 
 
@@ -171,7 +171,7 @@ def test_unexpected_key(tmp_path):
     )
 
     with pytest.raises(ConfigOptionError) as excinfo:
-        OptionsReader(pyproject_toml, platform="linux", environ={})
+        OptionsReader(pyproject_toml, platform="linux", env={})
 
     assert "repair-wheel-command" in str(excinfo.value)
 
@@ -188,7 +188,7 @@ def test_underscores_in_key(tmp_path):
     )
 
     with pytest.raises(ConfigOptionError) as excinfo:
-        OptionsReader(pyproject_toml, platform="linux", environ={})
+        OptionsReader(pyproject_toml, platform="linux", env={})
 
     assert "repair-wheel-command" in str(excinfo.value)
 
@@ -202,7 +202,7 @@ def test_unexpected_table(tmp_path):
 """
     )
     with pytest.raises(ConfigOptionError):
-        OptionsReader(pyproject_toml, platform="linux", environ={})
+        OptionsReader(pyproject_toml, platform="linux", env={})
 
 
 def test_unsupported_join(tmp_path):
@@ -213,7 +213,7 @@ def test_unsupported_join(tmp_path):
 build = ["1", "2"]
 """
     )
-    options_reader = OptionsReader(pyproject_toml, platform="linux", environ={})
+    options_reader = OptionsReader(pyproject_toml, platform="linux", env={})
 
     assert "1, 2" == options_reader.get("build", sep=", ")
     with pytest.raises(ConfigOptionError):
@@ -229,9 +229,9 @@ def test_disallowed_a(tmp_path):
 """
     )
     disallow = {"windows": {"manylinux-x86_64-image"}}
-    OptionsReader(pyproject_toml, platform="linux", disallow=disallow, environ={})
+    OptionsReader(pyproject_toml, platform="linux", disallow=disallow, env={})
     with pytest.raises(ConfigOptionError):
-        OptionsReader(pyproject_toml, platform="windows", disallow=disallow, environ={})
+        OptionsReader(pyproject_toml, platform="windows", disallow=disallow, env={})
 
 
 def test_environment_override_empty(tmp_path, monkeypatch):
@@ -247,7 +247,7 @@ def test_environment_override_empty(tmp_path, monkeypatch):
     options_reader = OptionsReader(
         pyproject_toml,
         platform="linux",
-        environ={
+        env={
             "CIBW_MANYLINUX_I686_IMAGE": "",
             "CIBW_MANYLINUX_AARCH64_IMAGE": "manylinux1",
         },
@@ -320,7 +320,7 @@ def test_pyproject_2(tmp_path, platform):
     pyproject_toml: Path = tmp_path / "pyproject.toml"
     pyproject_toml.write_text(PYPROJECT_2)
 
-    options_reader = OptionsReader(config_file_path=pyproject_toml, platform=platform, environ={})
+    options_reader = OptionsReader(config_file_path=pyproject_toml, platform=platform, env={})
     assert options_reader.get("test-command") == "pyproject"
 
     with options_reader.identifier("random"):
@@ -344,7 +344,7 @@ def test_overrides_not_a_list(tmp_path, platform):
     )
 
     with pytest.raises(ConfigOptionError):
-        OptionsReader(config_file_path=pyproject_toml, platform=platform, environ={})
+        OptionsReader(config_file_path=pyproject_toml, platform=platform, env={})
 
 
 def test_config_settings(tmp_path):
@@ -357,7 +357,7 @@ def test_config_settings(tmp_path):
 """
     )
 
-    options_reader = OptionsReader(config_file_path=pyproject_toml, platform="linux", environ={})
+    options_reader = OptionsReader(config_file_path=pyproject_toml, platform="linux", env={})
     assert (
         options_reader.get("config-settings", table={"item": '{k}="{v}"', "sep": " "})
         == 'example="one" other="two" other="three"'
@@ -373,7 +373,7 @@ def test_pip_config_settings(tmp_path):
 """
     )
 
-    options_reader = OptionsReader(config_file_path=pyproject_toml, platform="linux", environ={})
+    options_reader = OptionsReader(config_file_path=pyproject_toml, platform="linux", env={})
     assert (
         options_reader.get(
             "config-settings", table={"item": "--config-settings='{k}=\"{v}\"'", "sep": " "}