movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-10 19:55:41 +03:00
Code Issues Projects Releases Packages Wiki Activity

doc/python: clarify `optional-dependencies' are only for explicit dep groups (#377049)

Browse source 
Some project may claim, in their README or otherwise, a particular library as
an optional dependency. But it doesn't make it one in the context of the
`optional-dependencies` derivation attribute.
This commit is contained in:
Ihar Hrachyshka 2025-04-24 16:44:27 -04:00 • committed by GitHub
parent c4e6b68386
commit 8bf2436c01
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/languages-frameworks/python.section.md
View file

@ -2102,6 +2102,14 @@ Note this method is preferred over adding parameters to builders, as that can
result in packages depending on different variants and thereby causing
collisions.
::: {.note}
The `optional-dependencies` attribute should only be used for dependency groups
as defined in package metadata. If a package gracefully handles missing
dependencies in runtime but doesn't advertise it through package metadata, then
these dependencies should not be listed at all. (One may still have to list
them in `nativeCheckInputs` to pass test suite.)
:::
### How to contribute a Python package to nixpkgs? {#tools}
Packages inside nixpkgs must use the [`buildPythonPackage`](#buildpythonpackage-function) or [`buildPythonApplication`](#buildpythonapplication-function) function directly,