Skip to content

Python: Add overrideAttrs attribute aliasing overridePythonAttrs#82772

Closed
adisbladis wants to merge 2 commits intoNixOS:masterfrom
adisbladis:python-overrideattrs
Closed

Python: Add overrideAttrs attribute aliasing overridePythonAttrs#82772
adisbladis wants to merge 2 commits intoNixOS:masterfrom
adisbladis:python-overrideattrs

Conversation

@adisbladis
Copy link
Member

@adisbladis adisbladis commented Mar 17, 2020 •
edited
Loading

Motivation for this change

This will make lib.makeOverridable use overridePythonAttrs by default.

Overriding Python packages has some surprising properties unless you use overridePythonAttrs and it can be incredibly frustrating to try and find out why that is.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@adisbladis
Python: Add overrideAttrs attribute aliasing overridePythonAttrs
bfa1dd9 
This will make lib.makeOverridable use overridePythonAttrs by default.
@adisbladis
Copy link
Member Author

adisbladis commented Mar 17, 2020

@FRidh What kind of tests do you have in mind?

@ofborg ofborg bot added the 6.topic: python Python is a high-level, general-purpose programming language. label Mar 17, 2020
@FRidh
Copy link
Member

FRidh commented Mar 17, 2020

Testing that buildPythonPackage is indeed invoked again. One way to assert this is by adding to propagatedBuildInputs and testing it has an affect on requiredPythonModules, which serves as input to python.buildEnv.

@FRidh
Copy link
Member

FRidh commented Mar 17, 2020 •
edited
Loading

cc @alyssais because of #46842.

That discussion was already a year and a half ago...time flies.

@ofborg ofborg bot added 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Mar 17, 2020
@FRidh FRidh added the 6.topic: user experience NixOS / Nixpkgs end user experience label Mar 17, 2020
@adisbladis adisbladis force-pushed the python-overrideattrs branch from 8089e70 to 4e3f282 Compare March 17, 2020 10:30
@adisbladis
Copy link
Member Author

adisbladis commented Mar 17, 2020

@FRidh I added a test. Since it's not actually building anything but only asserts attributes I made a new type of test.

@adisbladis adisbladis force-pushed the python-overrideattrs branch from 4e3f282 to d117f06 Compare March 17, 2020 10:32
@FRidh
Copy link
Member

FRidh commented Mar 17, 2020

@GrahamcOfBorg build python2.tests python3.tests python38.tests

@FRidh
Copy link
Member

FRidh commented Mar 17, 2020

@GrahamcOfBorg build pypy2.tests pypy3.tests

@FRidh
Copy link
Member

FRidh commented Mar 17, 2020

Let's wait a bit with merging this.

@FRidh FRidh mentioned this pull request Mar 17, 2020
Closed
9 tasks
@alyssais
Copy link
Member

alyssais commented Mar 17, 2020

@FRidh yiu don’t think this needs an RFC any more?

@FRidh
Copy link
Member

FRidh commented Mar 17, 2020

Right, I wrote that. I do think it is best we standardize interfaces like these and I see you asked matthewbauer at the time to help with it. Let's write a small RFC and see where that takes us.

@FRidh
Copy link
Member

FRidh commented Mar 17, 2020

RFC proposal #46842 (comment)

@FRidh FRidh mentioned this pull request Mar 18, 2020
Closed
FRidh added a commit that referenced this pull request Apr 26, 2020
@FRidh
Revert "docs/python: document builders using doInstallCheck and not d…
ca2fd28 
…oCheck (#86051)"

For disabling tests when overriding, use `.overridePythonAttrs`.

Discussion about aliasing `.overridePythonAttrs` to `.overrideAttrs`.
#82772

This reverts commit 3581287.
@infinisil
Copy link
Member

infinisil commented Aug 22, 2020

Not sure about this, because we already have a bunch of override mechanisms which all work slightly differently. And by doing this it gets even more complex because it mixes ones name with anothers behavior. But then again, python packages accept pretty much all arguments of mkDerivation and juts forward them, so .overrideAttrs would mostly still behave the same for mkDerivation argument overrides. But still, I feel like this is going in the wrong direction of mixing concepts.

@ryantm ryantm added 2.status: merge conflict This PR has merge conflicts with the target branch and removed 2.status: merge conflict This PR has merge conflicts with the target branch labels Oct 3, 2020
@adisbladis
Copy link
Member Author

adisbladis commented Feb 13, 2021

Closing, see NixOS/rfcs#67.

@adisbladis adisbladis closed this Feb 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@FRidh FRidh FRidh approved these changes

@jonringer jonringer jonringer approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

2.status: merge conflict This PR has merge conflicts with the target branch 6.topic: python Python is a high-level, general-purpose programming language. 6.topic: user experience NixOS / Nixpkgs end user experience 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@adisbladis @FRidh @alyssais @infinisil @jonringer @ryantm