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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-package-folder
-Version: 3.0.2
+Version: 3.1.1
 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.0.2 → python_package_folder-3.1.1}/src/python_package_folder/subfolder_build.py

@@ -140,7 +140,10 @@ class SubfolderBuildConfig:
         lines = content.split("\n")
         result = []
         in_hatch_build = False
+        in_hatch_build_section = False
+        in_sdist_section = False
         packages_set = False
+        only_include_set = False
 
         for line in lines:
             # Detect hatch build section
@@ -148,6 +151,10 @@ class SubfolderBuildConfig:
                 in_hatch_build = True
                 result.append(line)
                 continue
+            elif line.strip().startswith("[tool.hatch.build]"):
+                in_hatch_build_section = True
+                result.append(line)
+                continue
             elif line.strip().startswith("[") and in_hatch_build:
                 # End of hatch build section, add packages if not set
                 if not packages_set and correct_packages_path:
@@ -155,6 +162,25 @@ class SubfolderBuildConfig:
                     result.append(f"packages = [{packages_str}]")
                 in_hatch_build = False
                 result.append(line)
+            elif line.strip().startswith("[") and in_hatch_build_section:
+                # End of hatch build section
+                in_hatch_build_section = False
+                result.append(line)
+            elif line.strip().startswith("[tool.hatch.build.targets.sdist]"):
+                in_sdist_section = True
+                result.append(line)
+                continue
+            elif line.strip().startswith("[") and in_sdist_section:
+                # End of sdist section
+                in_sdist_section = False
+                result.append(line)
+            elif in_sdist_section:
+                # Track if only-include already exists
+                if re.match(r"^\s*only-include\s*=", line):
+                    only_include_set = True
+                result.append(line)
+            elif in_hatch_build_section:
+                result.append(line)
             elif in_hatch_build:
                 # Modify packages path if found
                 if re.match(r"^\s*packages\s*=", line):
@@ -194,6 +220,22 @@ class SubfolderBuildConfig:
                 packages_str = f'"{correct_packages_path}"'
                 result.append(f"packages = [{packages_str}]")
 
+        # Use only-include for source distributions to ensure only the subfolder is included
+        # This prevents including files from the project root
+        if correct_packages_path and not only_include_set:
+            result.append("")
+            result.append("[tool.hatch.build.targets.sdist]")
+            # Include only the subfolder directory and necessary files
+            only_include_paths = [correct_packages_path]
+            # Also include pyproject.toml and README if they exist
+            only_include_paths.append("pyproject.toml")
+            only_include_paths.append("README.md")
+            only_include_paths.append("README.rst")
+            only_include_paths.append("README.txt")
+            only_include_paths.append("README")
+            only_include_str = ", ".join(f'"{p}"' for p in only_include_paths)
+            result.append(f"only-include = [{only_include_str}]")
+
         return "\n".join(result)
 
     def create_temp_pyproject(self) -> Path | None:
@@ -532,6 +574,22 @@ class SubfolderBuildConfig:
             packages_str = ", ".join(f'"{p}"' for p in package_dirs)
             result.append(f"packages = [{packages_str}]")
 
+        # Use only-include for source distributions to ensure only the subfolder is included
+        # This prevents including files from the project root
+        if package_dirs:
+            result.append("")
+            result.append("[tool.hatch.build.targets.sdist]")
+            # Include only the subfolder directory and necessary files
+            only_include_paths = [package_dirs[0]]
+            # Also include pyproject.toml and README if they exist
+            only_include_paths.append("pyproject.toml")
+            only_include_paths.append("README.md")
+            only_include_paths.append("README.rst")
+            only_include_paths.append("README.txt")
+            only_include_paths.append("README")
+            only_include_str = ", ".join(f'"{p}"' for p in only_include_paths)
+            result.append(f"only-include = [{only_include_str}]")
+
         # Add dependency group if specified
         if dependency_group:
             # Find where to insert dependency-groups section

{python_package_folder-3.0.2 → python_package_folder-3.1.1}/tests/test_subfolder_build.py

@@ -675,6 +675,111 @@ class TestSubfolderBuildTemporaryPyprojectCreation:
         # Cleanup
         config.restore()
 
+    def test_file_exclusion_patterns_added(self, test_project_with_pyproject: Path) -> None:
+        """Test that file exclusion patterns are added to temporary pyproject.toml."""
+        project_root = test_project_with_pyproject
+        subfolder = project_root / "subfolder"
+
+        # Create various non-package files and directories that should be excluded
+        (project_root / ".cursor").mkdir()
+        (project_root / ".github").mkdir()
+        (project_root / ".vscode").mkdir()
+        (project_root / "data").mkdir()
+        (project_root / "docs").mkdir()
+        (project_root / "references").mkdir()
+        (project_root / "reports").mkdir()
+        (project_root / "scripts").mkdir()
+        (project_root / "tests").mkdir()
+        (project_root / "Dockerfile").write_text("# Dockerfile")
+        (project_root / ".gitignore").write_text("*.pyc")
+
+        # Ensure no pyproject.toml in subfolder
+        subfolder_pyproject = subfolder / "pyproject.toml"
+        if subfolder_pyproject.exists():
+            subfolder_pyproject.unlink()
+
+        config = SubfolderBuildConfig(
+            project_root=project_root,
+            src_dir=subfolder,
+            version="1.0.0",
+            package_name="test-package",
+        )
+
+        pyproject_path = config.create_temp_pyproject()
+
+        assert pyproject_path is not None
+        assert pyproject_path.exists()
+        content = pyproject_path.read_text()
+
+        # Verify [tool.hatch.build.targets.sdist] section exists
+        assert "[tool.hatch.build.targets.sdist]" in content
+
+        # Verify only-include is present
+        assert "only-include = [" in content
+
+        # Verify the subfolder is included
+        assert '"subfolder"' in content
+
+        # Verify necessary files are included
+        assert '"pyproject.toml"' in content
+        assert '"README.md"' in content
+
+        # Verify non-package directories are NOT explicitly included
+        assert '".cursor"' not in content or '".cursor"' not in content.split("only-include")[1]
+        assert '".github"' not in content or '".github"' not in content.split("only-include")[1]
+        assert '"data"' not in content or '"data"' not in content.split("only-include")[1]
+        assert '"docs"' not in content or '"docs"' not in content.split("only-include")[1]
+
+        # Cleanup
+        config.restore()
+
+    def test_file_exclusion_patterns_with_subfolder_pyproject(
+        self, test_project_with_pyproject: Path
+    ) -> None:
+        """Test that file exclusion patterns are added when subfolder has its own pyproject.toml."""
+        project_root = test_project_with_pyproject
+        subfolder = project_root / "subfolder"
+
+        # Create various non-package files that should be excluded
+        (project_root / ".cursor").mkdir()
+        (project_root / "data").mkdir()
+        (project_root / "docs").mkdir()
+
+        # Create pyproject.toml in subfolder
+        subfolder_pyproject_content = """[project]
+name = "subfolder-package"
+version = "1.0.0"
+description = "Subfolder package"
+"""
+        (subfolder / "pyproject.toml").write_text(subfolder_pyproject_content)
+
+        config = SubfolderBuildConfig(
+            project_root=project_root,
+            src_dir=subfolder,
+            version="2.0.0",  # Should be ignored since subfolder has its own
+        )
+
+        pyproject_path = config.create_temp_pyproject()
+
+        assert pyproject_path is not None
+        assert pyproject_path.exists()
+        content = pyproject_path.read_text()
+
+        # Verify [tool.hatch.build.targets.sdist] section exists
+        assert "[tool.hatch.build.targets.sdist]" in content
+
+        # Verify only-include is present
+        assert "only-include = [" in content
+
+        # Verify the subfolder is included
+        assert '"subfolder-package"' in content or '"subfolder"' in content
+
+        # Verify necessary files are included
+        assert '"pyproject.toml"' in content
+
+        # Cleanup
+        config.restore()
+
     def test_third_party_dependencies_added(self, test_project_with_pyproject: Path) -> None:
         """Test that third-party dependencies are added to temporary pyproject.toml."""
         project_root = test_project_with_pyproject