Skip to content

Commit 2f2c7ee

Browse files
authored
PEP 751: address some minor user feedback (#4330)
Made it explicit that `dependency-groups` represents the groups users are expected to be able to set via a tool's UI. Also made clear what `extras` and `dependency_groups` should be set to by default.
1 parent 82f6e4c commit 2f2c7ee

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

peps/pep-0751.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,9 @@ consistent order. Usage of inline tables SHOULD also be kept consistent.
229229
- **Type**: Array of strings
230230
- **Required?**: no; defaults to ``[]``
231231
- **Inspiration**: :ref:`packaging:pyproject-tool-table`
232-
- The list of :ref:`packaging:dependency-groups` supported by this lock file.
232+
- The list of :ref:`packaging:dependency-groups` publicly supported by this lock
233+
file (i.e. dependency groups users are expected to be able to specify via a
234+
tool's UI).
233235
- Lockers MAY choose to not support writing lock files that support extras and
234236
dependency groups (i.e. tools may only support exporting a single-use lock
235237
file).
@@ -907,6 +909,13 @@ The following outlines the steps to be taken to install from a lock file
907909
(while the requirements are prescriptive, the general steps and order are
908910
a suggestion):
909911

912+
#. Gather the extras and dependency groups to install and set ``extras`` and
913+
``dependency_groups`` for marker evaluation, respectively.
914+
915+
#. ``extras`` SHOULD be set to the empty set by default.
916+
#. ``dependency_groups`` SHOULD be the set created from ``default-groups`` by
917+
default.
918+
910919
#. Check if the metadata version specified by ``lock-version`` is supported;
911920
an error or warning MUST be raised as appropriate.
912921
#. If ``requires-python`` is specified, check that the environment being

0 commit comments

Comments
 (0)