Replace overridePythonAttrs with overrideArgs, add for Rust and Go as well #46842

alyssais · 2018-09-18T16:52:28Z

Motivation for this change

This allows, eg, specifying a custom src to use a different version of a package, like overrideAttrs does for normal packages, or overridePythonAttrs for Python packages.

Things done

Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
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 nox --run "nox-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)
Fits CONTRIBUTING.md.

This allows, eg, patches that require extraSrcs to be applied to Go packages. It's similar to `overridePythonAttrs`, and to the `overrideRustAttrs` function I propose in NixOS#46842.

matthewbauer · 2018-10-16T21:53:34Z

Maybe we should normalize this name to something like overrideArgs or something... This kind of thing could become common across different packages.

alyssais · 2018-10-17T15:07:41Z

I think that would be a good idea, especially since I've already needed overrideGoAttrs (#47425). overrideArgs isn't a very clear name – I'd expect that to do what override does now, but maybe there isn't a better one. I'll have a go at implementing it anyway, converting what already exists, and we could change the name if we think of a better one.

This will allow consistency between override functions for various language-specific build functions.

This allows, eg, specifying a custom src to use a different version of a package, like overrideAttrs does for normal packages, or overrideArgs for Python packages.

alyssais · 2018-10-21T15:54:21Z

I’ve renamed overridePythonAttrs to overrideArgs, done the same for overrideRustAttrs, and added one for Go to replace #47425.

This allows, eg, patches that require extraSrcs to be applied to Go packages. It's similar to `overrideArgs` in `buildPythonPackage` and `buildRustPackage`.

FRidh · 2018-10-22T07:03:05Z

I am against renaming the functions in this PR. overridePythonAttrs is used a lot outside of Nixpkgs already and I don't want to do any such ad-hoc standardization without going through an RFC where we identify and decide on parts to standardize.

alyssais · 2018-10-22T15:36:20Z

Going through an RFC makes sense I suppose

alyssais · 2018-10-23T17:32:13Z

@matthewbauer would you be willing to co-author an RFC?

FRidh · 2019-01-04T15:46:07Z

overrideDerivation is used to override the call to derivation
overrideAttrs is used to override the call to stdenv.mkDerivation
override is used to override the last function call. Often this will be the callPackage call.
overridePythonAttrs is used to override the call to buildPython*.

@alyssais what you are interested in, overrideArgs, is having a standard call to build*Package functions.

The buildPython* function calls stdenv.mkDerivation with a modified set of arguments that were passed to itself. In the case of Python packages there is no valid reason for using overrideAttrs anymore. Seeing that, and assuming it's the same for other build*Package functions, we could say these build*Package functions should simply use overrideAttrs for overriding the call to them.

alyssais · 2019-01-06T02:21:30Z

The `buildPython*` function calls `stdenv.mkDerivation` with a modified set of arguments that were passed to itself. In the case of Python packages there is no valid reason for using `overrideAttrs` anymore. Seeing that, and assuming it's the same for other `build*Package` functions, we could say these `build*Package` functions should simply use `overrideAttrs` for overriding the call to them.

Interesting. Indeed, I'm having trouble thinking of a situation in which I'd want to call overrideAttrs on a Python/Go/Rust package -- if the build*Package function is sufficiently customisable, it should be possible to change everything I could possibly want to change through that. My one concern with such an approach is that it could be surprising to have overrideAttrs do different things depending on how mkDerivation was ultimately invoked, but I think it could be argued that the current situation, where using overrideAttrs will just break things and there's no supported way to eg add patches at all is even more surprising.

FRidh · 2019-01-06T08:10:02Z

In the case of buildPython*, everything that's given is passed along to stdenv.mkDerivation, it's just that along the way it modifies some attributes. At the time when I added this it was hard to say whether reusing overrideAttrs for this would be a problem, but in retrospect I think it could have been fine.

I agree with you that it could be confusing if a build*Package.overrideAttrs behaves somewhat differently from stdenv.mkDerivation.overrideAttrs. So that would be a good argument against reusing overrideAttrs.

CMCDragonkai · 2019-04-26T06:41:14Z

Why stop at python, go and rust. I want this in Haskell too and everything else.

FRidh · 2020-03-17T10:52:49Z

#82772 maps overrideAttrs to overridePythonAttrs. Maybe this can be done with the other builders as well?

FRidh · 2020-03-17T11:53:22Z

RFC proposal https://github.com/NixOS/rfcs/compare/master...FRidh:overrideattrs?expand=1
Shall we go through with that?

danbst · 2020-03-17T17:17:05Z

@FRidh would it be hard to actually define full builder hierarchy for this RFC? Of top of my head, there are:

* derivation { }
** stdenv.mkDerivation {}
*** runCommand* {} and other trivial builders (writeFile, writeScript, writeScriptBin)
**** buildEnv
***** python.withPackages {}
*** python.pkgs.buildPythonPackage {}
*** python.pkgs.buildPythonApplication {}
*** mkDerivation {} # <-- Qt (!) TODO rename
*** androidenv.buildApp {}

there are many more, but at least it would good to know that python.withPackages is a different branch than buildPythonApplication, and it can also be overriden.

Maybe this hierarchy can be crowdsourced as part of RFC

FRidh · 2020-03-18T09:46:10Z

@danbst I've opened a PR now, please post on NixOS/rfcs#67

stale · 2021-08-04T22:43:03Z

I marked this as stale due to inactivity. → More info

nyabinary · 2023-12-19T15:40:39Z

This should be closed, right? Since it uh pretty stale

GrahamcOfBorg added 6.topic: rust 10.rebuild-darwin: 0 10.rebuild-linux: 0 labels Sep 18, 2018

alyssais mentioned this pull request Sep 27, 2018

buildGoPackage: add overrideGoAttrs #47425

Closed

9 tasks

alyssais added 2 commits October 21, 2018 15:46

buildPythonPackage: rename overrideArgs

0cdd27f

This will allow consistency between override functions for various language-specific build functions.

buildRustPackage: add overrideArgs to output

ae0b649

This allows, eg, specifying a custom src to use a different version of a package, like overrideAttrs does for normal packages, or overrideArgs for Python packages.

alyssais force-pushed the overrideRustAttrs branch from 1444826 to e7214ec Compare October 21, 2018 15:52

alyssais requested a review from FRidh as a code owner October 21, 2018 15:52

alyssais changed the title ~~buildRustPackage: add overrideRustAttrs to output~~ Replace overridePythonAttrs with overrideArgs, add for Rust and Go as well Oct 21, 2018

buildGoPackage: add overrideArgs

5900b6a

This allows, eg, patches that require extraSrcs to be applied to Go packages. It's similar to `overrideArgs` in `buildPythonPackage` and `buildRustPackage`.

alyssais force-pushed the overrideRustAttrs branch from e7214ec to 5900b6a Compare October 21, 2018 15:55

GrahamcOfBorg added 6.topic: golang 6.topic: nixos 6.topic: python 8.has: documentation labels Oct 21, 2018

FRidh mentioned this pull request Apr 3, 2019

mvnix-update uses .override which blocks the use of callPackage nix-community/mavenix#18

Closed

deliciouslytyped mentioned this pull request Aug 7, 2019

[RFC] Proposal: Engineering a Common "Plugin" Infrastructure #59344

Open

FRidh mentioned this pull request Mar 17, 2020

Python: Add overrideAttrs attribute aliasing overridePythonAttrs #82772

Closed

10 tasks

FRidh added the 6.topic: user experience label Mar 17, 2020

FRidh mentioned this pull request Mar 18, 2020

[RFC 0067] Common override interface derivations NixOS/rfcs#67

Closed

ryantm added 2.status: merge conflict and removed 2.status: merge conflict labels Oct 3, 2020

alyssais mentioned this pull request Apr 13, 2021

buildRustPackage: Provide overrideAttrs #119332

Closed

10 tasks

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Aug 4, 2021

wegank marked this pull request as draft March 20, 2024 14:59

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 20, 2024

wegank added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace overridePythonAttrs with overrideArgs, add for Rust and Go as well #46842

Replace overridePythonAttrs with overrideArgs, add for Rust and Go as well #46842

alyssais commented Sep 18, 2018 •

edited

matthewbauer commented Oct 16, 2018

alyssais commented Oct 17, 2018

alyssais commented Oct 21, 2018

FRidh commented Oct 22, 2018

alyssais commented Oct 22, 2018

alyssais commented Oct 23, 2018

FRidh commented Jan 4, 2019

alyssais commented Jan 6, 2019 via email

FRidh commented Jan 6, 2019

CMCDragonkai commented Apr 26, 2019

FRidh commented Mar 17, 2020

FRidh commented Mar 17, 2020

danbst commented Mar 17, 2020

FRidh commented Mar 18, 2020

stale bot commented Aug 4, 2021

nyabinary commented Dec 19, 2023

Replace overridePythonAttrs with overrideArgs, add for Rust and Go as well #46842

Are you sure you want to change the base?

Replace overridePythonAttrs with overrideArgs, add for Rust and Go as well #46842

Conversation

alyssais commented Sep 18, 2018 • edited

Motivation for this change

Things done

matthewbauer commented Oct 16, 2018

alyssais commented Oct 17, 2018

alyssais commented Oct 21, 2018

FRidh commented Oct 22, 2018

alyssais commented Oct 22, 2018

alyssais commented Oct 23, 2018

FRidh commented Jan 4, 2019

alyssais commented Jan 6, 2019 via email

FRidh commented Jan 6, 2019

CMCDragonkai commented Apr 26, 2019

FRidh commented Mar 17, 2020

FRidh commented Mar 17, 2020

danbst commented Mar 17, 2020

FRidh commented Mar 18, 2020

stale bot commented Aug 4, 2021

nyabinary commented Dec 19, 2023

alyssais commented Sep 18, 2018 •

edited