Skip to content

Commit e39d17e

Browse files
[PEP 771]
1 parent a443f76 commit e39d17e

File tree

12 files changed

+376
-145
lines changed

12 files changed

+376
-145
lines changed

Diff for: pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ keywords = "setuptools.dist:Distribution._finalize_setup_keywords"
174174
eager_resources = "setuptools.dist:assert_string_list"
175175
namespace_packages = "setuptools.dist:check_nsp"
176176
extras_require = "setuptools.dist:check_extras"
177+
default_extras_require = "setuptools.dist:check_default_extras_require"
177178
install_requires = "setuptools.dist:check_requirements"
178179
setup_requires = "setuptools.dist:check_requirements"
179180
python_requires = "setuptools.dist:check_specifier"

Diff for: setuptools/_core_metadata.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
def get_metadata_version(self):
2929
mv = getattr(self, 'metadata_version', None)
3030
if mv is None:
31-
mv = Version('2.2')
31+
mv = Version('2.5')
3232
self.metadata_version = mv
3333
return mv
3434

@@ -223,6 +223,9 @@ def _write_requirements(self, file):
223223
for req in _reqs.parse(self.install_requires):
224224
file.write(f"Requires-Dist: {req}\n")
225225

226+
for req in _reqs.parse(self.default_extras_require):
227+
file.write(f"Default-Extra: {req}\n")
228+
226229
processed_extras = {}
227230
for augmented_extra, reqs in self.extras_require.items():
228231
# Historically, setuptools allows "augmented extras": `<extra>:<condition>`
@@ -311,6 +314,7 @@ def _distribution_fullname(name: str, version: str) -> str:
311314
"project-url": "project_urls",
312315
"provides": "provides",
313316
# "provides-dist": "provides_dist", # NOT USED
317+
"default-extra": "default_extras_require",
314318
"provides-extra": "extras_require",
315319
"requires": "requires",
316320
"requires-dist": "install_requires",

Diff for: setuptools/_vendor/importlib_metadata/_adapters.py

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ class Message(email.message.Message):
1515
'Platform',
1616
'Project-URL',
1717
'Provides-Dist',
18+
'Default-Extra'
1819
'Provides-Extra',
1920
'Requires-Dist',
2021
'Requires-External',

Diff for: setuptools/_vendor/packaging/metadata.py

+12-2
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,9 @@ class RawMetadata(TypedDict, total=False):
132132
license_expression: str
133133
license_files: list[str]
134134

135+
# Metadata 2.5 - PEP 771
136+
default_extra: list[str]
137+
135138

136139
_STRING_FIELDS = {
137140
"author",
@@ -253,6 +256,7 @@ def _get_payload(msg: email.message.Message, source: bytes | str) -> str:
253256
"author-email": "author_email",
254257
"classifier": "classifiers",
255258
"description": "description",
259+
"default-extra": "default_extra",
256260
"description-content-type": "description_content_type",
257261
"download-url": "download_url",
258262
"dynamic": "dynamic",
@@ -463,8 +467,8 @@ def parse_email(data: bytes | str) -> tuple[RawMetadata, dict[str, list[str]]]:
463467

464468

465469
# Keep the two values in sync.
466-
_VALID_METADATA_VERSIONS = ["1.0", "1.1", "1.2", "2.1", "2.2", "2.3", "2.4"]
467-
_MetadataVersion = Literal["1.0", "1.1", "1.2", "2.1", "2.2", "2.3", "2.4"]
470+
_VALID_METADATA_VERSIONS = ["1.0", "1.1", "1.2", "2.1", "2.2", "2.3", "2.4", "2.5"]
471+
_MetadataVersion = Literal["1.0", "1.1", "1.2", "2.1", "2.2", "2.3", "2.4", "2.5"]
468472

469473
_REQUIRED_ATTRS = frozenset(["metadata_version", "name", "version"])
470474

@@ -861,3 +865,9 @@ def from_email(cls, data: bytes | str, *, validate: bool = True) -> Metadata:
861865
"""``Provides`` (deprecated)"""
862866
obsoletes: _Validator[list[str] | None] = _Validator(added="1.1")
863867
"""``Obsoletes`` (deprecated)"""
868+
# PEP 771 lets us define a default `extras_require` if none is passed by the
869+
# user.
870+
default_extra: _Validator[list[utils.NormalizedName] | None] = _Validator(
871+
added="2.5",
872+
)
873+
""":external:ref:`core-metadata-default-extra`"""

Diff for: setuptools/_vendor/wheel/metadata.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -142,12 +142,12 @@ def generate_requirements(
142142

143143
def pkginfo_to_metadata(egg_info_path: str, pkginfo_path: str) -> Message:
144144
"""
145-
Convert .egg-info directory with PKG-INFO to the Metadata 2.1 format
145+
Convert .egg-info directory with PKG-INFO to the Metadata 2.5 format
146146
"""
147147
with open(pkginfo_path, encoding="utf-8") as headers:
148148
pkg_info = Parser().parse(headers)
149149

150-
pkg_info.replace_header("Metadata-Version", "2.1")
150+
pkg_info.replace_header("Metadata-Version", "2.5")
151151
# Those will be regenerated from `requires.txt`.
152152
del pkg_info["Provides-Extra"]
153153
del pkg_info["Requires-Dist"]

Diff for: setuptools/config/_apply_pyprojecttoml.py

+10
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,13 @@ def _dependencies(dist: Distribution, val: list, _root_dir: StrPath | None):
226226
dist.install_requires = val
227227

228228

229+
def _default_optional_dependencies(dist: Distribution, val: dict, _root_dir: StrPath | None):
230+
if getattr(dist, "default_extras_require", None):
231+
msg = "`default_extras_require` overwritten in `pyproject.toml` (default-optional-dependencies)"
232+
SetuptoolsWarning.emit(msg)
233+
dist.default_extras_require = val
234+
235+
229236
def _optional_dependencies(dist: Distribution, val: dict, _root_dir: StrPath | None):
230237
if getattr(dist, "extras_require", None):
231238
msg = "`extras_require` overwritten in `pyproject.toml` (optional-dependencies)"
@@ -396,6 +403,7 @@ def _acessor(obj):
396403
"urls": _project_urls,
397404
"dependencies": _dependencies,
398405
"optional_dependencies": _optional_dependencies,
406+
"default_optional_dependencies": _default_optional_dependencies,
399407
"requires_python": _python_requires,
400408
}
401409

@@ -441,6 +449,7 @@ def _acessor(obj):
441449
"scripts": _get_previous_scripts,
442450
"gui-scripts": _get_previous_gui_scripts,
443451
"dependencies": _attrgetter("install_requires"),
452+
"default-optional-dependencies": _attrgetter("default_extras_require"),
444453
"optional-dependencies": _attrgetter("extras_require"),
445454
}
446455

@@ -458,6 +467,7 @@ def _acessor(obj):
458467
"scripts": _static.EMPTY_DICT,
459468
"gui-scripts": _static.EMPTY_DICT,
460469
"dependencies": _static.EMPTY_LIST,
470+
"default-optional-dependencies": _static.EMPTY_LIST,
461471
"optional-dependencies": _static.EMPTY_DICT,
462472
}
463473

Diff for: setuptools/config/_validate_pyproject/extra_validations.py

+31-1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ class RedefiningStaticFieldAsDynamic(ValidationError):
2424
)
2525

2626

27+
class IncludedDependencyGroupMustExist(ValidationError):
28+
_DESC = """An included dependency group must exist and must not be cyclic.
29+
"""
30+
__doc__ = _DESC
31+
_URL = "https://peps.python.org/pep-0735/"
32+
33+
2734
def validate_project_dynamic(pyproject: T) -> T:
2835
project_table = pyproject.get("project", {})
2936
dynamic = project_table.get("dynamic", [])
@@ -49,4 +56,27 @@ def validate_project_dynamic(pyproject: T) -> T:
4956
return pyproject
5057

5158

52-
EXTRA_VALIDATIONS = (validate_project_dynamic,)
59+
def validate_include_depenency(pyproject: T) -> T:
60+
dependency_groups = pyproject.get("dependency-groups", {})
61+
for key, value in dependency_groups.items():
62+
for each in value:
63+
if (
64+
isinstance(each, dict)
65+
and (include_group := each.get("include-group"))
66+
and include_group not in dependency_groups
67+
):
68+
raise IncludedDependencyGroupMustExist(
69+
message=f"The included dependency group {include_group} doesn't exist",
70+
value=each,
71+
name=f"data.dependency_groups.{key}",
72+
definition={
73+
"description": cleandoc(IncludedDependencyGroupMustExist._DESC),
74+
"see": IncludedDependencyGroupMustExist._URL,
75+
},
76+
rule="PEP 735",
77+
)
78+
# TODO: check for `include-group` cycles (can be conditional to graphlib)
79+
return pyproject
80+
81+
82+
EXTRA_VALIDATIONS = (validate_project_dynamic, validate_include_depenency)

Diff for: setuptools/config/_validate_pyproject/fastjsonschema_validations.py

+242-135
Large diffs are not rendered by default.

Diff for: setuptools/config/_validate_pyproject/formats.py

+30-3
Original file line numberDiff line numberDiff line change
@@ -164,12 +164,15 @@ class _TroveClassifier:
164164
"""
165165

166166
downloaded: typing.Union[None, "Literal[False]", typing.Set[str]]
167+
"""
168+
None => not cached yet
169+
False => unavailable
170+
set => cached values
171+
"""
167172

168173
def __init__(self) -> None:
169174
self.downloaded = None
170175
self._skip_download = False
171-
# None => not cached yet
172-
# False => cache not available
173176
self.__name__ = "trove_classifier" # Emulate a public function
174177

175178
def _disable_download(self) -> None:
@@ -351,7 +354,7 @@ def python_entrypoint_reference(value: str) -> bool:
351354
obj = rest
352355

353356
module_parts = module.split(".")
354-
identifiers = _chain(module_parts, obj.split(".")) if rest else module_parts
357+
identifiers = _chain(module_parts, obj.split(".")) if rest else iter(module_parts)
355358
return all(python_identifier(i.strip()) for i in identifiers)
356359

357360

@@ -373,3 +376,27 @@ def uint(value: builtins.int) -> bool:
373376
def int(value: builtins.int) -> bool:
374377
r"""Signed 64-bit integer (:math:`-2^{63} \leq x < 2^{63}`)"""
375378
return -(2**63) <= value < 2**63
379+
380+
381+
try:
382+
from packaging import licenses as _licenses
383+
384+
def SPDX(value: str) -> bool:
385+
"""See :ref:`PyPA's License-Expression specification
386+
<pypa:core-metadata-license-expression>` (added in :pep:`639`).
387+
"""
388+
try:
389+
_licenses.canonicalize_license_expression(value)
390+
return True
391+
except _licenses.InvalidLicenseExpression:
392+
return False
393+
394+
except ImportError: # pragma: no cover
395+
_logger.warning(
396+
"Could not find an up-to-date installation of `packaging`. "
397+
"License expressions might not be validated. "
398+
"To enforce validation, please install `packaging>=24.2`."
399+
)
400+
401+
def SPDX(value: str) -> bool:
402+
return True

Diff for: setuptools/config/pyprojecttoml.py

+11
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,7 @@ def _expand_all_dynamic(self, dist: Distribution, package_dir: Mapping[str, str]
249249
"gui-scripts",
250250
"classifiers",
251251
"dependencies",
252+
"default-optional-dependencies",
252253
"optional-dependencies",
253254
)
254255
# `_obtain` functions are assumed to raise appropriate exceptions/warnings.
@@ -263,6 +264,7 @@ def _expand_all_dynamic(self, dist: Distribution, package_dir: Mapping[str, str]
263264
readme=self._obtain_readme(dist),
264265
classifiers=self._obtain_classifiers(dist),
265266
dependencies=self._obtain_dependencies(dist),
267+
default_optional_dependencies=self._obtain_default_optional_dependencies(dist),
266268
optional_dependencies=self._obtain_optional_dependencies(dist),
267269
)
268270
# `None` indicates there is nothing in `tool.setuptools.dynamic` but the value
@@ -370,6 +372,15 @@ def _obtain_dependencies(self, dist: Distribution):
370372
return _parse_requirements_list(value)
371373
return None
372374

375+
def _obtain_default_optional_dependencies(self, dist: Distribution):
376+
if "default-optional-dependencies" in self.dynamic:
377+
value = self._obtain(dist, "default-optional-dependencies", {})
378+
if value:
379+
return _parse_requirements_list(value)
380+
assert "extras_require" in dist.__dict__
381+
assert "default_extras_require" in dist.__dict__
382+
return None
383+
373384
def _obtain_optional_dependencies(self, dist: Distribution):
374385
if "optional-dependencies" not in self.dynamic:
375386
return None

Diff for: setuptools/config/setuptools.schema.json

+1
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,7 @@
222222
"description": {"$ref": "#/definitions/file-directive"},
223223
"entry-points": {"$ref": "#/definitions/file-directive"},
224224
"dependencies": {"$ref": "#/definitions/file-directive-for-dependencies"},
225+
"default-optional-dependencies": {"$ref": "#/definitions/attr-directive"},
225226
"optional-dependencies": {
226227
"type": "object",
227228
"propertyNames": {"type": "string", "format": "pep508-identifier"},

Diff for: setuptools/dist.py

+30-1
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,17 @@ def check_nsp(dist, attr, value):
132132
)
133133

134134

135+
def check_default_extras_require(dist, attr, value):
136+
"""Verify that extras_require mapping is valid"""
137+
try:
138+
assert isinstance(value, (list, tuple))
139+
assert all(isinstance(val, str) for val in value)
140+
except AssertionError as e:
141+
raise DistutilsSetupError(
142+
"'default_extras_require' must be a a list whose values are strings."
143+
) from e
144+
145+
135146
def check_extras(dist, attr, value):
136147
"""Verify that extras_require mapping is valid"""
137148
try:
@@ -292,6 +303,7 @@ class Distribution(_Distribution):
292303
'license_files': lambda: None,
293304
'install_requires': list,
294305
'extras_require': dict,
306+
'default_extras_require': list,
295307
}
296308

297309
# Used by build_py, editable_wheel and install_lib commands for legacy namespaces
@@ -314,7 +326,11 @@ def __init__(self, attrs: MutableMapping[str, Any] | None = None) -> None:
314326
vars(self).setdefault(ep.name, None)
315327

316328
metadata_only = set(self._DISTUTILS_UNSUPPORTED_METADATA)
317-
metadata_only -= {"install_requires", "extras_require"}
329+
metadata_only -= {
330+
"install_requires",
331+
"extras_require",
332+
"default_extras_require",
333+
}
318334
dist_attrs = {k: v for k, v in attrs.items() if k not in metadata_only}
319335
_Distribution.__init__(self, dist_attrs)
320336

@@ -380,6 +396,7 @@ def _finalize_requires(self):
380396
self._normalize_requires()
381397
self.metadata.install_requires = self.install_requires
382398
self.metadata.extras_require = self.extras_require
399+
self.metadata.default_extras_require = self.default_extras_require
383400

384401
if self.extras_require:
385402
for extra in self.extras_require.keys():
@@ -392,6 +409,7 @@ def _normalize_requires(self):
392409
"""Make sure requirement-related attributes exist and are normalized"""
393410
install_requires = getattr(self, "install_requires", None) or []
394411
extras_require = getattr(self, "extras_require", None) or {}
412+
default_extras_require = getattr(self, "default_extras_require", None) or []
395413

396414
# Preserve the "static"-ness of values parsed from config files
397415
list_ = _static.List if _static.is_static(install_requires) else list
@@ -402,6 +420,17 @@ def _normalize_requires(self):
402420
(k, list(map(str, _reqs.parse(v or [])))) for k, v in extras_require.items()
403421
)
404422

423+
self.default_extras_require = []
424+
for extra in default_extras_require:
425+
if extra not in self.extras_require:
426+
raise ValueError(
427+
f"The default-extra `{extra}` does not exists in `extras_require`."
428+
)
429+
self.default_extras_require.append(extra)
430+
431+
list_ = _static.List if _static.is_static(default_extras_require) else list
432+
self.default_extras_require = list_(self.default_extras_require)
433+
405434
def _finalize_license_files(self) -> None:
406435
"""Compute names of all license files which should be included."""
407436
license_files: list[str] | None = self.metadata.license_files

0 commit comments

Comments
 (0)