Allow optional output directory for building (#527)

Author: AdamWRichardson

src/poetry/core/masonry/builder.py

@@ -21,7 +21,13 @@ def __init__(self, poetry: Poetry) -> None:
             "wheel": WheelBuilder,
         }
 
-    def build(self, fmt: str, executable: str | Path | None = None) -> None:
+    def build(
+        self,
+        fmt: str,
+        executable: str | Path | None = None,
+        *,
+        target_dir: Path | None = None,
+    ) -> None:
         if fmt in self._formats:
             builders = [self._formats[fmt]]
         elif fmt == "all":
@@ -30,4 +36,4 @@ def build(self, fmt: str, executable: str | Path | None = None) -> None:
             raise ValueError(f"Invalid format: {fmt}")
 
         for builder in builders:
-            builder(self._poetry, executable=executable).build()
+            builder(self._poetry, executable=executable).build(target_dir)

tests/masonry/test_builder.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+import shutil
+
+from contextlib import contextmanager
+from pathlib import Path
+from typing import TYPE_CHECKING
+from typing import Iterator
+
+import pytest
+
+from poetry.core.factory import Factory
+from poetry.core.masonry.builder import Builder
+
+
+if TYPE_CHECKING:
+    from poetry.core.poetry import Poetry
+
+
+def get_project(name: str) -> Path:
+    project_directory = Path(__file__).parent / "builders" / "fixtures" / name
+    assert project_directory.is_dir()
+    return project_directory
+
+
+@contextmanager
+def get_project_context(name: str) -> Iterator[Path]:
+    project_directory = get_project(name)
+    try:
+        yield project_directory
+    finally:
+        shutil.rmtree(project_directory / "dist")
+
+
+def get_poetry(name: str) -> Poetry:
+    return Factory().create_poetry(get_project(name))
+
+
+def get_package_glob(poetry: Poetry) -> str:
+    return f"{poetry.package.name.replace('-', '_')}-{poetry.package.version}*"
+
+
+def test_builder_factory_raises_error_when_format_is_not_valid() -> None:
+    with pytest.raises(ValueError, match=r"Invalid format.*"):
+        Builder(get_poetry("complete")).build("not_valid")
+
+
+@pytest.mark.parametrize("format", ["sdist", "wheel", "all"])
+def test_builder_creates_places_built_files_in_specified_directory(
+    tmp_path: Path, format: str
+) -> None:
+    poetry = get_poetry("complete")
+    Builder(poetry).build(format, target_dir=tmp_path)
+    build_artifacts = tuple(tmp_path.glob(get_package_glob(poetry)))
+    assert len(build_artifacts) > 0
+    assert all(archive.exists() for archive in build_artifacts)
+
+
+@pytest.mark.parametrize("format", ["sdist", "wheel", "all"])
+def test_builder_creates_packages_in_dist_directory_if_no_output_is_specified(
+    format: str,
+) -> None:
+    with get_project_context("complete") as project:
+        poetry = Factory().create_poetry(project)
+        Builder(poetry).build(format, target_dir=None)
+        package_directory = project / "dist"
+        build_artifacts = tuple(package_directory.glob(get_package_glob(poetry)))
+        assert package_directory.is_dir()
+        assert len(build_artifacts) > 0
+        assert all(archive.exists() for archive in build_artifacts)