I would like to install some packages into a third-party site-packages
directory (beyond the standard system locations). Is there any way to set this up such that .pth files therein are respected?
Background: I'm using OS X, virtualenv, and homebrew. There are a few packages (notably wxPython in my case) that do not install nicely through pip into virtualenv. In these cases, there are homebrew packages that work in their stead. Homebrew creates a third site-packages folder in /usr/local/lib/python2.7
. I'd like to simply point to this folder and leave the maintenance of all items there under brew
's control. It seems, however, that this is not possible.
$PYTHONPATH
does not load .pth files. (Should Python 2.6 on OS X deal with multiple easy-install.pth files in $PYTHONPATH?)add2virtualenv
adds some extra smarts to the .pth file beyond simply having the directory listed, but I believe it simply reorders the path list.I'm certainly not the only one interested in this issue. I'd wager a good number of the generic 'pth files not working' questions and posts online that I've stumbled across are related to this issue. Is there a good solution?
When a package is installed globally, it's made available to all users that log into the system. Typically, that means Python and all packages will get installed to a directory under /usr/local/bin/ for a Unix-based system, or \Program Files\ for Windows.
Default value is ~/. local/lib/pythonX.Y/site-packages for UNIX and non-framework macOS builds, ~/Library/Python/X.Y/lib/python/site-packages for macOS framework builds, and %APPDATA%\Python\PythonXY\site-packages on Windows.
Take a look at the site module. It provides the function addsitedir
which should do what you want.
The easiest way to use this would be to create a file named sitecustomize.py
or usercustomize.py
and place it in a current PYTHONPATH
directory (or any directory that ends up on sys.path
) with the following contents:
import site
site.addsitedir('/usr/local/lib/python2.7')
When Python is starting an attempt is made to import sitecustomize
and then usercustomize
, which is why this works. From the site documentation:
After these path manipulations, an attempt is made to import a module named
sitecustomize
, which can perform arbitrary site-specific customizations. It is typically created by a system administrator in the site-packages directory. If this import fails with anImportError
exception, it is silently ignored.After this, an attempt is made to import a module named
usercustomize
, which can perform arbitrary user-specific customizations, ifENABLE_USER_SITE
is true. This file is intended to be created in the user site-packages directory (see below), which is part ofsys.path
unless disabled by-s
. AnImportError
will be silently ignored.
There was PEP 370 specifically addressing the creation of per-user site-packages
directories, to deal with the situation where the user has no admin access to the system-wide site-packages
.
For example on Unix (including Mac OS), and assuming one is using Python 3.6, one can create the following directory and place .pth
files inside there
~/.local/lib/python3.6/site-packages
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With