add support for PEP 639 License Clarity (#10413)

Further, license files and the "WHEEL" file are now also included in editable installs.

Author: radoering

docs/libraries.md

@@ -62,16 +62,19 @@ poetry build
 This command will package your library in two different formats: `sdist` which is
 the source format, and `wheel` which is a `compiled` package.
 
-Poetry will automatically include some metadata files when building a package. When building
-a `wheel`, the following files are included in the `.dist-info` directory:
-- `LICENSE`
-- `LICENSE.*`
-- `COPYING`
-- `COPYING.*`
-- `LICENSES/**`
-
-When building an `sdist`, the following files will be included in the root folder:
-  - `LICENSE*`
+Poetry will automatically include some license-related files when building a package -
+in the `.dist-info/licenses` directory when building a `wheel`,
+and in the root folder when building an `sdist`:
+- `LICENSE*`
+- `LICENCE*`
+- `COPYING*`
+- `AUTHORS*`
+- `NOTICE*`
+- `LICENSES/**/*`
+
+You can override this behavior by specifying
+[`license-files`]({{< relref "pyproject/#license-files" >}})
+in the `pyproject.toml` file.
 
 ### Alternative build backends
 

docs/pyproject.md

@@ -71,7 +71,8 @@ description = "A short description of the package."
 
 ### license
 
-The license of the package.
+An [SPDX expression](https://packaging.python.org/en/latest/glossary/#term-License-Expression)
+representing the license of the package.
 
 The recommended notation for the most common licenses is (alphabetical):
 
@@ -93,20 +94,43 @@ Optional, but it is highly recommended to supply this.
 More identifiers are listed at the [SPDX Open Source License Registry](https://spdx.org/licenses/).
 
 ```toml
-license = { text = "MIT" }
+license = "MIT"
 ```
-{{% note %}}
-If your project is proprietary and does not use a specific license, you can set this value as `Proprietary`.
-{{% /note %}}
 
-You can also specify a license file. However, when doing this, the complete license text
-will be added to the metadata and the License classifier cannot be determined
-automatically so that you have to add it manually.
+{{% warning %}}
+Specifying license as a table, e.g. `{ text = "MIT" }` is deprecated.
+If you used to specify a license file, e.g. `{ file = "LICENSE" }`,
+use `license-files` instead.
+{{% /warning %}}
+
+### license-files
+
+A list of glob patterns that match the license files of the package
+relative to the root of the project source tree.
 
 ```toml
-license = { file = "LICENSE" }
+[project]
+# ...
+license-files = [
+    "*-LICENSE",
+    "CONTRIBUTORS",
+    "MY-SPECIAL-LICENSE-DIR/**/*"
+]
 ```
 
+By default, Poetry will include the following files:
+- `LICENSE*`
+- `LICENCE*`
+- `COPYING*`
+- `AUTHORS*`
+- `NOTICE*`
+- `LICENSES/**/*`
+
+{{% note %}}
+The default applies only if the `license-files` field is not specified.
+Specifying an empty list results in no license files being included.
+{{% /note %}}
+
 ### readme
 
 A path to the README file or the content.
@@ -198,7 +222,7 @@ classifiers = [
 ```
 
 {{% warning %}}
-Note that suitable classifiers based on your `python` requirement and `license`
+Note that suitable classifiers based on your `python` requirement
 are **not** automatically added for you if you define classifiers statically
 in the `project` section.
 
@@ -419,9 +443,6 @@ More identifiers are listed at the [SPDX Open Source License Registry](https://s
 ```toml
 license = "MIT"
 ```
-{{% note %}}
-If your project is proprietary and does not use a specific licence, you can set this value as `Proprietary`.
-{{% /note %}}
 
 ### authors
 
@@ -545,11 +566,8 @@ classifiers = [
 Note that Python classifiers are automatically added for you
 and are determined by your `python` requirement.
 
-The `license` property will also set the License classifier automatically.
-
 If you do not want Poetry to automatically add suitable classifiers
-based on the `python` requirement and `license` property,
-use `project.classifiers` instead of this setting.
+based on the `python` requirement, use `project.classifiers` instead of this setting.
 {{% /note %}}
 
 ### packages

poetry.lock

@@ -16,7 +16,7 @@ dependencies = [
     "installer (>=0.7.0,<0.8.0)",
     "keyring (>=25.1.0,<26.0.0)",
     # packaging uses calver, so version is unclamped
-    "packaging (>=24.0)",
+    "packaging (>=24.2)",  # PEP 639 support was added in 24.2
     "pkginfo (>=1.12,<2.0)",
     "platformdirs (>=3.0.0,<5)",
     "pyproject-hooks (>=1.0.0,<2.0.0)",
@@ -44,7 +44,7 @@ maintainers = [
     { name = "finswimmer", email = "[email protected]" },
     { name = "Bartosz Sokorski", email = "[email protected]" },
 ]
-license = { text = "MIT" }
+license = "MIT"
 readme = "README.md"
 keywords = ["packaging", "dependency", "poetry"]
 # classifieres is dynamic because we want to create Python classifiers automatically

pyproject.toml

@@ -216,8 +216,6 @@ def _add_scripts(self) -> list[Path]:
     def _add_dist_info(self, added_files: list[Path]) -> None:
         from poetry.core.masonry.builders.wheel import WheelBuilder
 
-        added_files = added_files[:]
-
         builder = WheelBuilder(self._poetry)
         dist_info = self._env.site_packages.mkdir(Path(builder.dist_info))
 
@@ -226,24 +224,15 @@ def _add_dist_info(self, added_files: list[Path]) -> None:
             f" <b>{dist_info.parent}</b>"
         )
 
-        with dist_info.joinpath("METADATA").open("w", encoding="utf-8") as f:
-            builder._write_metadata_file(f)
-
-        added_files.append(dist_info.joinpath("METADATA"))
+        builder.prepare_metadata(dist_info.parent)
+        for path in sorted(f for f in dist_info.rglob("*") if f.is_file()):
+            added_files.append(path)
 
         with dist_info.joinpath("INSTALLER").open("w", encoding="utf-8") as f:
             f.write("poetry")
 
         added_files.append(dist_info.joinpath("INSTALLER"))
 
-        if self.convert_entry_points():
-            with dist_info.joinpath("entry_points.txt").open(
-                "w", encoding="utf-8"
-            ) as f:
-                builder._write_entry_points(f)
-
-            added_files.append(dist_info.joinpath("entry_points.txt"))
-
         # write PEP 610 metadata
         direct_url_json = dist_info.joinpath("direct_url.json")
         direct_url_json.write_text(

src/poetry/masonry/builders/editable.py

@@ -173,6 +173,8 @@ def test_check_invalid(
 Error: Invalid source "not-exists" referenced in dependencies.
 Error: Invalid source "not-exists2" referenced in dependencies.
 Error: poetry.lock was not found.
+Warning: [project.license] is not a valid SPDX identifier.\
+ This is deprecated and will raise an error in the future.
 Warning: A wildcard Python dependency is ambiguous.\
  Consider specifying a more explicit one.
 Warning: The "pendulum" dependency specifies the "allows-prereleases" property,\

tests/console/commands/test_check.py

@@ -1,7 +1,7 @@
 [project]
 name = "invalid"
 version = "1.0.0"
-license = { text = "INVALID" }
+license = "INVALID"
 classifiers = [
     "Environment :: Console",
     "Intended Audience :: Clowns",

tests/fixtures/invalid_pyproject/pyproject.toml

@@ -0,0 +1 @@
+license ...

tests/fixtures/simple_project/LICENSE

@@ -5,7 +5,7 @@ description = "Some description."
 authors = [
     { name = "Sébastien Eustace", email = "[email protected]" }
 ]
-license = { text = "MIT" }
+license = "MIT"
 readme = "README.rst"
 keywords = ["packaging", "dependency", "poetry"]
 dynamic = [ "classifiers", "dependencies", "requires-python" ]

tests/fixtures/simple_project/pyproject.toml

@@ -0,0 +1 @@
+license ...