Add support for licence-files option.

Author: domdfcoding

pyproject_parser/parsers.py

@@ -334,6 +334,7 @@ class PEP621Parser(RequiredKeysConfigParser):
 "readme",
 "requires-python",
 "license",
+"license-files",
 "authors",
 "maintainers",
 "keywords",
@@ -678,6 +679,51 @@ def parse_license(config: Dict[str, TOML_TYPES]) -> License:
 else:
 raise BadConfigError("The 'project.license' table should contain one of 'text' or 'file'.")
 
+# TODO: equivalent of PEP 621 direcrive for 639
+@_documentation_url("https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license-files")
+def parse_license_files(self, config: Dict[str, TOML_TYPES]) -> List[str]:
+"""
+Parse the ``license-files`` key, giving paths to the licence(s) for the project.
+
+* **Format**: :toml:`Array` of :toml:`strings <string>`
+* **Core Metadata**: :core-meta:`License-Files`
+
+.. versionadded:: 0.14.0
+
+.. latex:vspace:: -5px
+
+:bold-title:`Example:`
+
+.. code-block:: TOML
+
+[project]
+license-files = ["LICEN[CS]E*", "vendored/licenses/*.txt", "AUTHORS.md"]
+
+.. latex:vspace:: -5px
+
+:param config: The unparsed TOML config for the :pep621:`project table <table-name>`.
+"""
+
+parsed_paths = set()
+key_path = [self.table_name, "license-files"]
+
+license_files: List[str] = config["license-files"]
+self.assert_sequence_not_str(license_files, key_path)
+
+for idx, pattern in enumerate(license_files):
+name = construct_path(key_path) + f"[{idx}]"
+self.assert_indexed_type(pattern, str, key_path, idx=idx)
+if pattern.startswith('/'):
+raise BadConfigError(f"{name!r}: pattern cannot start with '/'")
+if '\\' in pattern:
+raise BadConfigError(f"{name!r}: pattern cannot contain '\\'")
+if ".." in pattern:
+raise BadConfigError(f"{name!r}: pattern cannot contain '..'")
+
+parsed_paths.add(pattern)
+
+return natsorted(parsed_paths, alg=ns.GROUPLETTERS)
+
 @staticmethod
 def _parse_authors(config: Dict[str, TOML_TYPES], key_name: str = "authors") -> List[Author]:
 all_authors: List[Author] = []

tests/test_cli.py

@@ -51,6 +51,10 @@
 f"[project]\nname = 'spam'\nlicense = 'MIT AND (Apache-2.0 OR BSD-2-Clause)'\nversion = '2020.0.0'\n",
 id="PEP639"
 ),
+pytest.param(
+f"[project]\nname = 'spam'\nlicense-files = ['LICEN[CS]E*', 'AUTHORS*']\nversion = '2020.0.0'\n",
+id="PEP639-FILES"
+),
 ]
 )
 @pytest.mark.parametrize("show_diff", [True, False])
@@ -82,7 +86,7 @@ def test_reformat(
 with in_directory(tmp_pathplus):
 result = cli_runner.invoke(reformat, args=args, catch_exceptions=False)
 
-assert result.exit_code == 0
+assert result.exit_code == 0, result.stdout
 
 advanced_file_regression.check_file(tmp_pathplus / "pyproject.toml")
 assert result.stdout == "Reformatting 'pyproject.toml'\n"

tests/test_cli_/test_reformat_False_PEP639_FILES_.diff

@@ -0,0 +1 @@
+Reformatting 'pyproject.toml'

tests/test_cli_/test_reformat_False_PEP639_FILES_.toml

@@ -0,0 +1,7 @@
+[project]
+name = "spam"
+version = "2020.0.0"
+license-files = [ "AUTHORS*", "LICEN[CS]E*",]
+dynamic = []
+
+[tool]

tests/test_cli_/test_reformat_True_PEP639_FILES_.diff

@@ -0,0 +1,15 @@
+Reformatting 'pyproject.toml'
+--- pyproject.toml	(original)
++++ pyproject.toml	(reformatted)
+@@ -1,5 +1,8 @@
+ [project]
+-name = 'spam'
+-license-files = ['LICEN[CS]E*', 'AUTHORS*']
+-version = '2020.0.0'
++name = "spam"
++version = "2020.0.0"
++license-files = [ "AUTHORS*", "LICEN[CS]E*",]
++dynamic = []
+
++[tool]
++

tests/test_cli_/test_reformat_True_PEP639_FILES_.toml

@@ -0,0 +1,7 @@
+[project]
+name = "spam"
+version = "2020.0.0"
+license-files = [ "AUTHORS*", "LICEN[CS]E*",]
+dynamic = []
+
+[tool]

tests/test_config.py

@@ -39,6 +39,17 @@
 id="pep639-and-or",
 ),
 pytest.param(f"{MINIMAL_CONFIG}\nlicense = 'LicenseRef-My-Custom-License'\n", id="pep639-custom"),
+pytest.param(
+f"{MINIMAL_CONFIG}\nlicense-files = ['LICEN[CS]E*', 'AUTHORS*']\n", id="pep639-files-1"
+),
+pytest.param(
+f"{MINIMAL_CONFIG}\nlicense-files = ['licenses/LICENSE.MIT', 'licenses/LICENSE.CC0']\n",
+id="pep639-files-2"
+),
+pytest.param(
+f"{MINIMAL_CONFIG}\nlicense-files = ['LICENSE.txt', 'licenses/*']\n", id="pep639-files-3"
+),
+pytest.param(f"{MINIMAL_CONFIG}\nlicense-files = []\n", id="pep639-files-empty"),
 ]
 )
 def test_pep621_class_valid_config(
@@ -422,6 +433,30 @@ def test_pep621_class_bad_config_license(
 r"'project.license-key' is not a valid SPDX Expression: \tUnknown license key\(s\): My-Custom-License",
 id="pep639-custom",
 ),
+pytest.param(
+f"{MINIMAL_CONFIG}\nlicense-files = 'LICENSE'\n",
+TypeError,
+"Invalid type for 'project.license-files': expected <class 'collections.abc.Sequence'>, got <class 'str'>",
+id="pep639-files-string",
+),
+pytest.param(
+f"{MINIMAL_CONFIG}\nlicense-files = ['../LICENSE']\n",
+BadConfigError,
+r"'project.license-files\[0\]': pattern cannot contain '..'",
+id="pep639-files-1",
+),
+pytest.param(
+f"{MINIMAL_CONFIG}\nlicense-files = ['/home/user/project/LICENSE']\n",
+BadConfigError,
+r"'project.license-files\[0\]': pattern cannot start with '/'",
+id="pep639-files-2",
+),
+pytest.param(
+f"{MINIMAL_CONFIG}\nlicense-files = ['vendor\\LICENSE.MIT']\n",
+BadConfigError,
+r"'project.license-files\[0\]': pattern cannot contain '\\'",
+id="pep639-files-3",
+),
 ]
 )
 def test_pep621_class_bad_config(

tests/test_config_/test_pep621_class_valid_config_pep639_files_1_False_.yml

@@ -0,0 +1,6 @@
+dynamic: []
+license-files:
+- AUTHORS*
+- LICEN[CS]E*
+name: spam
+version: 2020.0.0

tests/test_config_/test_pep621_class_valid_config_pep639_files_1_True_.yml

@@ -0,0 +1,20 @@
+authors: []
+classifiers: []
+dependencies: []
+description: null
+dynamic: []
+entry-points: {}
+gui-scripts: {}
+keywords: []
+license: null
+license-files:
+- AUTHORS*
+- LICEN[CS]E*
+maintainers: []
+name: spam
+optional-dependencies: {}
+readme: null
+requires-python: null
+scripts: {}
+urls: {}
+version: 2020.0.0

tests/test_config_/test_pep621_class_valid_config_pep639_files_2_False_.yml

@@ -0,0 +1,6 @@
+dynamic: []
+license-files:
+- licenses/LICENSE.CC0
+- licenses/LICENSE.MIT
+name: spam
+version: 2020.0.0