Refactor package directory handling in SubfolderBuildConfig and tests

This commit updates the SubfolderBuildConfig class to ensure the source directory is treated as a package before creating a temporary package directory. It modifies the logic to copy the __init__.py file from the source directory to the temporary directory. Additionally, tests are adjusted to reference the correct package directory, which may now point to the temporary package directory, ensuring that the directory structure is preserved during builds and verifications.

Author: alelom

src/python_package_folder/subfolder_build.py

@@ -344,21 +344,23 @@ def create_temp_pyproject(self) -> Path | None:
         if not self.version:
             raise ValueError("Version is required for subfolder builds")
 
-        # Create temporary package directory with correct import name
-        self._create_temp_package_directory()
-        
-        # Determine which directory to use (temp package dir or src_dir)
-        package_dir = self._temp_package_dir if self._temp_package_dir and self._temp_package_dir.exists() else self.src_dir
-        
-        # Ensure package_dir is a package (has __init__.py) for hatchling
-        init_file = package_dir / "__init__.py"
+        # Ensure src_dir is a package (has __init__.py) before creating temp directory
+        # This way the __init__.py will be copied to the temp directory
+        init_file = self.src_dir / "__init__.py"
         if not init_file.exists():
             # Create a temporary __init__.py to make it a package
             init_file.write_text("# Temporary __init__.py for build\n", encoding="utf-8")
             self._temp_init_created = True
         else:
             self._temp_init_created = False
 
+        # Create temporary package directory with correct import name
+        # This will copy the __init__.py we just created (if any)
+        self._create_temp_package_directory()
+        
+        # Determine which directory to use (temp package dir or src_dir)
+        package_dir = self._temp_package_dir if self._temp_package_dir and self._temp_package_dir.exists() else self.src_dir
+
         # Check if pyproject.toml exists in subfolder
         subfolder_pyproject = self.src_dir / "pyproject.toml"
         if subfolder_pyproject.exists():

tests/test_build_with_external_deps.py

@@ -440,11 +440,15 @@ def shared_function():
 
             # Verify dependencies were copied
             assert len(external_deps) >= 2
-            assert (subfolder / "_shared").exists()
-            assert (subfolder / "_globals.py").exists()
+            # Dependencies are copied to the temp package directory (if it exists) or original subfolder
+            package_dir = manager.src_dir  # This will be temp package dir if it was created
+            assert (package_dir / "_shared").exists()
+            assert (package_dir / "_globals.py").exists()
 
             # Verify imports were converted to relative
-            modified_content = test_file.read_text()
+            # Read from package_dir which may be temp package directory
+            test_file_in_package = package_dir / test_file.name
+            modified_content = test_file_in_package.read_text()
             assert "from ._shared.image_utils import save_PIL_image" in modified_content
             assert "from ._shared.file_utils import get_filepaths_config" in modified_content
             assert "from ._globals import is_testing" in modified_content
@@ -455,12 +459,15 @@ def shared_function():
             assert "from pathlib import Path" in modified_content
 
             # Verify import statement conversion
-            modified_content2 = test_file2.read_text()
+            test_file2_in_package = package_dir / test_file2.name
+            modified_content2 = test_file2_in_package.read_text()
             assert "from . import _globals" in modified_content2
 
             # Verify relative imports in copied files were fixed
-            if (subfolder / "_shared" / "shared_utils.py").exists():
-                shared_utils_content = (subfolder / "_shared" / "shared_utils.py").read_text()
+            # Check in the package directory (which may be temp package dir)
+            shared_utils_path = package_dir / "_shared" / "shared_utils.py"
+            if shared_utils_path.exists():
+                shared_utils_content = shared_utils_path.read_text()
                 # The relative import should be converted to absolute
                 assert (
                     "from .file_utils import" not in shared_utils_content
@@ -470,6 +477,7 @@ def shared_function():
             # Cleanup should restore original imports
             manager.cleanup()
 
+            # After cleanup, check original files (not temp package dir)
             restored_content = test_file.read_text()
             assert restored_content == original_content
 

tests/test_preserve_directory_structure.py

@@ -161,14 +161,16 @@ def test_build_manager_preserves_structure(
         assert len(data_deps) > 0, "data dependencies should be found"
 
         # Verify models structure was copied with full path
-        models_path = src_dir / "models" / "Information_extraction" / "_shared_ie" / "ie_enums.py"
+        # Use manager.src_dir which may point to temp package directory
+        package_dir = manager.src_dir
+        models_path = package_dir / "models" / "Information_extraction" / "_shared_ie" / "ie_enums.py"
         assert models_path.exists(), (
             "models/Information_extraction/_shared_ie/ie_enums.py should be copied with full structure"
         )
 
         # Verify data structure was copied with full path
         data_path = (
-            src_dir / "data" / "spreadsheet_creation" / "spreadsheet_formatting_dataclasses.py"
+            package_dir / "data" / "spreadsheet_creation" / "spreadsheet_formatting_dataclasses.py"
         )
         assert data_path.exists(), (
             "data/spreadsheet_creation/spreadsheet_formatting_dataclasses.py should be copied with full structure"

tests/test_spreadsheet_creation_imports.py

@@ -139,7 +139,9 @@ def test_spreadsheet_modules_copied_not_added_as_dependencies(
 
         # Verify spreadsheet_creation directory was copied with full structure preserved
         # Import is "data.spreadsheet_creation.spreadsheet_formatting_dataclasses", so structure should be preserved
-        copied_dir = src_dir / "data" / "spreadsheet_creation"
+        # Use manager.src_dir which may point to temp package directory
+        package_dir = manager.src_dir
+        copied_dir = package_dir / "data" / "spreadsheet_creation"
         assert copied_dir.exists(), (
             f"spreadsheet_creation directory should be copied with structure at {copied_dir}"
         )

tests/test_subfolder_build.py

@@ -683,8 +683,8 @@ def test_temporary_pyproject_has_correct_structure(
         assert "[tool.hatch.version]" not in content
         assert "[tool.uv-dynamic-versioning]" not in content
 
-        # Verify packages path is set correctly
-        assert 'packages = ["subfolder"]' in content or '"subfolder"' in content
+        # Verify packages path is set correctly (should use temp package directory)
+        assert '.temp_package_my_custom_package' in content
 
         # Verify backup was created
         assert (project_root / "pyproject.toml.original").exists()
@@ -734,8 +734,8 @@ def test_file_exclusion_patterns_added(self, test_project_with_pyproject: Path)
         # Verify only-include is present
         assert "only-include = [" in content
 
-        # Verify the subfolder is included
-        assert '"subfolder"' in content
+        # Verify the temp package directory is included (not the original subfolder)
+        assert '.temp_package_test_package' in content
 
         # Verify necessary files are included
         assert '"pyproject.toml"' in content