Merge pull request #90 from jwodder/gh-89

Don't run onbuild step for editable builds with Hatch

Author: jwodder

CHANGELOG.md

@@ -1,6 +1,8 @@
-v3.2.0 (in development)
+v3.1.2 (in development)
 -----------------------
 - Drop support for Python 3.7
+- **Bugfix**: When using `versioningit` with Hatch, don't run the `onbuild`
+  step for editable builds
 
 v3.1.1 (2024-04-29)
 -------------------

docs/changelog.rst

@@ -6,6 +6,8 @@ Changelog
 v3.2.0 (in development)
 -----------------------
 - Drop support for Python 3.7
+- **Bugfix**: When using `versioningit` with Hatch, don't run the `onbuild`
+  step for editable builds
 
 
 v3.1.1 (2024-04-29)

src/versioningit/__init__.py

@@ -43,7 +43,7 @@
 <https://versioningit.rtfd.io> for more information.
 """
 
-__version__ = "3.2.0.dev1"
+__version__ = "3.1.2.dev1"
 __author__ = "John Thorvald Wodder II"
 __author_email__ = "[email protected]"
 __license__ = "MIT"

src/versioningit/hatch.py

@@ -73,8 +73,11 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
         self.__tmpdir = Path(tempfile.mkdtemp())
 
-    def initialize(self, _version: str, build_data: dict[str, Any]) -> None:
+    def initialize(self, version: str, build_data: dict[str, Any]) -> None:
         init_logging()
+        if self.target_name == "wheel" and version == "editable":
+            log.debug("Not running onbuild step for editable build")
+            return None
         version_source = self.metadata.hatch.version.source
         if not isinstance(version_source, VersioningitSource):
             raise RuntimeError(

test/test_end2end.py

@@ -399,6 +399,10 @@ def test_editable_mode(cmd: list[str], tmp_path: Path) -> None:
         assert get_repo_status(srcdir) == status
         info = readcmd(sys.executable, "-m", "pip", "show", "mypackage")
         assert parse_version_from_metadata(info) == details.version
+        version_var = readcmd(
+            sys.executable, "-c", "import mypackage; print(mypackage.__version__)"
+        )
+        assert version_var == "NOT SET"
         for f in details.files:
             f.check(srcdir, "project")
     finally:
@@ -425,6 +429,10 @@ def test_editable_mode_hatch(tmp_path: Path) -> None:
         assert get_repo_status(srcdir) == status
         info = readcmd(sys.executable, "-m", "pip", "show", "mypackage")
         assert parse_version_from_metadata(info) == details.version
+        version_var = readcmd(
+            sys.executable, "-c", "import mypackage; print(mypackage.__version__)"
+        )
+        assert version_var == "NOT SET"
         for f in details.files:
             f.check(srcdir, "project")
     finally: