commit 118bdf25a6c572dd2fd29d10b1ae2e4d9a95b907 · pyrox.dev/nixpkgs

+29 -5

lib/modules.nix

···

       21
        
           isBool

     

       22
        
           isFunction

     

       23
        
           isList

     

       0
        
       
     

       24
        
           isString

     

       25
        
           length

     

       26
        
           mapAttrs

     
···

       44
        
           showFiles

     

       45
        
           showOption

     

       46
        
           unknownModule

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       47
        
           ;

     

       48
        
       

     

       49
        
         showDeclPrefix = loc: decl: prefix:

     
···

       403
        
                   key = module.key;

     

       404
        
                   module = module;

     

       405
        
                   modules = collectedImports.modules;

     

       406
       -
                   disabled = module.disabledModules ++ collectedImports.disabled;

     

       407
        
                 }) initialModules);

     

       408
        
       

     

       409
        
             # filterModules :: String -> { disabled, modules } -> [ Module ]

     
···

       412
        
             # modules recursively. It returns the final list of unique-by-key modules

     

       413
        
             filterModules = modulesPath: { disabled, modules }:

     

       414
        
               let

     

       415
       -
                 moduleKey = m: if isString m && (builtins.substring 0 1 m != "/")

     

       416
       -
                   then toString modulesPath + "/" + m

     

       417
       -
                   else toString m;

     

       418
       -
                 disabledKeys = map moduleKey disabled;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       419
        
                 keyFilter = filter (attrs: ! elem attrs.key disabledKeys);

     

       420
        
               in map (attrs: attrs.module) (builtins.genericClosure {

     

       421
        
                 startSet = keyFilter modules;

···

       21
        
           isBool

     

       22
        
           isFunction

     

       23
        
           isList

     

       24
       +
           isPath

     

       25
        
           isString

     

       26
        
           length

     

       27
        
           mapAttrs

     
···

       45
        
           showFiles

     

       46
        
           showOption

     

       47
        
           unknownModule

     

       48
       +
           ;

     

       49
       +
         inherit (lib.strings)

     

       50
       +
           isConvertibleWithToString

     

       51
        
           ;

     

       52
        
       

     

       53
        
         showDeclPrefix = loc: decl: prefix:

     
···

       407
        
                   key = module.key;

     

       408
        
                   module = module;

     

       409
        
                   modules = collectedImports.modules;

     

       410
       +
                   disabled = (if module.disabledModules != [] then [{ file = module._file; disabled = module.disabledModules; }] else []) ++ collectedImports.disabled;

     

       411
        
                 }) initialModules);

     

       412
        
       

     

       413
        
             # filterModules :: String -> { disabled, modules } -> [ Module ]

     
···

       416
        
             # modules recursively. It returns the final list of unique-by-key modules

     

       417
        
             filterModules = modulesPath: { disabled, modules }:

     

       418
        
               let

     

       419
       +
                 moduleKey = file: m:

     

       420
       +
                   if isString m

     

       421
       +
                   then

     

       422
       +
                     if builtins.substring 0 1 m == "/"

     

       423
       +
                     then m

     

       424
       +
                     else toString modulesPath + "/" + m

     

       425
       +
       

     

       426
       +
                   else if isConvertibleWithToString m

     

       427
       +
                   then

     

       428
       +
                     if m?key && m.key != toString m

     

       429
       +
                     then

     

       430
       +
                       throw "Module `${file}` contains a disabledModules item that is an attribute set that can be converted to a string (${toString m}) but also has a `.key` attribute (${m.key}) with a different value. This makes it ambiguous which module should be disabled."

     

       431
       +
                     else

     

       432
       +
                       toString m

     

       433
       +
       

     

       434
       +
                   else if m?key

     

       435
       +
                   then

     

       436
       +
                     m.key

     

       437
       +
       

     

       438
       +
                   else if isAttrs m

     

       439
       +
                   then throw "Module `${file}` contains a disabledModules item that is an attribute set, presumably a module, that does not have a `key` attribute. This means that the module system doesn't have any means to identify the module that should be disabled. Make sure that you've put the correct value in disabledModules: a string path relative to modulesPath, a path value, or an attribute set with a `key` attribute."

     

       440
       +
                   else throw "Each disabledModules item must be a path, string, or a attribute set with a key attribute, or a value supported by toString. However, one of the disabledModules items in `${toString file}` is none of that, but is of type ${builtins.typeOf m}.";

     

       441
       +
       

     

       442
       +
                 disabledKeys = concatMap ({ file, disabled }: map (moduleKey file) disabled) disabled;

     

       443
        
                 keyFilter = filter (attrs: ! elem attrs.key disabledKeys);

     

       444
        
               in map (attrs: attrs.module) (builtins.genericClosure {

     

       445
        
                 startSet = keyFilter modules;

+12

lib/tests/modules.sh

···

       141
        
       checkConfigError "attribute .*enable.* in selection path .*config.enable.* not found" "$@" ./disable-define-enable.nix ./disable-declare-enable.nix

     

       142
        
       checkConfigError "attribute .*enable.* in selection path .*config.enable.* not found" "$@" ./disable-enable-modules.nix

     

       143
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       144
        
       # Check _module.args.

     

       145
        
       set -- config.enable ./declare-enable.nix ./define-enable-with-custom-arg.nix

     

       146
        
       checkConfigError 'while evaluating the module argument .*custom.* in .*define-enable-with-custom-arg.nix.*:' "$@"

     
···

       357
        
       checkConfigOutput '^"The option `a\.b. defined in `.*/doRename-warnings\.nix. has been renamed to `c\.d\.e.\."$' \

     

       358
        
         config.result \

     

       359
        
         ./doRename-warnings.nix

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       360
        
       

     

       361
        
       cat <<EOF

     

       362
        
       ====== module tests ======

···

       141
        
       checkConfigError "attribute .*enable.* in selection path .*config.enable.* not found" "$@" ./disable-define-enable.nix ./disable-declare-enable.nix

     

       142
        
       checkConfigError "attribute .*enable.* in selection path .*config.enable.* not found" "$@" ./disable-enable-modules.nix

     

       143
        
       

     

       144
       +
       checkConfigOutput '^true$' 'config.positive.enable' ./disable-module-with-key.nix

     

       145
       +
       checkConfigOutput '^false$' 'config.negative.enable' ./disable-module-with-key.nix

     

       146
       +
       checkConfigError 'Module ..*disable-module-bad-key.nix. contains a disabledModules item that is an attribute set, presumably a module, that does not have a .key. attribute. .*' 'config.enable' ./disable-module-bad-key.nix

     

       147
       +
       

     

       148
       +
       # Not sure if we want to keep supporting module keys that aren't strings, paths or v?key, but we shouldn't remove support accidentally.

     

       149
       +
       checkConfigOutput '^true$' 'config.positive.enable' ./disable-module-with-toString-key.nix

     

       150
       +
       checkConfigOutput '^false$' 'config.negative.enable' ./disable-module-with-toString-key.nix

     

       151
       +
       

     

       152
        
       # Check _module.args.

     

       153
        
       set -- config.enable ./declare-enable.nix ./define-enable-with-custom-arg.nix

     

       154
        
       checkConfigError 'while evaluating the module argument .*custom.* in .*define-enable-with-custom-arg.nix.*:' "$@"

     
···

       365
        
       checkConfigOutput '^"The option `a\.b. defined in `.*/doRename-warnings\.nix. has been renamed to `c\.d\.e.\."$' \

     

       366
        
         config.result \

     

       367
        
         ./doRename-warnings.nix

     

       368
       +
       

     

       369
       +
       # Anonymous modules get deduplicated by key

     

       370
       +
       checkConfigOutput '^"pear"$' config.once.raw ./merge-module-with-key.nix

     

       371
       +
       checkConfigOutput '^"pear\\npear"$' config.twice.raw ./merge-module-with-key.nix

     

       372
        
       

     

       373
        
       cat <<EOF

     

       374
        
       ====== module tests ======

+16

lib/tests/modules/disable-module-bad-key.nix

···

       1
       +
       { lib, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) mkOption types;

     

       4
       +
       

     

       5
       +
         moduleWithKey = { config, ... }: {

     

       6
       +
           config = {

     

       7
       +
             enable = true;

     

       8
       +
           };

     

       9
       +
         };

     

       10
       +
       in

     

       11
       +
       {

     

       12
       +
         imports = [

     

       13
       +
           ./declare-enable.nix

     

       14
       +
         ];

     

       15
       +
         disabledModules = [ { } ];

     

       16
       +
       }

+34

lib/tests/modules/disable-module-with-key.nix

···

       1
       +
       { lib, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) mkOption types;

     

       4
       +
       

     

       5
       +
         moduleWithKey = {

     

       6
       +
           key = "disable-module-with-key.nix#moduleWithKey";

     

       7
       +
           config = {

     

       8
       +
             enable = true;

     

       9
       +
           };

     

       10
       +
         };

     

       11
       +
       in

     

       12
       +
       {

     

       13
       +
         options = {

     

       14
       +
           positive = mkOption {

     

       15
       +
             type = types.submodule {

     

       16
       +
               imports = [

     

       17
       +
                 ./declare-enable.nix

     

       18
       +
                 moduleWithKey

     

       19
       +
               ];

     

       20
       +
             };

     

       21
       +
             default = {};

     

       22
       +
           };

     

       23
       +
           negative = mkOption {

     

       24
       +
             type = types.submodule {

     

       25
       +
               imports = [

     

       26
       +
                 ./declare-enable.nix

     

       27
       +
                 moduleWithKey

     

       28
       +
               ];

     

       29
       +
               disabledModules = [ moduleWithKey ];

     

       30
       +
             };

     

       31
       +
             default = {};

     

       32
       +
           };

     

       33
       +
         };

     

       34
       +
       }

+34

lib/tests/modules/disable-module-with-toString-key.nix

···

       1
       +
       { lib, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) mkOption types;

     

       4
       +
       

     

       5
       +
         moduleWithKey = {

     

       6
       +
           key = 123;

     

       7
       +
           config = {

     

       8
       +
             enable = true;

     

       9
       +
           };

     

       10
       +
         };

     

       11
       +
       in

     

       12
       +
       {

     

       13
       +
         options = {

     

       14
       +
           positive = mkOption {

     

       15
       +
             type = types.submodule {

     

       16
       +
               imports = [

     

       17
       +
                 ./declare-enable.nix

     

       18
       +
                 moduleWithKey

     

       19
       +
               ];

     

       20
       +
             };

     

       21
       +
             default = {};

     

       22
       +
           };

     

       23
       +
           negative = mkOption {

     

       24
       +
             type = types.submodule {

     

       25
       +
               imports = [

     

       26
       +
                 ./declare-enable.nix

     

       27
       +
                 moduleWithKey

     

       28
       +
               ];

     

       29
       +
               disabledModules = [ 123 ];

     

       30
       +
             };

     

       31
       +
             default = {};

     

       32
       +
           };

     

       33
       +
         };

     

       34
       +
       }

+49

lib/tests/modules/merge-module-with-key.nix

···

       1
       +
       { lib, ... }:

     

       2
       +
       let

     

       3
       +
         inherit (lib) mkOption types;

     

       4
       +
       

     

       5
       +
         moduleWithoutKey = {

     

       6
       +
           config = {

     

       7
       +
             raw = "pear";

     

       8
       +
           };

     

       9
       +
         };

     

       10
       +
       

     

       11
       +
         moduleWithKey = {

     

       12
       +
           key = __curPos.file + "#moduleWithKey";

     

       13
       +
           config = {

     

       14
       +
             raw = "pear";

     

       15
       +
           };

     

       16
       +
         };

     

       17
       +
       

     

       18
       +
         decl = {

     

       19
       +
           options = {

     

       20
       +
             raw = mkOption {

     

       21
       +
               type = types.lines;

     

       22
       +
             };

     

       23
       +
           };

     

       24
       +
         };

     

       25
       +
       in

     

       26
       +
       {

     

       27
       +
         options = {

     

       28
       +
           once = mkOption {

     

       29
       +
             type = types.submodule {

     

       30
       +
               imports = [

     

       31
       +
                 decl

     

       32
       +
                 moduleWithKey

     

       33
       +
                 moduleWithKey

     

       34
       +
               ];

     

       35
       +
             };

     

       36
       +
             default = {};

     

       37
       +
           };

     

       38
       +
           twice = mkOption {

     

       39
       +
             type = types.submodule {

     

       40
       +
               imports = [

     

       41
       +
                 decl

     

       42
       +
                 moduleWithoutKey

     

       43
       +
                 moduleWithoutKey

     

       44
       +
               ];

     

       45
       +
             };

     

       46
       +
             default = {};

     

       47
       +
           };

     

       48
       +
         };

     

       49
       +
       }

+9 -2

nixos/doc/manual/development/replace-modules.section.md

···

       8
        
       

     

       9
        
       `disabledModules` is a top level attribute like `imports`, `options` and

     

       10
        
       `config`. It contains a list of modules that will be disabled. This can

     

       11
       -
       either be the full path to the module or a string with the filename

     

       12
       -
       relative to the modules path (eg. \<nixpkgs/nixos/modules> for nixos).

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       13
        
       

     

       14
        
       This example will replace the existing postgresql module with the

     

       15
        
       version defined in the nixos-unstable channel while keeping the rest of

···

       8
        
       

     

       9
        
       `disabledModules` is a top level attribute like `imports`, `options` and

     

       10
        
       `config`. It contains a list of modules that will be disabled. This can

     

       11
       +
       either be:

     

       12
       +
        - the full path to the module,

     

       13
       +
        - or a string with the filename relative to the modules path (eg. \<nixpkgs/nixos/modules> for nixos),

     

       14
       +
        - or an attribute set containing a specific `key` attribute.

     

       15
       +
       

     

       16
       +
       The latter allows some modules to be disabled, despite them being distributed

     

       17
       +
       via attributes instead of file paths. The `key` should be globally unique, so

     

       18
       +
       it is recommended to include a file path in it, or rely on a framework to do it

     

       19
       +
       for you.

     

       20
        
       

     

       21
        
       This example will replace the existing postgresql module with the

     

       22
        
       version defined in the nixos-unstable channel while keeping the rest of