nixpkgs/pkgs/development/python-modules/generic/default.nix
Eelco Dolstra 120d1757fe * buildPythonPackage: added an argument `pythonPath' to specify Python
dependencies that are *not* propagated to the user environment
  (as opposed to `propagatedBuildInputs').  For instance, if you
  install `iotop', you typically don't want its Python dependencies
  polluting the user environment.
  
* buildPythonPackage: some cleanup (e.g. use function argument
  defaults instead of `if attrs ? foo then attrs.foo else []').

svn path=/nixpkgs/branches/modular-python/; revision=26571
2011-03-28 15:30:48 +00:00

107 lines
3.3 KiB
Nix

/* 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. */
{ python, setuptools, makeWrapper, lib }:
{ name, namePrefix ? "python-"
, buildInputs ? []
, # 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 ? []
, installCommand ?
''
easy_install --prefix="$out" .
''
, buildPhase ? "true"
, doCheck ? true, checkPhase ? "python setup.py test"
, postInstall ? ""
, ... } @ attrs:
# Keep extra attributes from ATTR, e.g., `patchPhase', etc.
python.stdenv.mkDerivation (attrs // {
inherit doCheck buildPhase checkPhase;
name = namePrefix + name;
buildInputs = [ python makeWrapper setuptools ] ++ buildInputs ++ pythonPath;
pythonPath = [ setuptools] ++ pythonPath;
# XXX: Should we run `easy_install --always-unzip'? It doesn't seem
# to have a noticeable impact on small scripts.
installPhase = ''
ensureDir "$out/lib/${python.libPrefix}/site-packages"
echo "installing \`${name}' with \`easy_install'..."
export PYTHONPATH="$out/lib/${python.libPrefix}/site-packages:$PYTHONPATH"
${installCommand}
${postInstall}
'';
postFixup =
''
declare -A pythonPathsSeen
addToPythonPath() {
local dir="$1"
if [ -n "''${pythonPathsSeen[$dir]}" ]; then return; fi
pythonPathsSeen[$dir]=1
addToSearchPath program_PYTHONPATH $dir/lib/${python.libPrefix}/site-packages
addToSearchPath program_PATH $dir/bin
local prop="$dir/nix-support/propagated-build-native-inputs"
if [ -e $prop ]; then
local i
for i in $(cat $prop); do
addToPythonPath $i
done
fi
}
wrapPythonPrograms() {
local dir="$1"
local pythonPath="$2"
local i
pythonPathsSeen=()
program_PYTHONPATH=
program_PATH=
for i in $pythonPath; do
addToPythonPath $i
done
for i in $(find "$out" -type f -perm +0100); do
if head -n1 "$i" | grep -q "${python}"; then
echo "wrapping \`$i'..."
wrapProgram "$i" \
--prefix PYTHONPATH ":" $program_PYTHONPATH \
--prefix PATH ":" $program_PATH
fi
done
}
wrapPythonPrograms $out "$out $pythonPath"
# 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
fi
'';
})