python-package-folder 3.1.1__tar.gz → 3.1.3__tar.gz

{python_package_folder-3.1.1 → python_package_folder-3.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-package-folder
-Version: 3.1.1
+Version: 3.1.3
 Summary: Python package to automatically package and build a folder, fetching all relevant dependencies.
 Project-URL: Repository, https://github.com/alelom/python-package-folder
 Author-email: Alessio Lombardi <work@alelom.com>

{python_package_folder-3.1.1 → python_package_folder-3.1.3}/coverage.svg

@@ -14,7 +14,7 @@
   <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
     <text x="31.5" y="15" fill="#010101" fill-opacity=".3">coverage</text>
     <text x="31.5" y="14">coverage</text>
-    <text x="81" y="15" fill="#010101" fill-opacity=".3">68%</text>
-    <text x="81" y="14">68%</text>
+    <text x="81" y="15" fill="#010101" fill-opacity=".3">69%</text>
+    <text x="81" y="14">69%</text>
   </g>
 </svg>

{python_package_folder-3.1.1 → python_package_folder-3.1.3}/src/python_package_folder/manager.py

@@ -88,6 +88,8 @@ class BuildManager:
         self.subfolder_config: SubfolderBuildConfig | None = None
         # Cache for package name lookups (expensive operation)
         self._packages_distributions_cache: dict[str, list[str]] | None = None
+        # Track files with modified imports and their original content
+        self._modified_import_files: dict[Path, str] = {}
 
         # Check if it's a valid Python package directory
         if not any(self.src_dir.glob("*.py")) and not (self.src_dir / "__init__.py").exists():
@@ -270,6 +272,13 @@ class BuildManager:
         for dep in external_deps:
             self._copy_dependency(dep)
 
+        # For subfolder builds, fix imports
+        if self._is_subfolder_build() and external_deps:
+            # Fix relative imports in copied dependency files (convert to absolute)
+            self._fix_relative_imports_in_copied_files(external_deps)
+            # Convert absolute imports of copied dependencies and local files to relative imports
+            self._convert_imports_to_relative(python_files, external_deps)
+
         # For subfolder builds, extract third-party dependencies and add to pyproject.toml
         if self._is_subfolder_build() and self.subfolder_config:
             # Re-analyze all Python files (including copied dependencies) to find third-party imports
@@ -629,6 +638,258 @@ class BuildManager:
 
         return sorted(list(third_party_packages))
 
+    def _fix_relative_imports_in_copied_files(
+        self, external_deps: list[ExternalDependency]
+    ) -> None:
+        """
+        Fix relative imports in copied dependency files.
+
+        When files are copied into the subfolder, their relative imports (like
+        `from ._shared.shared_dataclasses import ...`) break because the file
+        structure has changed. Convert these to absolute imports based on the
+        target location.
+
+        Args:
+            external_deps: List of external dependencies that were copied
+        """
+        import ast
+        import re
+
+        # Find all Python files in copied dependencies
+        copied_files: list[Path] = []
+        for dep in external_deps:
+            if dep.target_path.is_file() and dep.target_path.suffix == ".py":
+                copied_files.append(dep.target_path)
+            elif dep.target_path.is_dir():
+                copied_files.extend(dep.target_path.rglob("*.py"))
+
+        for file_path in copied_files:
+            try:
+                content = file_path.read_text(encoding="utf-8")
+                original_content = content
+                lines = content.split("\n")
+                modified = False
+
+                try:
+                    tree = ast.parse(content, filename=str(file_path))
+                except SyntaxError:
+                    continue
+
+                lines_to_modify: dict[int, str] = {}
+
+                for node in ast.walk(tree):
+                    if isinstance(node, ast.ImportFrom):
+                        if node.module is None:
+                            continue
+
+                        # Check if this is a relative import (level > 0)
+                        if node.level == 0:
+                            continue
+
+                        line_num = node.lineno - 1
+                        if line_num < 0 or line_num >= len(lines):
+                            continue
+
+                        original_line = lines[line_num]
+
+                        # Convert relative import to absolute based on target location
+                        # When a file is copied to the package root, relative imports need to be absolute
+                        # For example: from ._shared.shared_dataclasses -> from _shared.shared_dataclasses
+                        if node.module:
+                            # Remove the leading dots and convert to absolute
+                            # If it was `from ._shared.shared_dataclasses`, it becomes `from _shared.shared_dataclasses`
+                            absolute_module = node.module
+                            new_line = re.sub(
+                                rf"^(\s*)from\s+\.+{re.escape(node.module)}\s+import",
+                                rf"\1from {absolute_module} import",
+                                original_line,
+                            )
+                        else:
+                            # from . import X -> from . import X (keep as relative, but at package root level)
+                            # Actually, if we're at package root, this should work as-is
+                            # But if the file was in a subdirectory, we need to adjust
+                            # For now, keep it as relative import
+                            continue
+
+                        if new_line != original_line:
+                            lines_to_modify[line_num] = new_line
+                            modified = True
+
+                if modified:
+                    for line_num, new_line in lines_to_modify.items():
+                        lines[line_num] = new_line
+
+                    new_content = "\n".join(lines)
+                    if file_path not in self._modified_import_files:
+                        self._modified_import_files[file_path] = original_content
+
+                    file_path.write_text(new_content, encoding="utf-8")
+                    print(f"Fixed relative imports in copied file: {file_path}")
+
+            except Exception as e:
+                print(
+                    f"Warning: Could not fix imports in copied file {file_path}: {e}",
+                    file=sys.stderr,
+                )
+
+    def _convert_imports_to_relative(
+        self, python_files: list[Path], external_deps: list[ExternalDependency]
+    ) -> None:
+        """
+        Convert absolute imports to relative imports for subfolder builds.
+
+        For subfolder builds, when external dependencies are copied into the subfolder,
+        imports need to be converted from absolute to relative so they work correctly
+        when the package is installed. This includes:
+        1. Imports of copied dependencies (e.g., `from _shared.image_utils` -> `from ._shared.image_utils`)
+        2. Imports of local files within the subfolder (e.g., `from detect_empty_drawings_utils` -> `from .detect_empty_drawings_utils`)
+
+        Args:
+            python_files: List of Python files in the source directory
+            external_deps: List of external dependencies that were copied
+        """
+        import ast
+        import re
+
+        # Build a set of import names that were copied
+        copied_import_names: set[str] = set()
+        for dep in external_deps:
+            root_module = dep.import_name.split(".")[0]
+            copied_import_names.add(root_module)
+            copied_import_names.add(dep.import_name)
+
+        # Build a set of local file names in the subfolder (excluding copied dependencies)
+        local_file_names: set[str] = set()
+        for file_path in python_files:
+            # Skip files that are part of copied dependencies
+            is_copied_file = any(file_path.is_relative_to(dep.target_path) for dep in external_deps)
+            if is_copied_file:
+                continue
+            if not file_path.is_relative_to(self.src_dir):
+                continue
+            # Get the module name (filename without .py extension)
+            if file_path.suffix == ".py":
+                module_name = file_path.stem
+                if module_name != "__init__":
+                    local_file_names.add(module_name)
+
+        # Only modify files that are in the original subfolder (not the copied dependencies)
+        for file_path in python_files:
+            # Skip files that are part of copied dependencies
+            is_copied_file = any(file_path.is_relative_to(dep.target_path) for dep in external_deps)
+            if is_copied_file:
+                continue
+
+            # Skip if file is not in src_dir (shouldn't happen, but safety check)
+            if not file_path.is_relative_to(self.src_dir):
+                continue
+
+            try:
+                content = file_path.read_text(encoding="utf-8")
+                original_content = content
+                lines = content.split("\n")
+                modified = False
+
+                # Parse the file with AST to find imports accurately
+                try:
+                    tree = ast.parse(content, filename=str(file_path))
+                except SyntaxError:
+                    # Skip files with syntax errors
+                    continue
+
+                # Track which lines need to be modified
+                lines_to_modify: dict[int, str] = {}
+
+                for node in ast.walk(tree):
+                    if isinstance(node, ast.ImportFrom):
+                        if node.module is None:
+                            continue
+
+                        # Check if this import matches a copied dependency or a local file
+                        root_module = node.module.split(".")[0]
+                        is_copied_dependency = (
+                            root_module in copied_import_names or node.module in copied_import_names
+                        )
+                        is_local_file = root_module in local_file_names
+
+                        if not is_copied_dependency and not is_local_file:
+                            continue
+
+                        # Get the line content
+                        line_num = node.lineno - 1  # Convert to 0-based index
+                        if line_num < 0 or line_num >= len(lines):
+                            continue
+
+                        original_line = lines[line_num]
+
+                        # Skip if already a relative import
+                        if original_line.strip().startswith("from ."):
+                            continue
+
+                        # Convert absolute import to relative import
+                        # from _shared.image_utils import ... -> from ._shared.image_utils import ...
+                        new_line = re.sub(
+                            rf"^(\s*)from\s+{re.escape(node.module)}\s+import",
+                            rf"\1from .{node.module} import",
+                            original_line,
+                        )
+
+                        if new_line != original_line:
+                            lines_to_modify[line_num] = new_line
+                            modified = True
+
+                    elif isinstance(node, ast.Import):
+                        # Handle "import X" statements
+                        for alias in node.names:
+                            root_module = alias.name.split(".")[0]
+                            is_copied_dependency = root_module in copied_import_names
+                            is_local_file = root_module in local_file_names
+
+                            if not is_copied_dependency and not is_local_file:
+                                continue
+
+                            line_num = node.lineno - 1
+                            if line_num < 0 or line_num >= len(lines):
+                                continue
+
+                            original_line = lines[line_num]
+
+                            # Skip if already a relative import
+                            if original_line.strip().startswith("import ."):
+                                continue
+
+                            # Convert "import _shared" to "from . import _shared"
+                            # This is more complex, so we'll use a regex replacement
+                            new_line = re.sub(
+                                rf"^(\s*)import\s+{re.escape(alias.name)}\b",
+                                rf"\1from . import {alias.name}",
+                                original_line,
+                            )
+
+                            if new_line != original_line:
+                                lines_to_modify[line_num] = new_line
+                                modified = True
+
+                # Apply modifications
+                if modified:
+                    for line_num, new_line in lines_to_modify.items():
+                        lines[line_num] = new_line
+
+                    new_content = "\n".join(lines)
+                    # Store original content for restoration
+                    if file_path not in self._modified_import_files:
+                        self._modified_import_files[file_path] = original_content
+
+                    # Write modified content
+                    file_path.write_text(new_content, encoding="utf-8")
+                    print(f"Converted imports to relative in: {file_path}")
+
+            except Exception as e:
+                print(
+                    f"Warning: Could not modify imports in {file_path}: {e}",
+                    file=sys.stderr,
+                )
+
     def _report_ambiguous_imports(self, python_files: list[Path]) -> None:
         """
         Report any ambiguous imports that couldn't be resolved.
@@ -708,6 +969,19 @@ class BuildManager:
         self.copied_files.clear()
         self.copied_dirs.clear()
 
+        # Restore files with modified imports
+        for file_path, original_content in self._modified_import_files.items():
+            if file_path.exists():
+                try:
+                    file_path.write_text(original_content, encoding="utf-8")
+                    print(f"Restored original imports in: {file_path}")
+                except Exception as e:
+                    print(
+                        f"Warning: Could not restore imports in {file_path}: {e}",
+                        file=sys.stderr,
+                    )
+        self._modified_import_files.clear()
+
         # Remove all .egg-info directories in src_dir and project_root
         self._cleanup_egg_info_dirs()
 

{python_package_folder-3.1.1 → python_package_folder-3.1.3}/tests/test_build_with_external_deps.py

@@ -363,6 +363,124 @@ class TestBuildManager:
         assert len(manager.copied_files) == 0
         assert len(manager.copied_dirs) == 0
 
+    def test_convert_copied_dependency_imports_to_relative(self, tmp_path: Path) -> None:
+        """Test that absolute imports of copied dependencies are converted to relative imports for subfolder builds."""
+        project_root = tmp_path / "test_project"
+        project_root.mkdir()
+
+        # Create pyproject.toml
+        (project_root / "pyproject.toml").write_text(
+            """[project]
+name = "test-package"
+version = "0.1.0"
+"""
+        )
+
+        # Create external dependency _shared
+        shared_dir = project_root / "_shared"
+        shared_dir.mkdir()
+        (shared_dir / "__init__.py").write_text("")
+        (shared_dir / "image_utils.py").write_text("def save_PIL_image(): pass")
+        (shared_dir / "file_utils.py").write_text("def get_filepaths_config(): pass")
+
+        # Create external dependency _globals
+        (project_root / "_globals.py").write_text("is_testing = False")
+
+        # Create subfolder to build
+        subfolder = project_root / "src" / "integration" / "empty_drawing_detection"
+        subfolder.mkdir(parents=True)
+        (subfolder / "__init__.py").write_text("")
+
+        # Create a local file that will be imported
+        local_file = subfolder / "local_utils.py"
+        local_file.write_text("def local_function(): return 42")
+
+        # Create a file in subfolder that imports copied dependencies with absolute imports
+        test_file = subfolder / "detect_empty_drawings.py"
+        original_content = """from pathlib import Path
+from _shared.image_utils import save_PIL_image
+from _shared.file_utils import get_filepaths_config
+from _globals import is_testing
+from local_utils import local_function
+from config import get_config
+
+def analyze_folder():
+    save_PIL_image()
+    get_filepaths_config()
+    return is_testing
+"""
+        test_file.write_text(original_content)
+
+        # Create another file with different import style
+        test_file2 = subfolder / "config.py"
+        original_content2 = """import _globals
+
+def get_config():
+    return _globals.is_testing
+"""
+        test_file2.write_text(original_content2)
+
+        # Create a copied dependency file with relative imports (simulating detect_empty_drawings_utils.py)
+        # This will be created when _shared is copied
+        # First, let's create a file in _shared that will be copied
+        shared_utils = shared_dir / "shared_utils.py"
+        shared_utils.write_text(
+            """from .file_utils import get_filepaths_config
+
+def shared_function():
+    return get_filepaths_config()
+"""
+        )
+
+        manager = BuildManager(project_root, subfolder)
+
+        try:
+            # Prepare build - this should copy dependencies and convert imports
+            external_deps = manager.prepare_build(version="1.0.0", package_name="test-package")
+
+            # Verify dependencies were copied
+            assert len(external_deps) >= 2
+            assert (subfolder / "_shared").exists()
+            assert (subfolder / "_globals.py").exists()
+
+            # Verify imports were converted to relative
+            modified_content = test_file.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
+            # Verify local file imports were converted to relative
+            assert "from .local_utils import local_function" in modified_content
+            assert "from .config import get_config" in modified_content
+            # Verify stdlib import was not changed
+            assert "from pathlib import Path" in modified_content
+
+            # Verify import statement conversion
+            modified_content2 = test_file2.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()
+                # The relative import should be converted to absolute
+                assert (
+                    "from .file_utils import" not in shared_utils_content
+                    or "from file_utils import" in shared_utils_content
+                )
+
+            # Cleanup should restore original imports
+            manager.cleanup()
+
+            restored_content = test_file.read_text()
+            assert restored_content == original_content
+
+            restored_content2 = test_file2.read_text()
+            assert restored_content2 == original_content2
+
+        finally:
+            # Ensure cleanup even if test fails
+            if manager._modified_import_files:
+                manager.cleanup()
+
 
 class TestRealFolderStructure:
     """Tests using the real folder_structure from tests directory."""