ilyakooo0/nixpkgs
1
0
Fork 0
mirror of https://github.com/ilyakooo0/nixpkgs.git synced 2025-01-08 06:28:50 +03:00
Code Issues Projects Releases Wiki Activity

doc: improve Python section (#116344)

Browse Source 
Avoid confusion as in https://github.com/NixOS/nixpkgs/pull/116325#discussion_r593946638.
This commit is contained in:
Robert Schütz 2021-03-24 13:03:31 +01:00 committed by GitHub
parent a710de5592
commit 7dfc2d269b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/languages-frameworks/python.section.md
View File

@ -638,7 +638,7 @@ are disabled.
#### Using pythonImportsCheck #### Using pythonImportsCheck
Although unit tests are highly prefered to valid correctness of a package. Not Although unit tests are highly prefered to validate correctness of a package, not
all packages have test suites that can be ran easily, and some have none at all. all packages have test suites that can be ran easily, and some have none at all.
To help ensure the package still works, `pythonImportsCheck` can attempt to import To help ensure the package still works, `pythonImportsCheck` can attempt to import
the listed modules. the listed modules.
@ -1551,13 +1551,11 @@ In a `setup.py` or `setup.cfg` it is common to declare dependencies:
### Contributing guidelines ### Contributing guidelines
Following rules are desired to be respected: The following rules are desired to be respected:
* Python libraries are called from `python-packages.nix` and packaged with * Python libraries are called from `python-packages.nix` and packaged with
`buildPythonPackage`. The expression of a library should be in `buildPythonPackage`. The expression of a library should be in
`pkgs/development/python-modules/<name>/default.nix`. `pkgs/development/python-modules/<name>/default.nix`.
* Libraries in `pkgs/top-level/python-packages.nix` are sorted
alphanumerically to avoid merge conflicts and ease locating attributes.
* Python applications live outside of `python-packages.nix` and are packaged * Python applications live outside of `python-packages.nix` and are packaged
with `buildPythonApplication`. with `buildPythonApplication`.
* Make sure libraries build for all Python interpreters. * Make sure libraries build for all Python interpreters.
@ -1567,8 +1565,11 @@ Following rules are desired to be respected:
case, when you disable tests, leave a comment explaining why. case, when you disable tests, leave a comment explaining why.
* Commit names of Python libraries should reflect that they are Python * Commit names of Python libraries should reflect that they are Python
libraries, so write for example `pythonPackages.numpy: 1.11 -> 1.12`. libraries, so write for example `pythonPackages.numpy: 1.11 -> 1.12`.
* Attribute names in `python-packages.nix` should be normalized according to * Attribute names in `python-packages.nix` as well as `pname`s should match the
[PEP 0503](https://www.python.org/dev/peps/pep-0503/#normalized-names). This library's name on PyPI, but be normalized according to [PEP
means that characters should be converted to lowercase and `.` and `_` should 0503](https://www.python.org/dev/peps/pep-0503/#normalized-names). This means
be replaced by a single `-` (foo-bar-baz instead of Foo__Bar.baz ) that characters should be converted to lowercase and `.` and `_` should be
* Attribute names in `python-packages.nix` should be sorted alphanumerically. replaced by a single `-` (foo-bar-baz instead of Foo__Bar.baz).
If necessary, `pname` has to be given a different value within `fetchPypi`.
* Attribute names in `python-packages.nix` should be sorted alphanumerically to
avoid merge conflicts and ease locating attributes.