Something went wrong. Try again.
lol
Something went wrong. Try again.
14 kB · 471 lines
Nix
at master
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472# Generic builder.
{ lib, config, python, # Allow passing in a custom stdenv to buildPython*.override stdenv, wrapPython, unzip, ensureNewerSourcesForZipFilesHook, # Whether the derivation provides a Python module or not. toPythonModule, namePrefix, nix-update-script, setuptools, pypaBuildHook, pypaInstallHook, pythonCatchConflictsHook, pythonImportsCheckHook, pythonNamespacesHook, pythonOutputDistHook, pythonRelaxDepsHook, pythonRemoveBinBytecodeHook, pythonRemoveTestsDirHook, pythonRuntimeDepsCheckHook, setuptoolsBuildHook, wheelUnpackHook, eggUnpackHook, eggBuildHook, eggInstallHook,}:
let inherit (builtins) unsafeGetAttrPos; inherit (lib) elem extendDerivation fixedWidthString flip getName hasSuffix head isBool max optional optionalAttrs optionals optionalString removePrefix splitString stringLength ;
getOptionalAttrs = names: attrs: lib.getAttrs (lib.intersectLists names (lib.attrNames attrs)) attrs;
leftPadName = name: against: let len = max (stringLength name) (stringLength against); in fixedWidthString len " " name;
isPythonModule = drv: # all pythonModules have the pythonModule attribute (drv ? "pythonModule") # Some pythonModules are turned in to a pythonApplication by setting the field to false && (!isBool drv.pythonModule);
isMismatchedPython = drv: drv.pythonModule != python;
withDistOutput' = flip elem [ "pyproject" "setuptools" "wheel" ];
isBootstrapInstallPackage' = flip elem [ "flit-core" "installer" ];
isBootstrapPackage' = flip elem [ "build" "packaging" "pyproject-hooks" "wheel" ];
isSetuptoolsDependency' = flip elem [ "setuptools" "wheel" ];
in
lib.extendMkDerivation { constructDrv = stdenv.mkDerivation;
excludeDrvArgNames = [ "disabled" "checkPhase" "checkInputs" "nativeCheckInputs" "doCheck" "doInstallCheck" "pyproject" "format" "stdenv" "dependencies" "optional-dependencies" "build-system" ];
extendDrvArgs = finalAttrs: { # Build-time dependencies for the package nativeBuildInputs ? [ ],
# Run-time dependencies for the package buildInputs ? [ ],
# Dependencies needed for running the checkPhase. # These are added to buildInputs when doCheck = true. checkInputs ? [ ], nativeCheckInputs ? [ ],
# propagate build dependencies so in case we have A -> B -> C, # C can import package A propagated by B propagatedBuildInputs ? [ ],
# Python module dependencies. # These are named after PEP-621. dependencies ? [ ], optional-dependencies ? { },
# Python PEP-517 build systems. build-system ? [ ],
# DEPRECATED: use propagatedBuildInputs pythonPath ? [ ],
# Enabled to detect some (native)BuildInputs mistakes strictDeps ? true,
outputs ? [ "out" ],
# used to disable derivation, useful for specific python versions disabled ? false,
# Raise an error if two packages are installed with the same name # TODO: For cross we probably need a different PYTHONPATH, or not # add the runtime deps until after buildPhase. catchConflicts ? (python.stdenv.hostPlatform == python.stdenv.buildPlatform),
# Additional arguments to pass to the makeWrapper function, which wraps # generated binaries. makeWrapperArgs ? [ ],
# Skip wrapping of python programs altogether dontWrapPythonPrograms ? false,
# Don't use Pip to install a wheel # Note this is actually a variable for the pipInstallPhase in pip's setupHook. # It's included here to prevent an infinite recursion. dontUsePipInstall ? false,
# Skip setting the PYTHONNOUSERSITE environment variable in wrapped programs permitUserSite ? false,
# Remove bytecode from bin folder. # When a Python script has the extension `.py`, bytecode is generated # Typically, executables in bin have no extension, so no bytecode is generated. # However, some packages do provide executables with extensions, and thus bytecode is generated. removeBinBytecode ? true,
# pyproject = true <-> format = "pyproject" # pyproject = false <-> format = "other" # https://github.com/NixOS/nixpkgs/issues/253154 pyproject ? null,
# Several package formats are supported. # "setuptools" : Install a common setuptools/distutils based package. This builds a wheel. # "wheel" : Install from a pre-compiled wheel. # "pyproject": Install a package using a ``pyproject.toml`` file (PEP517). This builds a wheel. # "egg": Install a package from an egg. # "other" : Provide your own buildPhase and installPhase. format ? null,
meta ? { },
doCheck ? true,
... }@attrs:
let getFinalPassthru = let pos = unsafeGetAttrPos "passthru" finalAttrs; in attrName: finalAttrs.passthru.${attrName} or (throw ( '' ${finalAttrs.name}: passthru.${attrName} missing after overrideAttrs overriding. '' + optionalString (pos != null) '' Last overridden at ${pos.file}:${toString pos.line} '' ));
format' = assert (getFinalPassthru "pyproject" != null) -> (format == null); if getFinalPassthru "pyproject" != null then if getFinalPassthru "pyproject" then "pyproject" else "other" else if format != null then format else throw "${name} does not configure a `format`. To build with setuptools as before, set `pyproject = true` and `build-system = [ setuptools ]`.";
withDistOutput = withDistOutput' format';
validatePythonMatches = let throwMismatch = attrName: drv: let myName = "'${finalAttrs.name}'"; theirName = "'${drv.name}'"; optionalLocation = let pos = unsafeGetAttrPos (if attrs ? "pname" then "pname" else "name") attrs; in optionalString (pos != null) " at ${pos.file}:${toString pos.line}:${toString pos.column}"; in throw '' Python version mismatch in ${myName}:
The Python derivation ${myName} depends on a Python derivation named ${theirName}, but the two derivations use different versions of Python:
${leftPadName myName theirName} uses ${python} ${leftPadName theirName myName} uses ${toString drv.pythonModule}
Possible solutions:
* If ${theirName} is a Python library, change the reference to ${theirName} in the ${attrName} of ${myName} to use a ${theirName} built from the same version of Python
* If ${theirName} is used as a tool during the build, move the reference to ${theirName} in ${myName} from ${attrName} to nativeBuildInputs
* If ${theirName} provides executables that are called at run time, pass its bin path to makeWrapperArgs:
makeWrapperArgs = [ "--prefix PATH : ''${lib.makeBinPath [ ${getName drv} ] }" ];
${optionalLocation} '';
checkDrv = attrName: drv: if (isPythonModule drv) && (isMismatchedPython drv) then throwMismatch attrName drv else drv;
in attrName: inputs: map (checkDrv attrName) inputs;
isBootstrapInstallPackage = isBootstrapInstallPackage' (finalAttrs.pname or null);
isBootstrapPackage = isBootstrapInstallPackage || isBootstrapPackage' (finalAttrs.pname or null);
isSetuptoolsDependency = isSetuptoolsDependency' (finalAttrs.pname or null);
name = namePrefix + attrs.name or "${finalAttrs.pname}-${finalAttrs.version}";
runtimeDepsCheckHook = if isBootstrapPackage then pythonRuntimeDepsCheckHook.override { inherit (python.pythonOnBuildForHost.pkgs.bootstrap) packaging; } else pythonRuntimeDepsCheckHook;
in { inherit name;
inherit catchConflicts;
nativeBuildInputs = [ python wrapPython ensureNewerSourcesForZipFilesHook # move to wheel installer (pip) or builder (setuptools, flit, ...)? pythonRemoveTestsDirHook ] ++ optionals (finalAttrs.catchConflicts && !isBootstrapPackage && !isSetuptoolsDependency) [ # # 1. When building a package that is also part of the bootstrap chain, we # must ignore conflicts after installation, because there will be one with # the package in the bootstrap. # # 2. When a package is a dependency of setuptools, we must ignore conflicts # because the hook that checks for conflicts uses setuptools. # pythonCatchConflictsHook ] ++ optionals (finalAttrs.pythonRelaxDeps or [ ] != [ ] || finalAttrs.pythonRemoveDeps or [ ] != [ ]) [ pythonRelaxDepsHook ] ++ optionals removeBinBytecode [ pythonRemoveBinBytecodeHook ] ++ optionals (hasSuffix "zip" (finalAttrs.src.name or "")) [ unzip ] ++ optionals (format' == "setuptools") [ setuptoolsBuildHook ] ++ optionals (format' == "pyproject") [ ( if isBootstrapPackage then pypaBuildHook.override { inherit (python.pythonOnBuildForHost.pkgs.bootstrap) build; wheel = null; } else pypaBuildHook ) runtimeDepsCheckHook ] ++ optionals (format' == "wheel") [ wheelUnpackHook runtimeDepsCheckHook ] ++ optionals (format' == "egg") [ eggUnpackHook eggBuildHook eggInstallHook ] ++ optionals (format' != "other") [ ( if isBootstrapInstallPackage then pypaInstallHook.override { inherit (python.pythonOnBuildForHost.pkgs.bootstrap) installer; } else pypaInstallHook ) ] ++ optionals (stdenv.buildPlatform == stdenv.hostPlatform) [ # This is a test, however, it should be ran independent of the checkPhase and checkInputs pythonImportsCheckHook ] ++ optionals (python.pythonAtLeast "3.3") [ # Optionally enforce PEP420 for python3 pythonNamespacesHook ] ++ optionals withDistOutput [ pythonOutputDistHook ] ++ nativeBuildInputs ++ getFinalPassthru "build-system";
buildInputs = validatePythonMatches "buildInputs" (buildInputs ++ pythonPath);
propagatedBuildInputs = validatePythonMatches "propagatedBuildInputs" ( propagatedBuildInputs ++ getFinalPassthru "dependencies" ++ [ # we propagate python even for packages transformed with 'toPythonApplication' # this pollutes the PATH but avoids rebuilds # see https://github.com/NixOS/nixpkgs/issues/170887 for more context python ] );
inherit strictDeps;
env = { LANG = "${if python.stdenv.hostPlatform.isDarwin then "en_US" else "C"}.UTF-8"; } // (attrs.env or { });
# Python packages don't have a checkPhase, only an installCheckPhase doCheck = false; doInstallCheck = attrs.doCheck or true; nativeInstallCheckInputs = nativeCheckInputs ++ attrs.nativeInstallCheckInputs or [ ]; installCheckInputs = checkInputs ++ attrs.installCheckInputs or [ ];
inherit dontWrapPythonPrograms;
postFixup = optionalString (!finalAttrs.dontWrapPythonPrograms) '' wrapPythonPrograms '' + attrs.postFixup or "";
# Python packages built through cross-compilation are always for the host platform. disallowedReferences = optionals (python.stdenv.hostPlatform != python.stdenv.buildPlatform) [ python.pythonOnBuildForHost ];
outputs = outputs ++ optional withDistOutput "dist";
passthru = { inherit disabled pyproject build-system dependencies optional-dependencies ; updateScript = nix-update-script { }; ${if attrs ? stdenv then "__stdenvPythonCompat" else null} = attrs.stdenv; } // attrs.passthru or { };
meta = { # default to python's platforms platforms = python.meta.platforms; isBuildPythonPackage = python.meta.platforms; } // meta; } // optionalAttrs (attrs ? checkPhase) { # If given use the specified checkPhase, otherwise use the setup hook. # Longer-term we should get rid of `checkPhase` and use `installCheckPhase`. installCheckPhase = attrs.checkPhase; } // lib.mapAttrs ( name: value: lib.throwIf ( attrs.${name} == [ ] ) "${lib.getName finalAttrs}: ${name} must be unspecified, null or a non-empty list." attrs.${name} ) ( getOptionalAttrs [ "enabledTestMarks" "enabledTestPaths" "enabledTests" ] attrs );
# This derivation transformation function must be independent to `attrs` # for fixed-point arguments support in the future. transformDrv = let # Workaround to make the `lib.extendDerivation`-based disabled functionality # respect `<pkg>.overrideAttrs` # It doesn't cover `<pkg>.<output>.overrideAttrs`. disablePythonPackage = drv: extendDerivation ( drv.disabled -> throw "${removePrefix namePrefix drv.name} not supported for interpreter ${python.executable}" ) { } drv // { overrideAttrs = fdrv: disablePythonPackage (drv.overrideAttrs fdrv); }; in drv: disablePythonPackage (toPythonModule drv);}