2009-05-24 22:02:59 +01:00
|
|
|
/* This function provides a generic Python package builder. It is
|
2014-01-06 22:24:05 +00:00
|
|
|
intended to work with packages that use `distutils/setuptools'
|
2009-05-24 22:02:59 +01:00
|
|
|
(http://pypi.python.org/pypi/setuptools/), which represents a large
|
|
|
|
number of Python packages nowadays. */
|
|
|
|
|
2015-11-17 10:38:26 +00:00
|
|
|
{ python, setuptools, unzip, wrapPython, lib, bootstrapped-pip }:
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2014-01-06 22:24:05 +00:00
|
|
|
{ name
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2014-01-11 10:44:24 +00:00
|
|
|
# by default prefix `name` e.g. "python3.3-${name}"
|
2014-01-06 22:24:05 +00:00
|
|
|
, namePrefix ? python.libPrefix + "-"
|
2010-07-28 14:05:04 +01:00
|
|
|
|
2014-01-06 22:24:05 +00:00
|
|
|
, buildInputs ? []
|
2012-12-03 04:20:50 +00:00
|
|
|
|
2014-01-11 10:44:24 +00:00
|
|
|
# propagate build dependencies so in case we have A -> B -> C,
|
|
|
|
# C can import propagated packages by A
|
2014-01-06 22:24:05 +00:00
|
|
|
, propagatedBuildInputs ? []
|
2013-01-17 13:19:14 +00:00
|
|
|
|
2014-01-06 22:24:05 +00:00
|
|
|
# passed to "python setup.py build"
|
2015-11-17 10:38:26 +00:00
|
|
|
# https://github.com/pypa/pip/issues/881
|
2014-01-06 22:24:05 +00:00
|
|
|
, setupPyBuildFlags ? []
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2014-01-06 22:24:05 +00:00
|
|
|
# enable tests by default
|
2011-03-30 13:27:04 +01:00
|
|
|
, doCheck ? true
|
|
|
|
|
2015-11-17 10:38:26 +00:00
|
|
|
# DEPRECATED: use propagatedBuildInputs
|
2014-08-24 15:01:21 +01:00
|
|
|
, pythonPath ? []
|
|
|
|
|
|
|
|
# used to disable derivation, useful for specific python versions
|
|
|
|
, disabled ? false
|
2009-06-28 15:05:41 +01:00
|
|
|
|
2014-01-10 20:57:28 +00:00
|
|
|
, meta ? {}
|
2013-01-19 17:21:23 +00:00
|
|
|
|
2014-03-10 09:06:04 +00:00
|
|
|
# Execute before shell hook
|
|
|
|
, preShellHook ? ""
|
|
|
|
|
|
|
|
# Execute after shell hook
|
|
|
|
, postShellHook ? ""
|
|
|
|
|
2015-05-24 16:19:13 +01:00
|
|
|
# Additional arguments to pass to the makeWrapper function, which wraps
|
|
|
|
# generated binaries.
|
|
|
|
, makeWrapperArgs ? []
|
2015-05-22 05:32:03 +01:00
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
, ... } @ attrs:
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2014-08-24 15:01:21 +01:00
|
|
|
|
2014-01-06 22:24:05 +00:00
|
|
|
# Keep extra attributes from `attrs`, e.g., `patchPhase', etc.
|
2015-05-22 05:32:03 +01:00
|
|
|
if disabled
|
|
|
|
then throw "${name} not supported for interpreter ${python.executable}"
|
|
|
|
else
|
|
|
|
|
2015-11-17 10:38:26 +00:00
|
|
|
let
|
|
|
|
setuppy = "import setuptools, tokenize;__file__='setup.py';exec(compile(getattr(tokenize, 'open', open)(__file__).read().replace('\\r\\n', '\\n'), __file__, 'exec'))";
|
|
|
|
in
|
2015-10-30 10:31:09 +00:00
|
|
|
python.stdenv.mkDerivation (builtins.removeAttrs attrs ["disabled"] // {
|
2014-01-06 22:24:05 +00:00
|
|
|
inherit doCheck;
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
name = namePrefix + name;
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2015-11-17 10:38:26 +00:00
|
|
|
buildInputs = [ wrapPython bootstrapped-pip ] ++ buildInputs ++ pythonPath
|
2014-03-10 13:51:05 +00:00
|
|
|
++ (lib.optional (lib.hasSuffix "zip" attrs.src.name or "") unzip);
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2015-04-13 02:15:31 +01:00
|
|
|
# propagate python/setuptools to active setup-hook in nix-shell
|
2015-11-17 10:38:26 +00:00
|
|
|
propagatedBuildInputs = propagatedBuildInputs ++ [ python setuptools ];
|
2012-07-21 00:55:50 +01:00
|
|
|
|
2015-04-13 02:15:31 +01:00
|
|
|
pythonPath = pythonPath;
|
2012-11-23 16:27:55 +00:00
|
|
|
|
2014-01-06 22:24:05 +00:00
|
|
|
configurePhase = attrs.configurePhase or ''
|
|
|
|
runHook preConfigure
|
|
|
|
|
2014-01-10 21:04:05 +00:00
|
|
|
# patch python interpreter to write null timestamps when compiling python files
|
2015-11-17 10:38:26 +00:00
|
|
|
# this way python doesn't try to update them when we freeze timestamps in nix store
|
2013-06-22 06:52:27 +01:00
|
|
|
export DETERMINISTIC_BUILD=1
|
2014-01-06 22:24:05 +00:00
|
|
|
|
|
|
|
runHook postConfigure
|
|
|
|
'';
|
|
|
|
|
|
|
|
checkPhase = attrs.checkPhase or ''
|
2015-11-17 10:38:26 +00:00
|
|
|
runHook preCheck
|
|
|
|
${python.interpreter} -c "${setuppy}" test
|
|
|
|
runHook postCheck
|
2014-01-06 22:24:05 +00:00
|
|
|
'';
|
|
|
|
|
|
|
|
buildPhase = attrs.buildPhase or ''
|
|
|
|
runHook preBuild
|
2015-11-17 10:38:26 +00:00
|
|
|
${python.interpreter} -c "${setuppy}" bdist_wheel
|
2014-01-06 22:24:05 +00:00
|
|
|
runHook postBuild
|
2012-11-29 14:29:41 +00:00
|
|
|
'';
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2014-01-06 22:24:05 +00:00
|
|
|
installPhase = attrs.installPhase or ''
|
|
|
|
runHook preInstall
|
|
|
|
|
2015-11-17 10:38:26 +00:00
|
|
|
mkdir -p "$out/${python.sitePackages}"
|
|
|
|
export PYTHONPATH="$out/${python.sitePackages}:$PYTHONPATH"
|
2012-11-23 14:54:55 +00:00
|
|
|
|
2015-11-17 10:38:26 +00:00
|
|
|
pushd dist
|
|
|
|
${bootstrapped-pip}/bin/pip install *.whl --no-index --prefix=$out
|
|
|
|
popd
|
2012-11-23 14:54:55 +00:00
|
|
|
|
2014-01-06 22:24:05 +00:00
|
|
|
runHook postInstall
|
2009-05-24 22:02:59 +01:00
|
|
|
'';
|
|
|
|
|
2014-05-21 13:46:37 +01:00
|
|
|
postFixup = attrs.postFixup or ''
|
2015-11-17 10:38:26 +00:00
|
|
|
wrapPythonPrograms
|
|
|
|
'';
|
2014-01-06 22:24:05 +00:00
|
|
|
|
2014-03-10 09:06:04 +00:00
|
|
|
shellHook = attrs.shellHook or ''
|
2015-11-15 12:49:20 +00:00
|
|
|
${preShellHook}
|
2014-06-15 15:05:09 +01:00
|
|
|
if test -e setup.py; then
|
2015-11-15 12:49:20 +00:00
|
|
|
tmp_path=$(mktemp -d)
|
2014-09-19 13:23:45 +01:00
|
|
|
export PATH="$tmp_path/bin:$PATH"
|
2015-11-15 12:49:20 +00:00
|
|
|
export PYTHONPATH="$tmp_path/${python.sitePackages}:$PYTHONPATH"
|
|
|
|
${python.interpreter} setup.py develop --prefix $tmp_path
|
2014-06-15 15:05:09 +01:00
|
|
|
fi
|
2015-11-15 12:49:20 +00:00
|
|
|
${postShellHook}
|
2014-03-10 09:06:04 +00:00
|
|
|
'';
|
|
|
|
|
2014-01-22 09:15:26 +00:00
|
|
|
meta = with lib.maintainers; {
|
2014-01-06 22:24:05 +00:00
|
|
|
# default to python's platforms
|
|
|
|
platforms = python.meta.platforms;
|
2014-01-22 09:15:26 +00:00
|
|
|
} // meta // {
|
2014-01-06 22:24:05 +00:00
|
|
|
# add extra maintainer(s) to every package
|
2014-01-11 10:44:24 +00:00
|
|
|
maintainers = (meta.maintainers or []) ++ [ chaoflow iElectric ];
|
2014-01-06 22:24:05 +00:00
|
|
|
};
|
2011-03-28 16:30:48 +01:00
|
|
|
})
|