Automatically include license files in .dist-info/license_files

[idavis]

Implementing parts of #861 for PEP 639 not requiring updates to the metadata version. The changes in #837 added the .dist-info/license_files using the License-File field.

Any files in the project root matching glob patterns ["LICEN[CS]E*", "COPYING*", "NOTICE*", "AUTHORS*"] (from PEP 639) are automatically added to the license files list.

Further work for PEP 639 requires update to the metadata versions and approval of 639. The serialization of the fields has been handled by Adding license_expression and license_files serialization. Additionally, the wheel writer trims paths to write only the raw file name into the .dist-info/license_files. Future work will need to modify this behavior as PEP 639 requires relative tree paths to be reflected in the .dist-info/license_files hierarchy.

[netlify]

✅ Deploy Preview for maturin-guide canceled.

Name	Link
🔨 Latest commit	0c1a530
🔍 Latest deploy log	https://app.netlify.com/sites/maturin-guide/deploys/62484ddbf4fdc50008473941

[konstin]

nit: you can just keep everything as PathBuf and drop the unwrap

[idavis]

Pushed fix, thank you!

[konstin]

the manifest_path needs to be escaped with glob::escape or it'll become part of the pattern. The expect shouldn't happen anyway, but a? would be better than possibly panicking

[idavis]

I pushed a fix for the ? usage instead of the expect. I followed the pattern from source_distribution.rs#L317-L328. I can update the code to used Pattern::escape if you like.

    if let Some(include_targets) = sdist_include {
        for pattern in include_targets {
            println!("📦 Including files matching \"{}\"", pattern);
            for source in glob::glob(&manifest_dir.join(pattern).to_string_lossy())
                .expect("No files found for pattern")
                .filter_map(Result::ok)
            {
                let target = root_dir.join(&source.strip_prefix(manifest_dir)?);
                writer.add_file(target, source)?;
            }
        }
    }

[idavis]

@konstin Is this what you are looking for?

let license_include_targets = ["LICEN[CS]E*", "COPYING*", "NOTICE*", "AUTHORS*"];
let escaped_manifest_string = glob::Pattern::escape(manifest_path.to_str().unwrap());
let escaped_manifest_path = Path::new(&escaped_manifest_string);
for pattern in license_include_targets.iter() {
    for license_path in
        glob::glob(&escaped_manifest_path.join(pattern).to_string_lossy())?
            .filter_map(Result::ok)
    {
//....

[konstin]

yep that looks good!

[idavis]

@konstin Just pushed the change. Thanks for the tip.

[messense]

Thanks!

[tomjakubowski]

I think that per PEP 639, the directory containing the license files is supposed to be named licenses, not license_files. https://peps.python.org/pep-0639/#term-root-license-directory

Defined to be the project root directory for a project source tree or source distribution; and a subdirectory named licenses of the directory containing the built metadata— i.e., the .dist-info/licenses directory— for a Built Distribution or installed project.

edit: ope, this was fixed recently. #2181