Bug(?): uv publish fails if unknown files are present in ./dist

Description

When a file is created in the ./dist directory before running uv publish, this file causes uv publish to fail. The documentation states that it ignores all other files.

uv/docs/reference/cli.md

Line 7835 in 04c445a

    
           <p>Defaults to the <code>dist</code> directory. Selects only wheels and source distributions, while ignoring other files.</p>

This issue is clearly minor and does not really impact the user much (the error message is quite clear).

However, I think there is no reason to fail if an unknown file is present – as long as a wheel and/or sdist file is found.

If this failure is deliberate, then I would recommend change the documentation.

Steps to reproduce

Build the project (using uv build). The build files will be generated in ./dist.
Create a file in the ./dist directory. On macOS, this could happen e.g. when opening the directory in Finder, which might create the .DS_Store file. Example: touch ./dist/.DS_Store
Run uv publish.

This will fail with the error: error: File is neither a wheel nor a source distribution: 'dist/.DS_Store'

Where does this error come from

The error is raised in uv_publish::files_for_publishing:

uv/crates/uv-publish/src/lib.rs

Lines 257 to 258 in 0b4e5cf

    
           let dist_filename = DistFilename::try_from_normalized_filename(&filename) 
        
               .ok_or_else(|| PublishError::InvalidFilename(dist.clone()))?;

uv_distribution_filename::DistFilename::try_from_normalized_filename in turn checks if the files are valid wheel or sdist files. Example for wheels:

uv/crates/uv-distribution-filename/src/wheel.rs

Lines 29 to 34 in 0b4e5cf

    
           let stem = filename.strip_suffix(".whl").ok_or_else(|| { 
        
               WheelFilenameError::InvalidWheelFileName( 
        
                   filename.to_string(), 
        
                   "Must end with .whl".to_string(), 
        
               ) 
        
           })?;

Meta

uv version:

uv 0.5.0 (Homebrew 2024-11-07)

Thanks for the report! We'll take a look -- does seem like an oversight.

I also saw a similar error that may be related when running uv sync. It gave me:

error: Failed to install: ruff-0.7.3-py3-none-macosx_11_0_arm64.whl (ruff==0.7.3)
  Caused by: The wheel is invalid: Unknown wheel data type: ".DS_Store"

After doing a find . -name .DS_Store -exec rm -rf {} + in /Users/USER/.cache/uv the error was gone.

P.S. I'm usin uv 0.5.1 (f399a5271 2024-11-08)

Interesting, did you open the uv cache manually at some point?

Publish: Ignore non-matching files

Interesting, did you open the uv cache manually at some point?

Yes, I inspected it a little bit.

Is the fix ecccfa0 only for uv publish? FWIW the bug happened to me with uv sync.

@maliayas

@maliayas your case is unrelated to the uv publish case, it looks like the uv cache got corrupted by adding a .DS_Store entry.

Publish: Ignore non-matching files (astral-sh#8986)

Navigation Menu

Repository navigation

Bug(?): uv publish fails if unknown files are present in ./dist #8944

Description

Steps to reproduce

Where does this error come from

Meta

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	let dist_filename = DistFilename::try_from_normalized_filename(&filename)
	.ok_or_else(\|\| PublishError::InvalidFilename(dist.clone()))?;

	let stem = filename.strip_suffix(".whl").ok_or_else(\|\| {
	WheelFilenameError::InvalidWheelFileName(
	filename.to_string(),
	"Must end with .whl".to_string(),
	)
	})?;

Bug(?): uv publish fails if unknown files are present in ./dist #8944

Description

Description

Steps to reproduce

Where does this error come from

Meta

Activity

charliermarsh commented on Nov 9, 2024

maliayas commented on Nov 12, 2024

charliermarsh commented on Nov 12, 2024

maliayas commented on Nov 13, 2024

maliayas commented on Nov 13, 2024

konstin commented on Nov 13, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions