Skip to content

customization.scopeImportWith: init #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

customization.scopeImportWith: init #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions customisation.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,22 @@ rec {
callPackageWith :: AttrSet -> ((AttrSet -> a) | Path) -> AttrSet -> a
```
*/
callPackageWith = autoArgs: fn: args:
callPackageWith = callGenericWith "lib.customisation.callPackageWith" makeOverridable;


/**
Very similar to callPackageWith, with the exception that it doesn't wrap the
package function in makeOverridable which adds `.override` and `.overrideDerivation`.
This is intended to be use when the calling function doesn't return a derivation.
*/
scopeImportWith = callGenericWith "lib.customisation.scopeImportWith" lib.id;


/**
Not intended to be used directly. Instead use callPackageWith or scopeImportWith
dependening on whether you're importing packages or non-package expressions.
*/
callGenericWith = funcName: continuation: autoArgs: fn: args:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should go in a let clause, to avoid it being available in the customization attr set. However, for the sake of the diff, just keep it here

let
f = if isFunction fn then fn else import fn;
fargs = functionArgs f;
Expand Down Expand Up @@ -261,12 +276,12 @@ rec {
error = errorForArg (head (attrNames missingArgs));

in if missingArgs == {}
then makeOverridable f allArgs
then continuation f allArgs
# This needs to be an abort so it can't be caught with `builtins.tryEval`,
# which is used by nix-env and ofborg to filter out packages that don't evaluate.
# This way we're forced to fix such errors in Nixpkgs,
# which is especially relevant with allowAliases = false
else abort "lib.customisation.callPackageWith: ${error}";
else abort "${funcName}: ${error}";


/**
Expand Down Expand Up @@ -443,6 +458,7 @@ rec {
```
scope :: {
callPackage :: ((AttrSet -> a) | Path) -> AttrSet -> a
scopeImport :: ((AttrSet -> a) | Path) -> AttrSet -> a
newScope = AttrSet -> scope
overrideScope = (scope -> scope -> AttrSet) -> scope
packages :: AttrSet -> AttrSet
Expand Down Expand Up @@ -541,6 +557,7 @@ rec {
makeScope = newScope: f:
let self = f self // {
newScope = scope: newScope (self // scope);
scopeImport = scopeImportWith self;
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

autoCall I think would be less confusing in the long run

callPackage = self.newScope {};
overrideScope = g: makeScope newScope (extends g f);
# Remove after 24.11 is released.
Expand Down Expand Up @@ -649,6 +666,7 @@ rec {
spliced = extra spliced0 // spliced0 // keep self;
self = f self // {
newScope = scope: newScope (spliced // scope);
scopeImport = scopeImportWith spliced;
callPackage = newScope spliced; # == self.newScope {};
# N.B. the other stages of the package set spliced in are *not*
# overridden.
Expand Down