Ignore .DS_Store on macOS (#1321)

Author: ofek

backend/src/hatchling/builders/constants.py

@@ -20,6 +20,10 @@
     # Mypy
     '.mypy_cache',
 ))
+EXCLUDED_FILES = frozenset((
+    # https://en.wikipedia.org/wiki/.DS_Store
+    '.DS_Store',
+))
 
 
 class BuildEnvVars:

backend/src/hatchling/builders/plugin/interface.py

@@ -6,7 +6,7 @@
 from typing import TYPE_CHECKING, Any, Callable, Generator, Generic, Iterable, cast
 
 from hatchling.builders.config import BuilderConfig, BuilderConfigBound, env_var_enabled
-from hatchling.builders.constants import EXCLUDED_DIRECTORIES, BuildEnvVars
+from hatchling.builders.constants import EXCLUDED_DIRECTORIES, EXCLUDED_FILES, BuildEnvVars
 from hatchling.builders.utils import get_relative_path, safe_walk
 from hatchling.plugin.manager import PluginManagerBound
 
@@ -191,6 +191,9 @@ def recurse_project_files(self) -> Iterable[IncludedFile]:
             files.sort()
             is_package = '__init__.py' in files
             for f in files:
+                if f in EXCLUDED_FILES:
+                    continue
+
                 relative_file_path = os.path.join(relative_path, f)
                 distribution_path = self.config.get_distribution_path(relative_file_path)
                 if self.config.path_is_reserved(distribution_path):
@@ -218,6 +221,9 @@ def recurse_forced_files(self, inclusion_map: dict[str, str]) -> Iterable[Includ
 
                     files.sort()
                     for f in files:
+                        if f in EXCLUDED_FILES:
+                            continue
+
                         relative_file_path = os.path.join(target_path, relative_directory, f)
                         distribution_path = self.config.get_distribution_path(relative_file_path)
                         if not self.config.path_is_reserved(distribution_path):
@@ -250,6 +256,9 @@ def recurse_explicit_files(self, inclusion_map: dict[str, str]) -> Iterable[Incl
                     files.sort()
                     is_package = '__init__.py' in files
                     for f in files:
+                        if f in EXCLUDED_FILES:
+                            continue
+
                         relative_file_path = os.path.join(target_path, relative_directory, f)
                         distribution_path = self.config.get_distribution_path(relative_file_path)
                         if self.config.path_is_reserved(distribution_path):

docs/history/hatchling.md

@@ -14,20 +14,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ***Added:***
 
+- Metadata for the `wheel` target now defaults to the `PKG-INFO` metadata within source distributions
 - Add `dependencies` method to the build hook interface so that hooks can themselves dynamically define dependencies
 - Update the default version of core metadata to 2.3
 - Update SPDX license information to version 3.23
 - Improve error message for when the default heuristics for wheel file inclusion fail
 
 ***Fixed:***
 
+- Properly support core metadata version 2.2
 - Remove `editables` as a direct dependency
 - Fix default wheel tag when the supported Python version declaration is strict
 - Load VCS ignore patterns first so that whitelisted patterns can be excluded by project configuration
 - Don't consider VCS ignore files that are outside of the VCS boundary
 - The `sdist` build target now gracefully ignores UNIX socket files
-- Metadata for the `wheel` target now defaults to the `PKG-INFO` metadata within source distributions
-- Properly support core metadata version 2.2
+- Begin ignoring certain files ubiquitously, like `.DS_Store` on macOS
 
 ## [1.21.1](https://github.com/pypa/hatch/releases/tag/hatchling-v1.21.1) - 2024-01-25 ## {: #hatchling-v1.21.1 }
 

tests/backend/builders/plugin/test_interface.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from hatchling.builders.constants import EXCLUDED_DIRECTORIES
+from hatchling.builders.constants import EXCLUDED_DIRECTORIES, EXCLUDED_FILES
 from hatchling.metadata.core import ProjectMetadata
 from hatchling.plugin.manager import PluginManager
 
@@ -350,6 +350,9 @@ def test_order(self, temp_dir):
                 excluded_dir = bar / name
                 excluded_dir.ensure_dir_exists()
                 (excluded_dir / 'file.ext').touch()
+            for name in EXCLUDED_FILES:
+                excluded_file = bar / name
+                excluded_file.touch()
 
             (project_dir / 'README.md').touch()
             (project_dir / 'tox.ini').touch()
@@ -367,6 +370,9 @@ def test_order(self, temp_dir):
                 excluded_dir = external / name
                 excluded_dir.ensure_dir_exists()
                 (excluded_dir / 'file.ext').touch()
+            for name in EXCLUDED_FILES:
+                excluded_file = external / name
+                excluded_file.touch()
 
             assert [(f.path, f.distribution_path) for f in builder.recurse_included_files()] == [
                 (str(project_dir / 'README.md'), 'README.md'),