Skip to content

PEP 771: Renamed default-optional-dependency-keys to default-extras #4459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions peps/pep-0771.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,12 @@ New key in ``[project]`` metadata table
A new key will be added to the ``[project]`` table in project metadata as
originally defined in :pep:`621` and now defined in the `PyPA specifications
<https://packaging.python.org/en/latest/specifications/pyproject-toml/>`_. This key will be named
``default-optional-dependency-keys`` with the following description:
``default-extras`` with the following description:

* `TOML <https://toml.io/>`_ type: Array of strings
* Corresponding core metadata field: ``Default-Extra``

Each string in ``default-optional-dependency-keys`` must be the name of an extra
Each string in ``default-extras`` must be the name of an extra
defined in `optional-dependencies
<https://packaging.python.org/en/latest/specifications/pyproject-toml/#dependencies-optional-dependencies>`_,
and each extra in this array will be converted to a matching ``Default-Extra``
Expand All @@ -160,7 +160,7 @@ produce the example ``Default-Extra`` entries presented in the previous section
.. code-block:: toml

[project]
default-optional-dependency-keys = [
default-extras = [
"recommended",
]

Expand All @@ -169,7 +169,7 @@ and:
.. code-block:: toml

[project]
default-optional-dependency-keys = [
default-extras = [
"backend1",
"backend2",
"backend3"
Expand Down Expand Up @@ -263,7 +263,7 @@ would choose to have this be included as a default extra:
.. code-block:: toml

[project]
default-optional-dependency-keys = [
default-extras = [
"recommended"
]

Expand All @@ -286,7 +286,7 @@ extra:
.. code-block:: toml

[project]
default-optional-dependency-keys = [
default-extras = [
"recommended"
]

Expand Down Expand Up @@ -327,7 +327,7 @@ for each backend or frontend, and provide a default, e.g.:
.. code-block:: toml

[project]
default-optional-dependency-keys = [
default-extras = [
"backend1"
]

Expand All @@ -354,7 +354,7 @@ could define the following configuration:
.. code-block:: toml

[project]
default-optional-dependency-keys = [
default-extras = [
"pyqt5"
]

Expand Down Expand Up @@ -406,7 +406,7 @@ This could be achieved with e.g:
.. code-block:: toml

[project]
default-optional-dependency-keys = [
default-extras = [
"recommended"
]

Expand Down Expand Up @@ -438,7 +438,7 @@ configuration would solve this case:
.. code-block:: toml

[project]
default-optional-dependency-keys = [
default-extras = [
"recommended"
]

Expand Down