2009-05-24 22:02:59 +01:00
|
|
|
/* This function provides a generic Python package builder. It is
|
|
|
|
intended to work with packages that use `setuptools'
|
|
|
|
(http://pypi.python.org/pypi/setuptools/), which represents a large
|
|
|
|
number of Python packages nowadays. */
|
|
|
|
|
2012-12-03 04:20:50 +00:00
|
|
|
{ python, setuptools, wrapPython, lib, offlineDistutils, setuptoolsSite }:
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
{ name, namePrefix ? "python-"
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
, buildInputs ? []
|
2010-07-28 14:05:04 +01:00
|
|
|
|
2012-12-03 04:20:50 +00:00
|
|
|
, propagatedBuildInputs ? []
|
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
, # List of packages that should be added to the PYTHONPATH
|
|
|
|
# environment variable in programs built by this function. Packages
|
|
|
|
# in the standard `propagatedBuildInputs' variable are also added.
|
|
|
|
# The difference is that `pythonPath' is not propagated to the user
|
|
|
|
# environment. This is preferrable for programs because it doesn't
|
|
|
|
# pollute the user environment.
|
|
|
|
pythonPath ? []
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
, installCommand ?
|
|
|
|
''
|
2012-07-20 23:20:21 +01:00
|
|
|
easy_install --always-unzip --prefix="$out" .
|
2011-03-28 16:30:48 +01:00
|
|
|
''
|
|
|
|
|
2012-11-29 14:29:41 +00:00
|
|
|
, preConfigure ? "true"
|
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
, buildPhase ? "true"
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2011-03-30 13:27:04 +01:00
|
|
|
, doCheck ? true
|
|
|
|
|
|
|
|
, checkPhase ?
|
|
|
|
''
|
|
|
|
runHook preCheck
|
|
|
|
python setup.py test
|
|
|
|
runHook postCheck
|
|
|
|
''
|
2012-12-03 03:41:19 +00:00
|
|
|
|
2013-01-09 14:44:48 +00:00
|
|
|
, preInstall ? ""
|
2011-03-28 16:30:48 +01:00
|
|
|
, postInstall ? ""
|
2009-06-28 15:05:41 +01:00
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
, ... } @ attrs:
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
# Keep extra attributes from ATTR, e.g., `patchPhase', etc.
|
|
|
|
python.stdenv.mkDerivation (attrs // {
|
|
|
|
inherit doCheck buildPhase checkPhase;
|
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
|
|
|
|
2012-12-03 07:01:16 +00:00
|
|
|
phases = "unpackPhase patchPhase configurePhase buildPhase installPhase checkPhase fixupPhase distPhase";
|
|
|
|
|
2012-02-28 00:06:52 +00:00
|
|
|
buildInputs = [ python wrapPython setuptools ] ++ buildInputs ++ pythonPath;
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2012-12-03 04:20:50 +00:00
|
|
|
# setuptoolsSite is responsible for loading pth files
|
|
|
|
propagatedBuildInputs = propagatedBuildInputs ++ [ setuptoolsSite ];
|
|
|
|
|
2012-07-21 00:55:50 +01:00
|
|
|
buildInputStrings = map toString buildInputs;
|
|
|
|
|
2012-12-03 03:41:19 +00:00
|
|
|
pythonPath = [ setuptools] ++ pythonPath;
|
2012-11-23 16:27:55 +00:00
|
|
|
|
2012-11-29 14:29:41 +00:00
|
|
|
preConfigure = ''
|
|
|
|
PYTHONPATH="${offlineDistutils}/lib/${python.libPrefix}/site-packages:$PYTHONPATH"
|
|
|
|
${preConfigure}
|
|
|
|
'';
|
2009-05-24 22:02:59 +01:00
|
|
|
|
2013-01-09 14:44:48 +00:00
|
|
|
installPhase = preInstall + ''
|
2012-01-18 20:16:00 +00:00
|
|
|
mkdir -p "$out/lib/${python.libPrefix}/site-packages"
|
2009-05-24 22:02:59 +01:00
|
|
|
|
|
|
|
echo "installing \`${name}' with \`easy_install'..."
|
|
|
|
export PYTHONPATH="$out/lib/${python.libPrefix}/site-packages:$PYTHONPATH"
|
2011-03-28 16:30:48 +01:00
|
|
|
${installCommand}
|
2009-08-11 17:25:41 +01:00
|
|
|
|
2012-11-23 14:54:55 +00:00
|
|
|
# A pth file might have been generated to load the package from
|
|
|
|
# within its own site-packages, rename this package not to
|
|
|
|
# collide with others.
|
|
|
|
eapth="$out/lib/${python.libPrefix}"/site-packages/easy-install.pth
|
|
|
|
if [ -e "$eapth" ]; then
|
|
|
|
# move colliding easy_install.pth to specifically named one
|
|
|
|
mv "$eapth" $(dirname "$eapth")/${name}.pth
|
|
|
|
fi
|
|
|
|
|
|
|
|
# Remove any site.py files generated by easy_install as these
|
|
|
|
# cause collisions. If pth files are to be processed a
|
|
|
|
# corresponding site.py needs to be included in the PYTHONPATH.
|
2012-12-07 10:44:46 +00:00
|
|
|
#
|
|
|
|
# leave them until we have a better solution: see #209
|
|
|
|
#rm -f "$out/lib/${python.libPrefix}"/site-packages/site.py*
|
2012-11-23 14:54:55 +00:00
|
|
|
|
2009-08-11 17:25:41 +01:00
|
|
|
${postInstall}
|
2009-05-24 22:02:59 +01:00
|
|
|
'';
|
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
postFixup =
|
|
|
|
''
|
2011-03-28 17:33:33 +01:00
|
|
|
wrapPythonPrograms
|
2012-07-21 00:55:50 +01:00
|
|
|
|
2011-03-28 16:30:48 +01:00
|
|
|
# If a user installs a Python package, she probably also wants its
|
|
|
|
# dependencies in the user environment (since Python modules don't
|
|
|
|
# have something like an RPATH, so the only way to find the
|
|
|
|
# dependencies is to have them in the PYTHONPATH variable).
|
|
|
|
if test -e $out/nix-support/propagated-build-inputs; then
|
|
|
|
ln -s $out/nix-support/propagated-build-inputs $out/nix-support/propagated-user-env-packages
|
2009-05-24 22:02:59 +01:00
|
|
|
fi
|
2012-07-21 00:55:50 +01:00
|
|
|
|
|
|
|
createBuildInputsPth build-inputs "$buildInputStrings"
|
2012-12-28 18:20:09 +00:00
|
|
|
for inputsfile in propagated-build-inputs propagated-native-build-inputs; do
|
2012-07-21 00:55:50 +01:00
|
|
|
if test -e $out/nix-support/$inputsfile; then
|
|
|
|
createBuildInputsPth $inputsfile "$(cat $out/nix-support/$inputsfile)"
|
|
|
|
fi
|
|
|
|
done
|
2011-03-28 16:30:48 +01:00
|
|
|
'';
|
|
|
|
})
|