diff options
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/.version | 1 | ||||
| -rw-r--r-- | lib/attrsets.nix | 77 | ||||
| -rw-r--r-- | lib/customisation.nix | 3 | ||||
| -rw-r--r-- | lib/derivations.nix | 64 | ||||
| -rw-r--r-- | lib/tests/misc.nix | 36 | ||||
| -rw-r--r-- | lib/tests/test-with-nix.nix | 6 | ||||
| -rw-r--r-- | lib/trivial.nix | 2 |
7 files changed, 149 insertions, 40 deletions
diff --git a/lib/.version b/lib/.version new file mode 100644 index 000000000000..420f61e8c7f6 --- /dev/null +++ b/lib/.version @@ -0,0 +1 @@ +24.05 \ No newline at end of file diff --git a/lib/attrsets.nix b/lib/attrsets.nix index f470c9a9278d..4adf1d30dc85 100644 --- a/lib/attrsets.nix +++ b/lib/attrsets.nix @@ -680,52 +680,67 @@ rec { attrsToList = mapAttrsToList nameValuePair; - /* Like `mapAttrs`, except that it recursively applies itself to - the *leaf* attributes of a potentially-nested attribute set: - the second argument of the function will never be an attrset. - Also, the first argument of the argument function is a *list* - of the attribute names that form the path to the leaf attribute. + /** + Like `mapAttrs`, except that it recursively applies itself to the *leaf* attributes of a potentially-nested attribute set: + the second argument of the function will never be an attrset. + Also, the first argument of the mapping function is a *list* of the attribute names that form the path to the leaf attribute. - For a function that gives you control over what counts as a leaf, - see `mapAttrsRecursiveCond`. + For a function that gives you control over what counts as a leaf, see `mapAttrsRecursiveCond`. - Example: - mapAttrsRecursive (path: value: concatStringsSep "-" (path ++ [value])) - { n = { a = "A"; m = { b = "B"; c = "C"; }; }; d = "D"; } - => { n = { a = "n-a-A"; m = { b = "n-m-b-B"; c = "n-m-c-C"; }; }; d = "d-D"; } + :::{#map-attrs-recursive-example .example} + # Map over leaf attributes - Type: - mapAttrsRecursive :: ([String] -> a -> b) -> AttrSet -> AttrSet + ```nix + mapAttrsRecursive (path: value: concatStringsSep "-" (path ++ [value])) + { n = { a = "A"; m = { b = "B"; c = "C"; }; }; d = "D"; } + ``` + evaluates to + ```nix + { n = { a = "n-a-A"; m = { b = "n-m-b-B"; c = "n-m-c-C"; }; }; d = "d-D"; } + ``` + ::: + + # Type + ``` + mapAttrsRecursive :: ([String] -> a -> b) -> AttrSet -> AttrSet + ``` */ mapAttrsRecursive = - # A function, given a list of attribute names and a value, returns a new value. + # A function that, given an attribute path as a list of strings and the corresponding attribute value, returns a new value. f: - # Set to recursively map over. + # Attribute set to recursively map over. set: mapAttrsRecursiveCond (as: true) f set; - /* Like `mapAttrsRecursive`, but it takes an additional predicate - function that tells it whether to recurse into an attribute - set. If it returns false, `mapAttrsRecursiveCond` does not - recurse, but does apply the map function. If it returns true, it - does recurse, and does not apply the map function. + /** + Like `mapAttrsRecursive`, but it takes an additional predicate that tells it whether to recurse into an attribute set. + If the predicate returns false, `mapAttrsRecursiveCond` does not recurse, but instead applies the mapping function. + If the predicate returns true, it does recurse, and does not apply the mapping function. - Example: - # To prevent recursing into derivations (which are attribute - # sets with the attribute "type" equal to "derivation"): - mapAttrsRecursiveCond - (as: !(as ? "type" && as.type == "derivation")) - (x: ... do something ...) - attrs + :::{#map-attrs-recursive-cond-example .example} + # Map over an leaf attributes defined by a condition - Type: - mapAttrsRecursiveCond :: (AttrSet -> Bool) -> ([String] -> a -> b) -> AttrSet -> AttrSet + Map derivations to their `name` attribute. + Derivatons are identified as attribute sets that contain `{ type = "derivation"; }`. + ```nix + mapAttrsRecursiveCond + (as: !(as ? "type" && as.type == "derivation")) + (x: x.name) + attrs + ``` + ::: + + # Type + ``` + mapAttrsRecursiveCond :: (AttrSet -> Bool) -> ([String] -> a -> b) -> AttrSet -> AttrSet + ``` */ mapAttrsRecursiveCond = - # A function, given the attribute set the recursion is currently at, determine if to recurse deeper into that attribute set. + # A function that, given the attribute set the recursion is currently at, determines if to recurse deeper into that attribute set. cond: - # A function, given a list of attribute names and a value, returns a new value. + # A function that, given an attribute path as a list of strings and the corresponding attribute value, returns a new value. + # The attribute value is either an attribute set for which `cond` returns false, or something other than an attribute set. f: # Attribute set to recursively map over. set: diff --git a/lib/customisation.nix b/lib/customisation.nix index 0b5cad71fddf..7be412bac353 100644 --- a/lib/customisation.nix +++ b/lib/customisation.nix @@ -221,9 +221,10 @@ rec { let f = if isFunction fn then fn else import fn; auto = intersectAttrs (functionArgs f) autoArgs; + mirrorArgs = mirrorFunctionArgs f; origArgs = auto // args; pkgs = f origArgs; - mkAttrOverridable = name: _: makeOverridable (newArgs: (f newArgs).${name}) origArgs; + mkAttrOverridable = name: _: makeOverridable (mirrorArgs (newArgs: (f newArgs).${name})) origArgs; in if isDerivation pkgs then throw ("function `callPackages` was called on a *single* derivation " diff --git a/lib/derivations.nix b/lib/derivations.nix index 44b727ee31cc..6867458f9e87 100644 --- a/lib/derivations.nix +++ b/lib/derivations.nix @@ -1,7 +1,20 @@ { lib }: let - inherit (lib) throwIfNot; + inherit (lib) + genAttrs + isString + throwIfNot + ; + + showMaybeAttrPosPre = prefix: attrName: v: + let pos = builtins.unsafeGetAttrPos attrName v; + in if pos == null then "" else "${prefix}${pos.file}:${toString pos.line}:${toString pos.column}"; + + showMaybePackagePosPre = prefix: pkg: + if pkg?meta.position && isString pkg.meta.position + then "${prefix}${pkg.meta.position}" + else ""; in { /* @@ -64,6 +77,11 @@ in # # This can be used for adding package attributes, such as `tests`. passthru ? { } + , # Optional list of assumed outputs. Default: ["out"] + # + # This must match the set of outputs that the returned derivation has. + # You must use this when the derivation has multiple outputs. + outputs ? [ "out" ] }: let # These checks are strict in `drv` and some `drv` attributes, but the @@ -71,11 +89,40 @@ in # Instead, the individual derivation attributes do depend on it. checked = throwIfNot (derivation.type or null == "derivation") - "lazySimpleDerivation: input must be a derivation." + "lazyDerivation: input must be a derivation." throwIfNot - (derivation.outputs == [ "out" ]) - # Supporting multiple outputs should be a matter of inheriting more attrs. - "The derivation ${derivation.name or "<unknown>"} has multiple outputs. This is not supported by lazySimpleDerivation yet. Support could be added, and be useful as long as the set of outputs is known in advance, without evaluating the actual derivation." + # NOTE: Technically we could require our outputs to be a subset of the + # actual ones, or even leave them unchecked and fail on a lazy basis. + # However, consider the case where an output is added in the underlying + # derivation, such as dev. lazyDerivation would remove it and cause it + # to fail as a buildInputs item, without any indication as to what + # happened. Hence the more stringent condition. We could consider + # adding a flag to control this behavior if there's a valid case for it, + # but the documentation must have a note like this. + (derivation.outputs == outputs) + '' + lib.lazyDerivation: The derivation ${derivation.name or "<unknown>"} has outputs that don't match the assumed outputs. + + Assumed outputs passed to lazyDerivation${showMaybeAttrPosPre ",\n at " "outputs" args}: + ${lib.generators.toPretty { multiline = false; } outputs}; + + Actual outputs of the derivation${showMaybePackagePosPre ",\n defined at " derivation}: + ${lib.generators.toPretty { multiline = false; } derivation.outputs} + + If the outputs are known ahead of evaluating the derivation, + then update the lazyDerivation call to match the actual outputs, in the same order. + If lazyDerivation is passed a literal value, just change it to the actual outputs. + As a result it will work as before / as intended. + + Otherwise, when the outputs are dynamic and can't be known ahead of time, it won't + be possible to add laziness, but lib.lazyDerivation may still be useful for trimming + the attributes. + If you want to keep trimming the attributes, make sure that the package is in a + variable (don't evaluate it twice!) and pass the variable and its outputs attribute + to lib.lazyDerivation. This largely defeats laziness, but keeps the trimming. + If none of the above works for you, replace the lib.lazyDerivation call by the + expression in the derivation argument. + '' derivation; in { @@ -92,12 +139,15 @@ in # A fixed set of derivation values, so that `lazyDerivation` can return # its attrset before evaluating `derivation`. # This must only list attributes that are available on _all_ derivations. - inherit (checked) outputs out outPath outputName drvPath name system; + inherit (checked) outPath outputName drvPath name system; + inherit outputs; # The meta attribute can either be taken from the derivation, or if the # `lazyDerivation` caller knew a shortcut, be taken from there. meta = args.meta or checked.meta; - } // passthru; + } + // genAttrs outputs (outputName: checked.${outputName}) + // passthru; /* Conditionally set a derivation attribute. diff --git a/lib/tests/misc.nix b/lib/tests/misc.nix index 193e68a96933..98d1f4e71c48 100644 --- a/lib/tests/misc.nix +++ b/lib/tests/misc.nix @@ -55,6 +55,24 @@ runTests { expected = { a = false; b = false; c = true; }; }; + testCallPackageWithOverridePreservesArguments = + let + f = { a ? 0, b }: {}; + f' = callPackageWith { a = 1; b = 2; } f {}; + in { + expr = functionArgs f'.override; + expected = functionArgs f; + }; + + testCallPackagesWithOverridePreservesArguments = + let + f = { a ? 0, b }: { nested = {}; }; + f' = callPackagesWith { a = 1; b = 2; } f {}; + in { + expr = functionArgs f'.nested.override; + expected = functionArgs f; + }; + # TRIVIAL testId = { @@ -1973,6 +1991,24 @@ runTests { }).drvPath; }; + testLazyDerivationMultiOutputReturnsDerivationAttrs = let + derivation = { + type = "derivation"; + outputs = ["out" "dev"]; + dev = "test dev"; + out = "test out"; + outPath = "test outPath"; + outputName = "out"; + drvPath = "test drvPath"; + name = "test name"; + system = "test system"; + meta.position = "/hi:23"; + }; + in { + expr = lazyDerivation { inherit derivation; outputs = ["out" "dev"]; passthru.meta.position = "/hi:23"; }; + expected = derivation; + }; + testTypeDescriptionInt = { expr = (with types; int).description; expected = "signed integer"; diff --git a/lib/tests/test-with-nix.nix b/lib/tests/test-with-nix.nix index fd2e7532e697..9d66b91cab42 100644 --- a/lib/tests/test-with-nix.nix +++ b/lib/tests/test-with-nix.nix @@ -53,6 +53,12 @@ pkgs.runCommand "nixpkgs-lib-tests-nix-${nix.version}" { echo "Running lib/tests/modules.sh" bash lib/tests/modules.sh + echo "Checking lib.version" + nix-instantiate lib -A version --eval || { + echo "lib.version does not evaluate when lib is isolated from the rest of the nixpkgs tree" + exit 1 + } + echo "Running lib/tests/filesystem.sh" TEST_LIB=$PWD/lib bash lib/tests/filesystem.sh diff --git a/lib/trivial.nix b/lib/trivial.nix index fa499cbbf028..c197822a4f8e 100644 --- a/lib/trivial.nix +++ b/lib/trivial.nix @@ -159,7 +159,7 @@ in { version = release + versionSuffix; /* Returns the current nixpkgs release number as string. */ - release = lib.strings.fileContents ../.version; + release = lib.strings.fileContents ./.version; /* The latest release that is supported, at the time of release branch-off, if applicable. |