summaryrefslogtreecommitdiffstats
path: root/doc/doc-support/python-interpreter-table.nix
blob: 84e6c7003616a91c0e2b8f746885e37edda55632 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# To build this derivation, run `nix-build -A nixpkgs-manual.pythonInterpreterTable`
{
  lib,
  writeText,
  pkgs,
  pythonInterpreters,
}:
let
  isPythonInterpreter =
    name:
    /*
      NB: Package names that don't follow the regular expression:
      - `python-cosmopolitan` is not part of `pkgs.pythonInterpreters`.
      - `_prebuilt` interpreters are used for bootstrapping internally.
      - `python3Minimal` contains python packages, left behind conservatively.
      - `rustpython` lacks `pythonVersion` and `implementation`.
    */
    (lib.strings.match "(pypy|python)([[:digit:]]*)" name) != null;

  interpreterName =
    pname:
    let
      cuteName = {
        cpython = "CPython";
        pypy = "PyPy";
      };
      interpreter = pkgs.${pname};
    in
    "${cuteName.${interpreter.implementation}} ${interpreter.pythonVersion}";

  interpreters = lib.reverseList (
    lib.naturalSort (lib.filter isPythonInterpreter (lib.attrNames pythonInterpreters))
  );

  aliases =
    pname:
    lib.attrNames (
      lib.filterAttrs (
        name: value:
        # use tryEval to handle entries in aliases.nix
        (builtins.tryEval (
          isPythonInterpreter name && name != pname && interpreterName name == interpreterName pname
        )).value
      ) pkgs
    );

  result = map (pname: {
    inherit pname;
    aliases = aliases pname;
    interpreter = interpreterName pname;
  }) interpreters;

  toMarkdown =
    data:
    let
      line = package: ''
        | ${package.pname} | ${lib.concatStringsSep ", " package.aliases or [ ]} | ${package.interpreter} |
      '';
    in
    lib.concatStringsSep "" (map line data);

in
writeText "python-interpreter-table.md" ''
  | Package | Aliases | Interpreter |
  |---------|---------|-------------|
  ${toMarkdown result}
''