commit 5186921dedc57d054db8ae6ebfd9fa3385197c45 · pyrox.dev/nixpkgs

+10

doc/module-system/module-system.chapter.md

···

       116
       116
        
       

     

       117
       117
        
       The [`class` argument](#module-system-lib-evalModules-param-class).

     

       118
       118
        
       

     

       119
       119
       +
       #### `graph` {#module-system-lib-evalModules-return-value-graph}

     

       120
       120
       +
       

     

       121
       121
       +
       Represents all the modules that took part in the evaluation.

     

       122
       122
       +
       It is a list of `ModuleGraph` where `ModuleGraph` is defined as an attribute set with the following attributes:

     

       123
       123
       +
       

     

       124
       124
       +
       - `key`: `string` for the purpose of module deduplication and `disabledModules`

     

       125
       125
       +
       - `file`: `string` for the purpose of error messages and warnings

     

       126
       126
       +
       - `imports`: `[ ModuleGraph ]`

     

       127
       127
       +
       - `disabled`: `bool`

     

       128
       128
       +
       

     

       119
       129
        
       ## Module arguments {#module-system-module-arguments}

     

       120
       130
        
       

     

       121
       131
        
       Module arguments are the attribute values passed to modules when they are evaluated.

+3

doc/redirects.json

···

       487
       487
        
         "module-system-lib-evalModules-return-value-_configurationClass": [

     

       488
       488
        
           "index.html#module-system-lib-evalModules-return-value-_configurationClass"

     

       489
       489
        
         ],

     

       490
       490
       +
         "module-system-lib-evalModules-return-value-graph": [

     

       491
       491
       +
           "index.html#module-system-lib-evalModules-return-value-graph"

     

       492
       492
       +
         ],

     

       490
       493
        
         "part-stdenv": [

     

       491
       494
        
           "index.html#part-stdenv"

     

       492
       495
        
         ],

+40 -22

lib/modules.nix

···

       245
       245
        
               };

     

       246
       246
        
             };

     

       247
       247
        
       

     

       248
       248
       -
             merged =

     

       249
       249
       -
               let

     

       250
       250
       -
                 collected =

     

       251
       251
       -
                   collectModules class (specialArgs.modulesPath or "") (regularModules ++ [ internalModule ])

     

       252
       252
       -
                     (

     

       253
       253
       -
                       {

     

       254
       254
       -
                         inherit

     

       255
       255
       -
                           lib

     

       256
       256
       -
                           options

     

       257
       257
       -
                           specialArgs

     

       258
       258
       -
                           ;

     

       259
       259
       -
                         _class = class;

     

       260
       260
       -
                         _prefix = prefix;

     

       261
       261
       -
                         config = addErrorContext "if you get an infinite recursion here, you probably reference `config` in `imports`. If you are trying to achieve a conditional import behavior dependent on `config`, consider importing unconditionally, and using `mkEnableOption` and `mkIf` to control its effect." config;

     

       262
       262
       -
                       }

     

       263
       263
       -
                       // specialArgs

     

       264
       264
       -
                     );

     

       265
       265
       -
               in

     

       266
       266
       -
               mergeModules prefix (reverseList collected);

     

       248
       248
       +
             # This function takes an empty attrset as an argument.

     

       249
       249
       +
             # It could theoretically be replaced with its body,

     

       250
       250
       +
             # but such a binding is avoided to allow for earlier grabage collection.

     

       251
       251
       +
             doCollect =

     

       252
       252
       +
               { }:

     

       253
       253
       +
               collectModules class (specialArgs.modulesPath or "") (regularModules ++ [ internalModule ]) (

     

       254
       254
       +
                 {

     

       255
       255
       +
                   inherit

     

       256
       256
       +
                     lib

     

       257
       257
       +
                     options

     

       258
       258
       +
                     specialArgs

     

       259
       259
       +
                     ;

     

       260
       260
       +
                   _class = class;

     

       261
       261
       +
                   _prefix = prefix;

     

       262
       262
       +
                   config = addErrorContext "if you get an infinite recursion here, you probably reference `config` in `imports`. If you are trying to achieve a conditional import behavior dependent on `config`, consider importing unconditionally, and using `mkEnableOption` and `mkIf` to control its effect." config;

     

       263
       263
       +
                 }

     

       264
       264
       +
                 // specialArgs

     

       265
       265
       +
               );

     

       266
       266
       +
       

     

       267
       267
       +
             merged = mergeModules prefix (reverseList (doCollect { }).modules);

     

       267
       268
        
       

     

       268
       269
        
             options = merged.matchedOptions;

     

       269
       270
        
       

     
···

       359
       360
        
               options = checked options;

     

       360
       361
        
               config = checked (removeAttrs config [ "_module" ]);

     

       361
       362
        
               _module = checked (config._module);

     

       363
       363
       +
               inherit (doCollect { }) graph;

     

       362
       364
        
               inherit extendModules type class;

     

       363
       365
        
             };

     

       364
       366
        
           in

     

       365
       367
        
           result;

     

       366
       368
        
       

     

       367
       367
       -
         # collectModules :: (class: String) -> (modulesPath: String) -> (modules: [ Module ]) -> (args: Attrs) -> [ Module ]

     

       369
       369
       +
         # collectModules :: (class: String) -> (modulesPath: String) -> (modules: [ Module ]) -> (args: Attrs) -> ModulesTree

     

       368
       370
        
         #

     

       369
       371
        
         # Collects all modules recursively through `import` statements, filtering out

     

       370
       372
        
         # all modules in disabledModules.

     
···

       529
       531
        
                 operator = attrs: keyFilter attrs.modules;

     

       530
       532
        
               });

     

       531
       533
        
       

     

       534
       534
       +
             toGraph =

     

       535
       535
       +
               modulesPath:

     

       536
       536
       +
               { disabled, modules }:

     

       537
       537
       +
               let

     

       538
       538
       +
                 isDisabledModule = isDisabled modulesPath disabled;

     

       539
       539
       +
       

     

       540
       540
       +
                 toModuleGraph = structuredModule: {

     

       541
       541
       +
                   disabled = isDisabledModule structuredModule;

     

       542
       542
       +
                   inherit (structuredModule) key;

     

       543
       543
       +
                   file = structuredModule.module._file;

     

       544
       544
       +
                   imports = map toModuleGraph structuredModule.modules;

     

       545
       545
       +
                 };

     

       546
       546
       +
               in

     

       547
       547
       +
               map toModuleGraph (filter (x: x.key != "lib/modules.nix") modules);

     

       532
       548
        
           in

     

       533
       533
       -
           modulesPath: initialModules: args:

     

       534
       534
       -
           filterModules modulesPath (collectStructuredModules unknownModule "" initialModules args);

     

       549
       549
       +
           modulesPath: initialModules: args: {

     

       550
       550
       +
             modules = filterModules modulesPath (collectStructuredModules unknownModule "" initialModules args);

     

       551
       551
       +
             graph = toGraph modulesPath (collectStructuredModules unknownModule "" initialModules args);

     

       552
       552
       +
           };

     

       535
       553
        
       

     

       536
       554
        
         /**

     

       537
       555
        
           Wrap a module with a default location for reporting errors.

+22 -1

lib/tests/modules.sh

···

       20
       20
        
       pass=0

     

       21
       21
        
       fail=0

     

       22
       22
        
       

     

       23
       23
       +
       local-nix-instantiate() {

     

       24
       24
       +
           nix-instantiate --timeout 1 --eval-only --show-trace --read-write-mode --json "$@"

     

       25
       25
       +
       }

     

       26
       26
       +
       

     

       23
       27
        
       # loc

     

       24
       28
        
       #   prints the location of the call of to the function that calls it

     

       25
       29
        
       # loc n

     
···

       55
       59
        
           local attr=$1

     

       56
       60
        
           shift

     

       57
       61
        
           local script="import ./default.nix { modules = [ $* ];}"

     

       58
       58
       -
           nix-instantiate --timeout 1 -E "$script" -A "$attr" --eval-only --show-trace --read-write-mode --json

     

       62
       62
       +
           local-nix-instantiate -E "$script" -A "$attr"

     

       59
       63
        
       }

     

       60
       64
        
       

     

       61
       65
        
       reportFailure() {

     
···

       104
       108
        
               fi

     

       105
       109
        
               return 1

     

       106
       110
        
             }

     

       111
       111
       +
       }

     

       112
       112
       +
       

     

       113
       113
       +
       checkExpression() {

     

       114
       114
       +
         local path=$1

     

       115
       115
       +
         local output

     

       116
       116
       +
         {

     

       117
       117
       +
             output="$(local-nix-instantiate --strict "$path" 2>&1)" && ((++pass))

     

       118
       118
       +
         } || {

     

       119
       119
       +
             logStartFailure

     

       120
       120
       +
             echo "$output"

     

       121
       121
       +
             ((++fail))

     

       122
       122
       +
             logFailure

     

       123
       123
       +
             logEndFailure

     

       124
       124
       +
         }

     

       107
       125
        
       }

     

       108
       126
        
       

     

       109
       127
        
       checkConfigError() {

     
···

       336
       354
        
       checkConfigOutput '^12$' config.value ./declare-coerced-value-unsound.nix

     

       337
       355
        
       checkConfigError 'A definition for option .* is not of type .*. Definition values:\n\s*- In .*: "1000"' config.value ./declare-coerced-value-unsound.nix ./define-value-string-bigint.nix

     

       338
       356
        
       checkConfigError 'toInt: Could not convert .* to int' config.value ./declare-coerced-value-unsound.nix ./define-value-string-arbitrary.nix

     

       357
       357
       +
       

     

       358
       358
       +
       # Check `graph` attribute

     

       359
       359
       +
       checkExpression './graph/test.nix'

     

       339
       360
        
       

     

       340
       361
        
       # Check mkAliasOptionModule.

     

       341
       362
        
       checkConfigOutput '^true$' config.enable ./alias-with-priority.nix

+8

lib/tests/modules/graph/a.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         imports = [

     

       3
       3
       +
           {

     

       4
       4
       +
             imports = [ { } ];

     

       5
       5
       +
           }

     

       6
       6
       +
         ];

     

       7
       7
       +
         disabledModules = [ ./b.nix ];

     

       8
       8
       +
       }

+3

lib/tests/modules/graph/b.nix

···

       1
       1
       +
       args: {

     

       2
       2
       +
         imports = [ { key = "explicit-key"; } ];

     

       3
       3
       +
       }

+64

lib/tests/modules/graph/test.nix

···

       1
       1
       +
       let

     

       2
       2
       +
         lib = import ../../..;

     

       3
       3
       +
       

     

       4
       4
       +
         evaluation = lib.evalModules {

     

       5
       5
       +
           modules = [

     

       6
       6
       +
             { }

     

       7
       7
       +
             (args: { })

     

       8
       8
       +
             ./a.nix

     

       9
       9
       +
             ./b.nix

     

       10
       10
       +
           ];

     

       11
       11
       +
         };

     

       12
       12
       +
       

     

       13
       13
       +
         actual = evaluation.graph;

     

       14
       14
       +
       

     

       15
       15
       +
         expected = [

     

       16
       16
       +
           {

     

       17
       17
       +
             key = ":anon-1";

     

       18
       18
       +
             file = "<unknown-file>";

     

       19
       19
       +
             imports = [ ];

     

       20
       20
       +
             disabled = false;

     

       21
       21
       +
           }

     

       22
       22
       +
           {

     

       23
       23
       +
             key = ":anon-2";

     

       24
       24
       +
             file = "<unknown-file>";

     

       25
       25
       +
             imports = [ ];

     

       26
       26
       +
             disabled = false;

     

       27
       27
       +
           }

     

       28
       28
       +
           {

     

       29
       29
       +
             key = toString ./a.nix;

     

       30
       30
       +
             file = toString ./a.nix;

     

       31
       31
       +
             imports = [

     

       32
       32
       +
               {

     

       33
       33
       +
                 key = "${toString ./a.nix}:anon-1";

     

       34
       34
       +
                 file = toString ./a.nix;

     

       35
       35
       +
                 imports = [

     

       36
       36
       +
                   {

     

       37
       37
       +
                     key = "${toString ./a.nix}:anon-1:anon-1";

     

       38
       38
       +
                     file = toString ./a.nix;

     

       39
       39
       +
                     imports = [ ];

     

       40
       40
       +
                     disabled = false;

     

       41
       41
       +
                   }

     

       42
       42
       +
                 ];

     

       43
       43
       +
                 disabled = false;

     

       44
       44
       +
               }

     

       45
       45
       +
             ];

     

       46
       46
       +
             disabled = false;

     

       47
       47
       +
           }

     

       48
       48
       +
           {

     

       49
       49
       +
             key = toString ./b.nix;

     

       50
       50
       +
             file = toString ./b.nix;

     

       51
       51
       +
             imports = [

     

       52
       52
       +
               {

     

       53
       53
       +
                 key = "explicit-key";

     

       54
       54
       +
                 file = toString ./b.nix;

     

       55
       55
       +
                 imports = [ ];

     

       56
       56
       +
                 disabled = false;

     

       57
       57
       +
               }

     

       58
       58
       +
             ];

     

       59
       59
       +
             disabled = true;

     

       60
       60
       +
           }

     

       61
       61
       +
         ];

     

       62
       62
       +
       in

     

       63
       63
       +
       assert actual == expected;

     

       64
       64
       +
       null