doc/python: use optional-dependencies instead of extras-require

This is the term that PEP 621 uses and it is less likely to be
misspelled.

https://peps.python.org/pep-0621/#dependencies-optional-dependencies

I was never sure if it was `extra` or `extras`, or `require` or
`requires` and finally committed a mistake in #167405.
main
Martin Weinelt 2 years ago
parent 394687bf39
commit 809ffd6cd3
No known key found for this signature in database
GPG Key ID: 87C1E9888F856759
  1. 7
      doc/languages-frameworks/python.section.md

@ -982,12 +982,13 @@ in python.withPackages(ps: [ps.blaze])).env
#### Optional extra dependencies #### Optional extra dependencies
Some packages define optional dependencies for additional features. With Some packages define optional dependencies for additional features. With
`setuptools` this is called `extras_require` and `flit` calls it `extras-require`. A `setuptools` this is called `extras_require` and `flit` calls it
`extras-require`, while PEP 621 calls these `optional-dependencies`. A
method for supporting this is by declaring the extras of a package in its method for supporting this is by declaring the extras of a package in its
`passthru`, e.g. in case of the package `dask` `passthru`, e.g. in case of the package `dask`
```nix ```nix
passthru.extras-require = { passthru.optional-dependencies = {
complete = [ distributed ]; complete = [ distributed ];
}; };
``` ```
@ -997,7 +998,7 @@ and letting the package requiring the extra add the list to its dependencies
```nix ```nix
propagatedBuildInputs = [ propagatedBuildInputs = [
... ...
] ++ dask.extras-require.complete; ] ++ dask.optional-dependencies.complete;
``` ```
Note this method is preferred over adding parameters to builders, as that can Note this method is preferred over adding parameters to builders, as that can

Loading…
Cancel
Save