Support wrapping build_editable in wrap. (#3105)

Author: jsirois

.gitignore

@@ -11,6 +11,7 @@ __pycache__/
 /.mypy_cache/
 /dist/
 /docs/_static_dynamic/
+/pex/docs/html/
 /pex/windows/stubs/
 /docker/cache/.env
 

CHANGES.md

@@ -1,5 +1,12 @@
 # Release Notes
 
+## 2.90.0
+
+This release adds support for wrapping PEP-660 `build_editable` to `pex_build.setuptools.build`
+plugins and dogfoods this.
+
+* Support wrapping `build_editable` in wrap. (#3105)
+
 ## 2.89.1
 
 This release adds better diagnostics for certain Pex filesystem interaction errors.

build-backend/pex_build/__init__.py

@@ -147,3 +147,25 @@ def modify_wheel(
             if vendor_spec.key in ("pip", "setuptools", "toml", "tomli"):
                 shutil.rmtree(os.path.join(wheel_dir, vendor_spec.relpath))
                 print("Removed un-needed vendored library", vendor_spec.relpath, file=sys.stderr)
+
+
+PEX_DIR = os.path.abspath(os.path.join(__file__, "..", "..", ".."))
+
+
+def modify_editable(
+    wheel_dir,  # type: str
+    dist_info_dir=None,  # type: Optional[str]
+):
+    # type: (...) -> None
+    for stub in windows.fetch_all_stubs(PEX_DIR):
+        print("Embedded Windows script stub", stub.path, file=sys.stderr)
+    if INCLUDE_DOCS:
+        out_dir = os.path.join(PEX_DIR, "pex", "docs")
+        subprocess.check_call(
+            args=[
+                sys.executable,
+                os.path.join("scripts", "build-docs.py"),
+                "--clean-html",
+                out_dir,
+            ]
+        )

build-backend/pex_build/setuptools/build.py

@@ -16,15 +16,6 @@
     from typing import Any, Dict, List, Optional
 
 
-def get_requires_for_build_editable(config_settings=None):
-    # type: (Optional[Dict[str, Any]]) -> List[str]
-
-    # N.B.: The default setuptools implementation would eventually return nothing, but only after
-    # running code that can temporarily pollute our project directory, foiling concurrent test runs;
-    # so we short-circuit the answer here. Faster and safer.
-    return []
-
-
 def get_requires_for_build_sdist(config_settings=None):
     # type: (Optional[Dict[str, Any]]) -> List[str]
 
@@ -105,3 +96,10 @@ def prepare_metadata_for_build_wheel(
             metadata_directory, config_settings=config_settings
         ),
     )
+
+
+@serialized_build
+def get_requires_for_build_editable(config_settings=None):
+    # type: (Optional[Dict[str, Any]]) -> List[str]
+
+    return cast("List[str]", get_requires_for_build_wheel(config_settings))

pex/build_backend/configuration.py

@@ -50,21 +50,36 @@ def wrap(cls, plugin):
                 "The `modify_wheel` attribute of pex.build_backend.wrap plugin {plugin} must be a "
                 "callable but given {value} of type {type}.".format(
                     plugin=qualified_name(plugin),
-                    value=modify_sdist,
-                    type=type(modify_sdist).__name__,
+                    value=modify_wheel,
+                    type=type(modify_wheel).__name__,
                 )
             )
 
-        if not modify_sdist and not modify_wheel:
+        modify_editable = getattr(plugin, "modify_editable", None)
+        if modify_editable and not callable(modify_editable):
             raise ConfigurationError(
-                "The pex.build_backend.wrap plugin {plugin} must define a `modify_sdist` function, "
-                "a `modify_wheel` or both; it has neither.".format(plugin=qualified_name(plugin))
+                "The `modify_editable` attribute of pex.build_backend.wrap plugin {plugin} must be "
+                "a callable but given {value} of type {type}.".format(
+                    plugin=qualified_name(plugin),
+                    value=modify_editable,
+                    type=type(modify_editable).__name__,
+                )
             )
 
-        return cls(modify_sdist=modify_sdist, modify_wheel=modify_wheel)
+        if not modify_sdist and not modify_wheel and not modify_editable:
+            raise ConfigurationError(
+                "The pex.build_backend.wrap plugin {plugin} must define at least one plugin "
+                "function: `modify_sdist`, `modify_wheel` or `modify_editable`; "
+                "it has none.".format(plugin=qualified_name(plugin))
+            )
+
+        return cls(
+            modify_sdist=modify_sdist, modify_wheel=modify_wheel, modify_editable=modify_editable
+        )
 
     _modify_sdist = attr.ib()  # type: Optional[Callable[[Text], None]]
     _modify_wheel = attr.ib()  # type: Optional[Callable[[Text, Text], None]]
+    _modify_editable = attr.ib()  # type: Optional[Callable[[Text, Optional[Text]], None]]
 
     @property
     def modifies_sdists(self):
@@ -92,6 +107,21 @@ def modify_wheel(
             return self._modify_wheel(wheel_dir, dist_info_dir_relpath)
         return None
 
+    @property
+    def modifies_editable(self):
+        # type: () -> bool
+        return self._modify_editable is not None
+
+    def modify_editable(
+        self,
+        wheel_dir,  # type: Text
+        dist_info_dir=None,  # type: Optional[Text]
+    ):
+        # type: (...) -> Any
+        if self._modify_editable:
+            return self._modify_editable(wheel_dir, dist_info_dir)
+        return None
+
 
 def _check_plugin(
     plugin,  # type: Any

pex/build_backend/wrap.py

@@ -169,3 +169,42 @@ def build_wheel(
         zf.writestr(record_zinfo, get_csv_bytes())
 
     return wheel_name
+
+
+def build_editable(
+    wheel_directory,  # type: str
+    config_settings=None,  # type: Optional[Dict[str, Any]]
+    metadata_directory=None,  # type: Optional[str]
+):
+    # type: (...) -> str
+
+    wheel_name = cast(
+        str,
+        _CONFIG.build_backend.build_editable(  # type: ignore[attr-defined]
+            wheel_directory, config_settings, metadata_directory
+        ),
+    )
+
+    plugins = tuple(plugin for plugin in _CONFIG.plugins if plugin.modifies_editable)
+    if not plugins:
+        return wheel_name
+
+    if not metadata_directory:
+        entries = glob.glob(os.path.join(wheel_directory, "*.dist-info"))
+        if len(entries) > 1:
+            raise BuildError(
+                "Calling `{backend}.build_editable` produced an wheel with unexpected contents.\n"
+                "Expected expected one top-level <project>-<version>.dist-info directory but found "
+                "{count}:\n"
+                "{entries}".format(
+                    backend=_CONFIG.delegate_build_backend,
+                    count=len(entries),
+                    entries="\n".join(entries),
+                )
+            )
+        metadata_directory = entries[0] if entries else None
+
+    for plugin in plugins:
+        plugin.modify_editable(wheel_dir=wheel_directory, dist_info_dir=metadata_directory)
+
+    return wheel_name

pex/version.py

@@ -1,4 +1,4 @@
 # Copyright 2015 Pex project contributors.
 # Licensed under the Apache License, Version 2.0 (see LICENSE).
 
-__version__ = "2.89.1"
+__version__ = "2.90.0"

pyproject.toml

@@ -200,6 +200,11 @@ vendor = [
 ]
 
 [tool.uv]
+cache-keys = [
+  { file = "pex/docs/html/index.html" },
+  { file = "pex/windows/stubs/*.exe" },
+]
+
 # This is used to force past a <2 upper bound in blacks deps, and it turns out black works just fine
 # with this version of tomli.
 override-dependencies = ["tomli==2.2.1; python_version >= '3.8'"]

tests/build_backend/test_configuration.py

@@ -296,14 +296,15 @@ class InvalidPlugin(object):
     pass
 
 
-def test_load_config_plugin_neither(write_config):
+def test_load_config_plugin_none(write_config):
     # type: (WriteConfig) -> None
 
     with pytest.raises(
         ConfigurationError,
         match=re.escape(
-            "The pex.build_backend.wrap plugin test_configuration.InvalidPlugin must define a "
-            "`modify_sdist` function, a `modify_wheel` or both; it has neither."
+            "The pex.build_backend.wrap plugin test_configuration.InvalidPlugin must define at "
+            "least one plugin function: `modify_sdist`, `modify_wheel` or `modify_editable`; "
+            "it has none."
         ),
     ):
         write_config(