Fix workspace option overrides (#2104)

* Add support for option overrides for workspaces. * Clean up errors

Author: cjames23

src/hatch/project/env.py

@@ -27,6 +27,7 @@
  "scripts": dict,
  "skip-install": bool,
  "type": str,
+ "workspace": dict,
 }
 
 
@@ -43,7 +44,11 @@ def apply_overrides(env_name, source, condition, condition_value, options, new_c
  continue
 
  override_type = option_types.get(option)
- if override_type in TYPE_OVERRIDES:
+ if option == "workspace":
+ _apply_override_to_workspace(
+ env_name, option, data, source, condition, condition_value, new_config, overwrite
+ )
+ elif override_type in TYPE_OVERRIDES:
  TYPE_OVERRIDES[override_type](
  env_name, option, data, source, condition, condition_value, new_config, overwrite
  )
@@ -300,6 +305,31 @@ def _apply_override_to_boolean(
  raise TypeError(message)
 
 
+def _apply_override_to_workspace(env_name, option, data, source, condition, condition_value, new_config, overwrite):
+ """Handle workspace dict with nested members/exclude/parallel."""
+ if not isinstance(data, dict):
+ message = f"Field `tool.hatch.envs.{env_name}.overrides.{source}.{condition}.{option}` must be a table"
+ raise TypeError(message)
+
+ # Get or create workspace dict
+ workspace = {} if overwrite else new_config.setdefault(option, {})
+
+ for key, value in data.items():
+ if key in {"members", "exclude"}:
+ # Delegate to array handler - pass workspace dict
+ _apply_override_to_array(env_name, key, value, source, condition, condition_value, workspace, overwrite)
+ elif key == "parallel":
+ # Delegate to boolean handler - pass workspace dict
+ _apply_override_to_boolean(env_name, key, value, source, condition, condition_value, workspace, overwrite)
+ else:
+ message = f"Unknown workspace option: {key}"
+ raise ValueError(message)
+
+ # Update new_config with the workspace dict
+ if overwrite or workspace:
+ new_config[option] = workspace
+
+
 def _resolve_condition(env_name, option, source, condition, condition_value, condition_config, condition_index=None):
  location = "field" if condition_index is None else f"entry #{condition_index} in field"
 

tests/project/test_config.py

@@ -11,8 +11,9 @@
 
 ARRAY_OPTIONS = [o for o, t in RESERVED_OPTIONS.items() if t is list]
 BOOLEAN_OPTIONS = [o for o, t in RESERVED_OPTIONS.items() if t is bool]
-MAPPING_OPTIONS = [o for o, t in RESERVED_OPTIONS.items() if t is dict]
+MAPPING_OPTIONS = [o for o, t in RESERVED_OPTIONS.items() if t is dict and o != "workspace"]
 STRING_OPTIONS = [o for o, t in RESERVED_OPTIONS.items() if t is str and o != "matrix-name-format"]
+WORKSPACE_OPTIONS = ["workspace"] # Workspace has nested structure, tested separately
 
 
 def construct_matrix_data(env_name, config, overrides=None):
@@ -2570,6 +2571,99 @@ def finalize_environments(self, config):
  assert project_config.envs == expected_envs
  assert project_config.matrices["foo"] == construct_matrix_data("foo", env_config)
 
+ @pytest.mark.parametrize("option", WORKSPACE_OPTIONS)
+ def test_overrides_matrix_workspace_invalid_type(self, isolation, option):
+ with pytest.raises(
+ TypeError,
+ match=f"Field `tool.hatch.envs.foo.overrides.matrix.version.{option}` must be a table",
+ ):
+ _ = ProjectConfig(
+ isolation,
+ {
+ "envs": {
+ "foo": {"matrix": [{"version": ["9000"]}], "overrides": {"matrix": {"version": {option: 9000}}}}
+ }
+ },
+ PluginManager(),
+ ).envs
+
+ @pytest.mark.parametrize("option", WORKSPACE_OPTIONS)
+ def test_overrides_matrix_workspace_members_append(self, isolation, option):
+ env_config = {
+ "foo": {
+ option: {"members": ["packages/core"]},
+ "matrix": [{"version": ["9000"]}, {"feature": ["bar"]}],
+ "overrides": {"matrix": {"version": {option: {"members": ["packages/extra"]}}}},
+ }
+ }
+ project_config = ProjectConfig(isolation, {"envs": env_config}, PluginManager())
+
+ expected_envs = {
+ "default": {"type": "virtual"},
+ "foo.9000": {"type": "virtual", option: {"members": ["packages/core", "packages/extra"]}},
+ "foo.bar": {"type": "virtual", option: {"members": ["packages/core"]}},
+ }
+
+ assert project_config.envs == expected_envs
+
+ @pytest.mark.parametrize("option", WORKSPACE_OPTIONS)
+ def test_overrides_matrix_workspace_members_conditional(self, isolation, option):
+ env_config = {
+ "foo": {
+ option: {"members": ["packages/core"]},
+ "matrix": [{"version": ["9000", "42"]}],
+ "overrides": {
+ "matrix": {"version": {option: {"members": [{"value": "packages/special", "if": ["42"]}]}}}
+ },
+ }
+ }
+ project_config = ProjectConfig(isolation, {"envs": env_config}, PluginManager())
+
+ expected_envs = {
+ "default": {"type": "virtual"},
+ "foo.9000": {"type": "virtual", option: {"members": ["packages/core"]}},
+ "foo.42": {"type": "virtual", option: {"members": ["packages/core", "packages/special"]}},
+ }
+
+ assert project_config.envs == expected_envs
+
+ @pytest.mark.parametrize("option", WORKSPACE_OPTIONS)
+ def test_overrides_matrix_workspace_parallel(self, isolation, option):
+ env_config = {
+ "foo": {
+ option: {"members": ["packages/*"], "parallel": True},
+ "matrix": [{"version": ["9000", "42"]}],
+ "overrides": {"matrix": {"version": {option: {"parallel": {"value": False, "if": ["42"]}}}}},
+ }
+ }
+ project_config = ProjectConfig(isolation, {"envs": env_config}, PluginManager())
+
+ expected_envs = {
+ "default": {"type": "virtual"},
+ "foo.9000": {"type": "virtual", option: {"members": ["packages/*"], "parallel": True}},
+ "foo.42": {"type": "virtual", option: {"members": ["packages/*"], "parallel": False}},
+ }
+
+ assert project_config.envs == expected_envs
+
+ @pytest.mark.parametrize("option", WORKSPACE_OPTIONS)
+ def test_overrides_matrix_workspace_overwrite(self, isolation, option):
+ env_config = {
+ "foo": {
+ option: {"members": ["packages/core"], "parallel": True},
+ "matrix": [{"version": ["9000"]}],
+ "overrides": {"matrix": {"version": {f"set-{option}": {"members": ["packages/new"]}}}},
+ }
+ }
+ project_config = ProjectConfig(isolation, {"envs": env_config}, PluginManager())
+
+ expected_envs = {
+ "default": {"type": "virtual"},
+ "foo.9000": {"type": "virtual", option: {"members": ["packages/new"]}},
+ }
+
+ assert project_config.envs == expected_envs
+
 
 class TestPublish:
  def test_not_table(self, isolation):

tests/workspaces/test_config.py

@@ -698,3 +698,129 @@ def test_workspace_development_workflow(self, temp_dir, hatch, monkeypatch):
  monkeypatch.setenv("FEATURE_PACKAGE", "utils")
  result = hatch("env", "create", "feature")
  assert result.exit_code == 0
+
+ result = hatch("env", "create", "release")
+ assert result.exit_code == 0
+
+ def test_workspace_overrides_matrix_conditional_members(self, temp_dir, hatch):
+ """Test workspace members added conditionally via matrix overrides."""
+ workspace_root = temp_dir / "workspace"
+ workspace_root.mkdir()
+
+ workspace_config = workspace_root / "pyproject.toml"
+ workspace_config.write_text("""
+ [project]
+ name = "workspace-root"
+ version = "0.1.0"
+
+ [[tool.hatch.envs.test.matrix]]
+ python = ["3.9", "3.11"]
+
+ [tool.hatch.envs.test]
+ workspace.members = ["packages/core"]
+
+ [tool.hatch.envs.test.overrides]
+ matrix.python.workspace.members = [
+ { value = "packages/py311-only", if = ["3.11"] }
+ ]
+ """)
+
+ packages_dir = workspace_root / "packages"
+ packages_dir.mkdir()
+
+ # Core package (always included)
+ core_dir = packages_dir / "core"
+ core_dir.mkdir()
+ (core_dir / "pyproject.toml").write_text("""
+ [project]
+ name = "core"
+ version = "0.1.0"
+ """)
+
+ # Python 3.11+ only package
+ py311_dir = packages_dir / "py311-only"
+ py311_dir.mkdir()
+ (py311_dir / "pyproject.toml").write_text("""
+ [project]
+ name = "py311-only"
+ version = "0.1.0"
+ """)
+
+ with workspace_root.as_cwd():
+ # Both environments should be created
+ result = hatch("env", "create", "test")
+ assert result.exit_code == 0
+
+ def test_workspace_overrides_platform_conditional_members(self, temp_dir, hatch):
+ """Test workspace members added conditionally via platform overrides."""
+ workspace_root = temp_dir / "workspace"
+ workspace_root.mkdir()
+
+ workspace_config = workspace_root / "pyproject.toml"
+ workspace_config.write_text("""
+ [project]
+ name = "workspace-root"
+ version = "0.1.0"
+
+ [tool.hatch.envs.default]
+ workspace.members = ["packages/core"]
+
+ [tool.hatch.envs.default.overrides]
+ platform.linux.workspace.members = ["packages/linux-specific"]
+ platform.windows.workspace.members = ["packages/windows-specific"]
+ """)
+
+ packages_dir = workspace_root / "packages"
+ packages_dir.mkdir()
+
+ for pkg in ["core", "linux-specific", "windows-specific"]:
+ pkg_dir = packages_dir / pkg
+ pkg_dir.mkdir()
+ (pkg_dir / "pyproject.toml").write_text(f"""
+ [project]
+ name = "{pkg}"
+ version = "0.1.0"
+ """)
+
+ with workspace_root.as_cwd():
+ result = hatch("env", "create")
+ assert result.exit_code == 0
+
+ def test_workspace_overrides_combined_conditions(self, temp_dir, hatch):
+ """Test workspace members with combined matrix and platform conditions."""
+ workspace_root = temp_dir / "workspace"
+ workspace_root.mkdir()
+
+ workspace_config = workspace_root / "pyproject.toml"
+ workspace_config.write_text("""
+ [project]
+ name = "workspace-root"
+ version = "0.1.0"
+
+ [[tool.hatch.envs.test.matrix]]
+ python = ["3.9", "3.11"]
+
+ [tool.hatch.envs.test]
+ workspace.members = ["packages/core"]
+
+ [tool.hatch.envs.test.overrides]
+ matrix.python.workspace.members = [
+ { value = "packages/linux-py311", if = ["3.11"], platform = ["linux"] }
+ ]
+ """)
+
+ packages_dir = workspace_root / "packages"
+ packages_dir.mkdir()
+
+ for pkg in ["core", "linux-py311"]:
+ pkg_dir = packages_dir / pkg
+ pkg_dir.mkdir()
+ (pkg_dir / "pyproject.toml").write_text(f"""
+ [project]
+ name = "{pkg}"
+ version = "0.1.0"
+ """)
+
+ with workspace_root.as_cwd():
+ result = hatch("env", "create", "test")
+ assert result.exit_code == 0