commit ca81a89839176c2e0d0b0fb01a931a4a65404fa6 · pyrox.dev/nixpkgs

+11

lib/tests/modules.sh

···

       103
       103
        
       checkConfigError '.*This can happen if you e.g. declared your options in .types.submodule.' config.sub ./error-mkOption-in-submodule-config.nix

     

       104
       104
        
       checkConfigError '.*A definition for option .bad. is not of type .non-empty .list of .submodule...\.' config.bad ./error-nonEmptyListOf-submodule.nix

     

       105
       105
        
       

     

       106
       106
       +
       # types.attrTag

     

       107
       107
       +
       checkConfigOutput '^true$' config.okChecks ./types-attrTag.nix

     

       108
       108
       +
       checkConfigError 'A definition for option .intStrings\.syntaxError. is not of type .attribute-tagged union of left, right' config.intStrings.syntaxError ./types-attrTag.nix

     

       109
       109
       +
       checkConfigError 'A definition for option .intStrings\.syntaxError2. is not of type .attribute-tagged union of left, right' config.intStrings.syntaxError2 ./types-attrTag.nix

     

       110
       110
       +
       checkConfigError 'A definition for option .intStrings\.syntaxError3. is not of type .attribute-tagged union of left, right' config.intStrings.syntaxError3 ./types-attrTag.nix

     

       111
       111
       +
       checkConfigError 'A definition for option .intStrings\.syntaxError4. is not of type .attribute-tagged union of left, right' config.intStrings.syntaxError4 ./types-attrTag.nix

     

       112
       112
       +
       checkConfigError 'A definition for option .intStrings\.mergeError. is not of type .attribute-tagged union of left, right' config.intStrings.mergeError ./types-attrTag.nix

     

       113
       113
       +
       checkConfigError 'A definition for option .intStrings\.badTagError. is not of type .attribute-tagged union of left, right' config.intStrings.badTagError ./types-attrTag.nix

     

       114
       114
       +
       checkConfigError 'A definition for option .intStrings\.badTagTypeError\.left. is not of type .signed integer.' config.intStrings.badTagTypeError.left ./types-attrTag.nix

     

       115
       115
       +
       checkConfigError 'A definition for option .nested\.right\.left. is not of type .signed integer.' config.nested.right.left ./types-attrTag.nix

     

       116
       116
       +
       

     

       106
       117
        
       # types.pathInStore

     

       107
       118
        
       checkConfigOutput '".*/store/0lz9p8xhf89kb1c1kk6jxrzskaiygnlh-bash-5.2-p15.drv"' config.pathInStore.ok1 ./types.nix

     

       108
       119
        
       checkConfigOutput '".*/store/0fb3ykw9r5hpayd05sr0cizwadzq1d8q-bash-5.2-p15"' config.pathInStore.ok2 ./types.nix

+64

lib/tests/modules/types-attrTag.nix

···

       1
       1
       +
       { lib, config, ... }:

     

       2
       2
       +
       let

     

       3
       3
       +
         inherit (lib) mkOption types;

     

       4
       4
       +
         forceDeep = x: builtins.deepSeq x x;

     

       5
       5
       +
       in

     

       6
       6
       +
       {

     

       7
       7
       +
         options = {

     

       8
       8
       +
           intStrings = mkOption {

     

       9
       9
       +
             type = types.attrsOf

     

       10
       10
       +
               (types.attrTag {

     

       11
       11
       +
                 left = types.int;

     

       12
       12
       +
                 right = types.str;

     

       13
       13
       +
               });

     

       14
       14
       +
           };

     

       15
       15
       +
           nested = mkOption {

     

       16
       16
       +
             type = types.attrTag {

     

       17
       17
       +
               left = types.int;

     

       18
       18
       +
               right = types.attrTag {

     

       19
       19
       +
                 left = types.int;

     

       20
       20
       +
                 right = types.str;

     

       21
       21
       +
               };

     

       22
       22
       +
             };

     

       23
       23
       +
           };

     

       24
       24
       +
           merged = mkOption {

     

       25
       25
       +
             type = types.attrsOf (

     

       26
       26
       +
               types.attrTag {

     

       27
       27
       +
                 yay = types.int;

     

       28
       28
       +
               }

     

       29
       29
       +
             );

     

       30
       30
       +
           };

     

       31
       31
       +
           okChecks = mkOption {};

     

       32
       32
       +
         };

     

       33
       33
       +
         imports = [

     

       34
       34
       +
           {

     

       35
       35
       +
             options.merged = mkOption {

     

       36
       36
       +
               type = types.attrsOf (

     

       37
       37
       +
                 types.attrTag {

     

       38
       38
       +
                   nay = types.bool;

     

       39
       39
       +
                 }

     

       40
       40
       +
               );

     

       41
       41
       +
             };

     

       42
       42
       +
           }

     

       43
       43
       +
         ];

     

       44
       44
       +
         config = {

     

       45
       45
       +
           intStrings.syntaxError = 1;

     

       46
       46
       +
           intStrings.syntaxError2 = {};

     

       47
       47
       +
           intStrings.syntaxError3 = { a = true; b = true; };

     

       48
       48
       +
           intStrings.syntaxError4 = lib.mkMerge [ { a = true; } { b = true; } ];

     

       49
       49
       +
           intStrings.mergeError = lib.mkMerge [ { int = throw "do not eval"; } { string = throw "do not eval"; } ];

     

       50
       50
       +
           intStrings.badTagError.rite = throw "do not eval";

     

       51
       51
       +
           intStrings.badTagTypeError.left = "bad";

     

       52
       52
       +
           intStrings.numberOne.left = 1;

     

       53
       53
       +
           intStrings.hello.right = "hello world";

     

       54
       54
       +
           nested.right.left = "not a number";

     

       55
       55
       +
           merged.negative.nay = false;

     

       56
       56
       +
           merged.positive.yay = 100;

     

       57
       57
       +
           okChecks =

     

       58
       58
       +
             assert config.intStrings.hello.right == "hello world";

     

       59
       59
       +
             assert config.intStrings.numberOne.left == 1;

     

       60
       60
       +
             assert config.merged.negative.nay == false;

     

       61
       61
       +
             assert config.merged.positive.yay == 100;

     

       62
       62
       +
             true;

     

       63
       63
       +
         };

     

       64
       64
       +
       }

+37

lib/types.nix

···

       614
       614
        
             nestedTypes.elemType = elemType;

     

       615
       615
        
           };

     

       616
       616
        
       

     

       617
       617
       +
           attrTag = tags: attrTagWith { inherit tags; };

     

       618
       618
       +
       

     

       619
       619
       +
           attrTagWith = { tags }:

     

       620
       620
       +
             let

     

       621
       621
       +
               choicesStr = concatMapStringsSep ", " lib.strings.escapeNixIdentifier (attrNames tags);

     

       622
       622
       +
             in

     

       623
       623
       +
             mkOptionType {

     

       624
       624
       +
               name = "attrTag";

     

       625
       625
       +
               description = "attribute-tagged union of ${choicesStr}";

     

       626
       626
       +
               getSubModules = null;

     

       627
       627
       +
               substSubModules = m: attrTagWith { tags = mapAttrs (n: v: v.substSubModules m) tags; };

     

       628
       628
       +
               check = v: isAttrs v && length (attrNames v) == 1 && tags?${head (attrNames v)};

     

       629
       629
       +
               merge = loc: defs:

     

       630
       630
       +
                 let

     

       631
       631
       +
                   choice = head (attrNames (head defs).value);

     

       632
       632
       +
                   checkedValueDefs = map

     

       633
       633
       +
                     (def:

     

       634
       634
       +
                       assert (length (attrNames def.value)) == 1;

     

       635
       635
       +
                       if (head (attrNames def.value)) != choice

     

       636
       636
       +
                       then throw "The option `${showOption loc}` is defined both as `${choice}` and `${head (attrNames def.value)}`, in ${showFiles (getFiles defs)}."

     

       637
       637
       +
                       else { inherit (def) file; value = def.value.${choice}; })

     

       638
       638
       +
                     defs;

     

       639
       639
       +
                 in

     

       640
       640
       +
                   if tags?${choice}

     

       641
       641
       +
                   then

     

       642
       642
       +
                     { ${choice} =

     

       643
       643
       +
                         (mergeDefinitions

     

       644
       644
       +
                           (loc ++ [choice])

     

       645
       645
       +
                           tags.${choice}

     

       646
       646
       +
                           checkedValueDefs

     

       647
       647
       +
                         ).mergedValue;

     

       648
       648
       +
                     }

     

       649
       649
       +
                   else throw "The option `${showOption loc}` is defined as ${lib.strings.escapeNixIdentifier choice}, but ${lib.strings.escapeNixIdentifier choice} is not among the valid choices (${choicesStr}). Value ${choice} was defined in ${showFiles (getFiles defs)}.";

     

       650
       650
       +
               nestedTypes = tags;

     

       651
       651
       +
               functor = (defaultFunctor "attrTagWith") // { payload = { inherit tags; }; binOp = a: b: { tags = a.tags // b.tags; }; };

     

       652
       652
       +
             };

     

       653
       653
       +
       

     

       617
       654
        
           uniq = unique { message = ""; };

     

       618
       655
        
       

     

       619
       656
        
           unique = { message }: type: mkOptionType rec {

+10

nixos/doc/manual/development/option-types.section.md

···

       334
       334
        
           the line `The option <option path> is defined multiple times.` and before

     

       335
       335
        
           a list of definition locations.

     

       336
       336
        
       

     

       337
       337
       +
       `types.attrTag` *`{ attr1 = t1; attr2 = t2; ... }`*

     

       338
       338
       +
       

     

       339
       339
       +
       :   An attribute set containing one attribute, whose name must be picked from

     

       340
       340
       +
           the attribute set (`attr1`, etc) and whose value must be of the accompanying

     

       341
       341
       +
           type.

     

       342
       342
       +
       

     

       343
       343
       +
           This is one possible representation of what may be called a _tagged union_ or _sum type_.

     

       344
       344
       +
           `attrTag` can be thought of as an extension of *`enum`* where the permissible items

     

       345
       345
       +
           are attribute names, and each item is paired with a value of a specific type.

     

       346
       346
       +
       

     

       337
       347
        
       `types.either` *`t1 t2`*

     

       338
       348
        
       

     

       339
       349
        
       :   Type *`t1`* or type *`t2`*, e.g. `with types; either int str`.