Automatically include license files in .dist-info/license_files

Changelog.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+* Automatically include license files in `.dist-info/license_files` following PEP 639 in [#862](https://github.com/PyO3/maturin/pull/862)
+
 ## [0.12.11] - 2022-03-15
 
 * Package license files in `.dist-info/license_files` following PEP 639 in [#837](https://github.com/PyO3/maturin/pull/837)

src/metadata.rs

@@ -153,6 +153,27 @@ impl Metadata21 {
                 }
             }
 
+            // Until PEP 639 is approved with metadata 2.3, we can assume a
+            // dynamic license-files (also awaiting full 2.2 metadata support)
+            // We're already emitting the License-Files metadata without issue.
+            // license-files.globs = ["LICEN[CS]E*", "COPYING*", "NOTICE*", "AUTHORS*"]
+            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)
+                {
+                    // if the pyproject.toml specified the license file,
+                    // then we won't list it as automatically included
+                    if !self.license_files.contains(&license_path) {
+                        println!("📦 Including license file \"{}\"", license_path.display());
+                        self.license_files.push(license_path);
+                    }
+                }
+            }
+
             if let Some(authors) = &project.authors {
                 let mut names = Vec::with_capacity(authors.len());
                 let mut emails = Vec::with_capacity(authors.len());
@@ -835,4 +856,26 @@ mod test {
             "text/markdown; charset=UTF-8; variant=GFM"
         );
     }
+
+    #[test]
+    fn test_merge_metadata_from_pyproject_dynamic_license_test() {
+        let manifest_path = PathBuf::from("test-crates").join("license-test");
+        let cargo_toml_str = fs_err::read_to_string(&manifest_path.join("Cargo.toml")).unwrap();
+        let cargo_toml: CargoToml = toml_edit::easy::from_str(&cargo_toml_str).unwrap();
+        let metadata = Metadata21::from_cargo_toml(&cargo_toml, &manifest_path).unwrap();
+
+        // verify Cargo.toml value came through
+        assert_eq!(metadata.license.as_ref().unwrap(), "MIT");
+
+        // verify we have the total number of expected licenses
+        assert_eq!(4, metadata.license_files.len());
+
+        // Verify pyproject.toml license = {file = ...} worked
+        assert_eq!(metadata.license_files[0], manifest_path.join("LICENCE.txt"));
+
+        // Verify the default licenses were included
+        assert_eq!(metadata.license_files[1], manifest_path.join("LICENSE"));
+        assert_eq!(metadata.license_files[2], manifest_path.join("NOTICE.md"));
+        assert_eq!(metadata.license_files[3], manifest_path.join("AUTHORS.txt"));
+    }
 }

test-crates/license-test/AUTHORS.txt

@@ -0,0 +1 @@
+AUTHORS

test-crates/license-test/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "license-test"
+version = "0.1.0"
+authors = ["konstin <konstin@mailbox.org>"]
+edition = "2018"
+license = "MIT"
+
+[dependencies]

test-crates/license-test/LICENCE.txt

@@ -0,0 +1 @@
+LICENCE

test-crates/license-test/LICENSE

@@ -0,0 +1 @@
+LICENSE

test-crates/license-test/NOTICE.md

@@ -0,0 +1 @@
+# NOTICE

test-crates/license-test/_vendor/AUTHORS.txt

@@ -0,0 +1 @@
+AUTHORS

test-crates/license-test/_vendor/COPYING.md

@@ -0,0 +1 @@
+# COPYING

test-crates/license-test/_vendor/LICENCE

@@ -0,0 +1 @@
+LICENCE

test-crates/license-test/_vendor/LICENSE-APACHE.txt

@@ -0,0 +1 @@
+LICENSE-APACHE

test-crates/license-test/_vendor/NOTICE

@@ -0,0 +1 @@
+NOTICE

test-crates/license-test/_vendor/nested/LICENSE-BSD

@@ -0,0 +1 @@
+LICENSE-BSD

test-crates/license-test/_vendor/nested/NOTICE.md

@@ -0,0 +1 @@
+# NOTICE

test-crates/license-test/check_installed/check_installed.py

@@ -0,0 +1,12 @@
+from subprocess import check_output
+
+
+def main():
+    output = check_output(["hello-world"]).decode("utf-8").strip()
+    if not output == "Hello, world!":
+        raise Exception(output)
+    print("SUCCESS")
+
+
+if __name__ == "__main__":
+    main()

test-crates/license-test/pyproject.toml

@@ -0,0 +1,10 @@
+[build-system]
+requires = ["maturin>=0.12,<0.13"]
+build-backend = "maturin"
+
+[project]
+name = "license-test"
+license = { file = "LICENCE.txt" }
+
+[tool.maturin]
+bindings = "bin"

test-crates/license-test/src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}