Name .pth file so it loads first (#828)

* Name .pth file so it loads first

Users adding their own .pth files likely need to be loaded after the one inserted by hatchling. The only way to do this is by naming it so the hatchling .pth file comes first alphabetically.

* update

* add history entry

---------

Co-authored-by: Ofek Lev <[email protected]>

Author: rmorshea

backend/src/hatchling/builders/wheel.py

@@ -438,6 +438,9 @@ def build_editable_detection(self, directory: str, **build_data: Any) -> str:
                     editable_project.add_to_path(os.path.dirname(relative_path))
 
             for filename, content in sorted(editable_project.files()):
+                if filename.endswith('.pth') and not filename.startswith('_'):
+                    filename = f'_{filename}'
+
                 record = archive.write_file(filename, content)
                 records.write(record)
 
@@ -475,7 +478,7 @@ def build_editable_explicit(self, directory: str, **build_data: Any) -> str:
                 for relative_directory in self.config.dev_mode_dirs
             )
 
-            record = archive.write_file(f"{self.metadata.core.name.replace('-', '_')}.pth", '\n'.join(directories))
+            record = archive.write_file(f"_{self.metadata.core.name.replace('-', '_')}.pth", '\n'.join(directories))
             records.write(record)
 
             for included_file in self.recurse_forced_files(self.get_forced_inclusion_map(build_data)):

docs/history/hatchling.md

@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ***Fixed:***
 
 - Fix dev mode when the project has symlinks and file inclusion is defined with the `packages` or `only-include` options
+- Change the name of generated PTH files for dev mode so they come first lexicographically and therefore load first
 
 ## [1.17.0](https://github.com/pypa/hatch/releases/tag/hatchling-v1.17.0) - 2023-05-12 ## {: #hatchling-v1.17.0 }
 

tests/helpers/templates/wheel/standard_editable_exact.py

@@ -16,7 +16,7 @@ def get_files(**kwargs):
         if str(f.path) == 'LICENSE.txt':
             files.append(File(Path(metadata_directory, 'licenses', f.path), f.contents))
 
-    pth_file_name = f"{kwargs['package_name']}.pth"
+    pth_file_name = f"_{kwargs['package_name']}.pth"
     loader_file_name = f"_editable_impl_{kwargs['package_name']}.py"
     files.append(File(Path(pth_file_name), f"import _editable_impl_{kwargs['package_name']}"))
     files.append(

tests/helpers/templates/wheel/standard_editable_exact_extra_dependencies.py

@@ -16,7 +16,7 @@ def get_files(**kwargs):
         if str(f.path) == 'LICENSE.txt':
             files.append(File(Path(metadata_directory, 'licenses', f.path), f.contents))
 
-    pth_file_name = f"{kwargs['package_name']}.pth"
+    pth_file_name = f"_{kwargs['package_name']}.pth"
     loader_file_name = f"_editable_impl_{kwargs['package_name']}.py"
     files.append(File(Path(pth_file_name), f"import _editable_impl_{kwargs['package_name']}"))
     files.append(

tests/helpers/templates/wheel/standard_editable_exact_force_include.py

@@ -18,7 +18,7 @@ def get_files(**kwargs):
         elif f.path.parts[-1] == '__about__.py':
             files.append(File(Path('zfoo.py'), f.contents))
 
-    pth_file_name = f"{kwargs['package_name']}.pth"
+    pth_file_name = f"_{kwargs['package_name']}.pth"
     loader_file_name = f"_editable_impl_{kwargs['package_name']}.py"
     files.append(File(Path(pth_file_name), f"import _editable_impl_{kwargs['package_name']}"))
     files.append(

tests/helpers/templates/wheel/standard_editable_pth.py

@@ -16,7 +16,7 @@ def get_files(**kwargs):
         if str(f.path) == 'LICENSE.txt':
             files.append(File(Path(metadata_directory, 'licenses', f.path), f.contents))
 
-    pth_file_name = f"{kwargs['package_name']}.pth"
+    pth_file_name = f"_{kwargs['package_name']}.pth"
     files.append(File(Path(pth_file_name), '\n'.join(package_paths)))
     files.append(
         File(

tests/helpers/templates/wheel/standard_editable_pth_extra_dependencies.py

@@ -16,7 +16,7 @@ def get_files(**kwargs):
         if str(f.path) == 'LICENSE.txt':
             files.append(File(Path(metadata_directory, 'licenses', f.path), f.contents))
 
-    pth_file_name = f"{kwargs['package_name']}.pth"
+    pth_file_name = f"_{kwargs['package_name']}.pth"
     files.append(File(Path(pth_file_name), '\n'.join(package_paths)))
     files.append(
         File(

tests/helpers/templates/wheel/standard_editable_pth_force_include.py

@@ -18,7 +18,7 @@ def get_files(**kwargs):
         elif f.path.parts[-1] == '__about__.py':
             files.append(File(Path('zfoo.py'), f.contents))
 
-    pth_file_name = f"{kwargs['package_name']}.pth"
+    pth_file_name = f"_{kwargs['package_name']}.pth"
     files.append(File(Path(pth_file_name), '\n'.join(package_paths)))
     files.append(
         File(