Merge pull request #19 from python-project-templates/tkp/sys

Ensure sys wheels built, libs included

Author: timkpaine

hatch_rs/plugin.py

@@ -2,6 +2,9 @@
 
 from logging import getLogger
 from os import getenv
+from pathlib import Path
+from platform import machine as platform_machine
+from sys import platform as sys_platform, version_info
 from typing import Any
 
 from hatchling.builders.hooks.plugin.interface import BuildHookInterface
@@ -63,12 +66,12 @@ def initialize(self, version: str, build_data: dict[str, Any]) -> None:
         # Perform any cleanup actions
         build_plan.cleanup()
 
-        # if build_plan.libraries:
-        #     # force include libraries
-        #     # for library in build_plan.libraries:
-        #     #     name = library.get_qualified_name(build_plan.platform.platform)
-        #     #     build_data["force_include"][name] = name
+        if not build_plan._libraries:
+            raise ValueError("No libraries were created by the build.")
 
+        # force include libraries
+        # for library in build_plan._libraries:
+        #     build_data["force_include"][library] = library
         #     build_data["pure_python"] = False
         #     machine = platform_machine()
         #     version_major = version_info.major
@@ -83,28 +86,28 @@ def initialize(self, version: str, build_data: dict[str, Any]) -> None:
         #         build_data["tag"] = f"cp{version_major}{version_minor}-abi3-{os_name}_{machine}"
         #     else:
         #         build_data["tag"] = f"cp{version_major}{version_minor}-cp{version_major}{version_minor}-{os_name}_{machine}"
-        # else:
-        #     build_data["pure_python"] = False
-        #     machine = platform_machine()
-        #     version_major = version_info.major
-        #     version_minor = version_info.minor
-        #     # TODO abi3
-        #     if "darwin" in sys_platform:
-        #         os_name = "macosx_11_0"
-        #     elif "linux" in sys_platform:
-        #         os_name = "linux"
-        #     else:
-        #         os_name = "win"
-        #     build_data["tag"] = f"cp{version_major}{version_minor}-cp{version_major}{version_minor}-{os_name}_{machine}"
-
-        #     # force include libraries
-        #     for path in Path(".").rglob("*"):
-        #         if path.is_dir():
-        #             continue
-        #         if str(path).startswith(str(build_plan.cmake.build)) or str(path).startswith("dist"):
-        #             continue
-        #         if path.suffix in (".pyd", ".dll", ".so", ".dylib"):
-        #             build_data["force_include"][str(path)] = str(path)
-
-        # for path in build_data["force_include"]:
-        #     self._logger.warning(f"Force include: {path}")
+        build_data["pure_python"] = False
+        machine = platform_machine()
+        version_major = version_info.major
+        version_minor = version_info.minor
+
+        # TODO abi3
+        if "darwin" in sys_platform:
+            os_name = "macosx_11_0"
+        elif "linux" in sys_platform:
+            os_name = "linux"
+        else:
+            os_name = "win"
+        build_data["tag"] = f"cp{version_major}{version_minor}-cp{version_major}{version_minor}-{os_name}_{machine}"
+
+        # force include libraries
+        for path in Path(".").rglob("*"):
+            if path.is_dir():
+                continue
+            if str(path).startswith("target") or str(path).startswith("dist"):
+                continue
+            if path.suffix in (".pyd", ".dll", ".so", ".dylib"):
+                build_data["force_include"][str(path)] = str(path)
+
+        for path in build_data["force_include"]:
+            self._logger.warning(f"Force include: {path}")

hatch_rs/structs.py

@@ -7,7 +7,7 @@
 from sys import platform as sys_platform
 from typing import List, Literal, Optional
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, Field, PrivateAttr, field_validator
 
 __all__ = (
     "HatchRustBuildConfig",
@@ -52,6 +52,8 @@ class HatchRustBuildPlan(HatchRustBuildConfig):
     build_type: BuildType = "release"
     commands: List[str] = Field(default_factory=list)
 
+    _libraries: List[str] = PrivateAttr(default_factory=list)
+
     def generate(self):
         self.commands = []
 
@@ -145,14 +147,16 @@ def execute(self):
 
             # Copy each file to the current directory
             if sys_platform == "win32":
-                copy_command = f"copy {file} {cwd}\\{self.module}\\{file_name}.pyd"
+                library_name = f"{self.module}\\{file_name}.pyd"
+                self._libraries.append(library_name)
+                copy_command = f"copy {file} {cwd}\\{library_name}"
             else:
                 if which("cp") is None:
                     raise EnvironmentError("cp command not found. Ensure it is installed and available in PATH.")
-                copy_command = f"cp -f {file} {cwd}/{self.module}/{file_name}.so"
-                print(copy_command)
+                library_name = f"{self.module}/{file_name}.so"
+                self._libraries.append(library_name)
+                copy_command = f"cp -f {file} {cwd}/{library_name}"
             system_call(copy_command)
-
         return self.commands
 
     def cleanup(self):

hatch_rs/tests/test_projects.py

@@ -2,22 +2,24 @@
 from pathlib import Path
 from shutil import rmtree
 from subprocess import check_call
-from sys import modules, path, platform
+from sys import executable, modules, path, platform, version_info
 
 import pytest
 
 
 class TestProject:
     @pytest.mark.parametrize(
-        "project",
+        "project_folder",
         [
             "test_project_basic",
         ],
     )
-    def test_basic(self, project):
+    def test_basic(self, project_folder):
         # cleanup
-        rmtree(f"hatch_rs/tests/{project}/project/extension.so", ignore_errors=True)
-        rmtree(f"hatch_rs/tests/{project}/project/extension.pyd", ignore_errors=True)
+        rmtree(f"hatch_rs/tests/{project_folder}/dist", ignore_errors=True)
+        rmtree(f"hatch_rs/tests/{project_folder}/target", ignore_errors=True)
+        rmtree(f"hatch_rs/tests/{project_folder}/project/extension.so", ignore_errors=True)
+        rmtree(f"hatch_rs/tests/{project_folder}/project/extension.pyd", ignore_errors=True)
         modules.pop("project", None)
         modules.pop("project.extension", None)
 
@@ -28,21 +30,31 @@ def test_basic(self, project):
                 "build",
                 "--hooks-only",
             ],
-            cwd=f"hatch_rs/tests/{project}",
+            cwd=f"hatch_rs/tests/{project_folder}",
         )
 
         # assert built
-
-        if project == "test_project_limited_api" and platform != "win32":
-            assert "project.abi3.so" in listdir(f"hatch_rs/tests/{project}/project")
+        if platform == "win32":
+            assert "project.pyd" in listdir(f"hatch_rs/tests/{project_folder}/project")
         else:
-            if platform == "win32":
-                assert "project.pyd" in listdir(f"hatch_rs/tests/{project}/project")
-            else:
-                assert "project.so" in listdir(f"hatch_rs/tests/{project}/project")
+            assert "project.so" in listdir(f"hatch_rs/tests/{project_folder}/project")
+
+        # dist
+        check_call(
+            [
+                executable,
+                "-m",
+                "build",
+                "-w",
+                "-n",
+            ],
+            cwd=f"hatch_rs/tests/{project_folder}",
+        )
+
+        assert f"cp3{version_info.minor}-cp3{version_info.minor}" in listdir(f"hatch_rs/tests/{project_folder}/dist")[0]
 
         # import
-        here = Path(__file__).parent / project
+        here = Path(__file__).parent / project_folder
         path.insert(0, str(here))
         import project.project
 

pyproject.toml

@@ -97,7 +97,7 @@ exclude_also = [
     "@(abc\\.)?abstractmethod",
 ]
 ignore_errors = true
-fail_under = 1
+fail_under = 75
 
 [tool.hatch.build]
 artifacts = []
@@ -130,4 +130,4 @@ known-first-party = ["hatch_rs"]
 section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]
 
 [tool.ruff.lint.per-file-ignores]
-"__init__.py" = ["F401", "F403"]
+"__init__.py" = ["F401", "F403"]