If you want to completely control the sys.path of your copy of python.exe, do the following:
- Create a site.py next to it that contains nothing but the line “import sitecustomize”
- place a sitecustomize.py next to it, that rewrites sys.path to your liking
- run your python.exe, somewhat safe in the knowledge that it won’t be affected by any other python installed on the system.
The Long Explanation:
At CCP we work with many branches of many games. All of these games use Python to some extent. Each branch comes complete with its own python source tree, where local patches are added to Python and which may be of different python versions. Each branch then builds its own python2x.dll and a python.exe, in addition, perhaps, to static versions of the python core for inclusion into a game executable.
What is more, each of these branches contains a plethora of offline tools. These may be build scripts, test scripts and so on, and most of them are written in Python. For general harmony, of course, this python version must be the same version as the one used in the game, that is, the offline tools used in a branch should use a Python version local to that branch. This is where things become messy.
I’ve often vented my frustration to my colleagues about how “install oriented” Python appears to be. For embedding, until recently there wasn’t even a way for a host application to completely control Python’s sys.path. Python.exe will, when executed, go through a series of magic moves to guess an initial sys.path. After this it will, unless instructed not to, try to import site.py which continues with the magic path munging process.
There is one alternative behaviour built into Python (yes, built in.) If Python upon initialization detects that it is being run from something that looks like a build folder structure, it will initialize sys.path locally to that structure. Otherwise, it will go ahead and set sys.path to what it thinks is the system wide sensible locations before importing site.py.
This then, is how python.exe is designed. Either it is being built and then can live in a local, isolated, setting, or it is installed and uses machine global information for its environment.
For our branch specific tools, it was important to override this behaviour. A buildstuff.cmd batch file in /games/foo/tools ought to be able to call ../bin/python.exe and have that particular copy of python.exe set up sys.path to, say, ../src/python27/Lib. Further, this needs to happen without the kludgy help of environment variables or, dear I say it, registry settings. These are a nightmare to manage in a distributed environment with gazillion developer machines, build bots, and so on.
Fortunately, there is something called sitecustomize.py. The documentation specifies that after site.py is imported, python will try to “import sitecustomize” and this can be used to do local path adjustments.
The initial approach
When we started doing this in earnest we were using Python 2.6 both as an installed “tool” on developer machines and as the Python version in use for that particular branch. We found that by copying python.exe out of the PCBuild build folder into a game/foo/bin folder, and placing a sitecustomize.py next to it, we could fully control sys.path the way we wanted. The our sitecustomize.py would look something like this:
localdir = "/".join(__file__.split('\')[:-1])
root = localdir + "/../"
python = root + "src/python/python27/"
sys.path = [python+"PCBuild", python+"Lib", root + "modules"]
This works because python.exe’s directory is put in sys.path by Python built-in startup magic! Of course, there is no reliable way to find it from the .py file, so the trick with __file__ is used. Also, we can’t use os.path for our path manipulation since we really don’t want to import it. Who knows what side effect is may have, importing stuff from the “default” sys.path. But it is was good enough for our purposes. For a while.
Switching to Python 2.7
Then we moved one branch to use Python 2.7. Python was recompiled, and python.exe put in the bin folder as before, but suddenly, some machines (particularly the build machines) started failing. The python tools complained that site could not be imported.
On investigation it turned out that previously all machines using this scheme had, by a happy coincidence, had Python 2.6 installed on them, and our local python.exe had been importing site.py from c:Python26Lib. Now, python was looking for site.py in, among other places, c:Python27Lib (one of the magic path entries set up by python.exe and which it is impossible to override.)
To fix this, I placed an empty site.py next to sitecustomize.py and python.exe in the bin folder, hoping that would work. Indeed, the build machines now succeeded in finding a site.py, but now sitecustomize.py wasn’t being run.
It wasn’t until I actually looked at pythonrun.c that I realized that sitecustomize.py is being imported and executed by the site.py in python’s standard library!. So, it is site.py’s responsibility to call sitecustomize.py (and something called usercustomize.py that I had previously not known about.)
The solution then: Instead of an empty site.py, have a site.py containing this code:
So, we have found that to have an isolated python.exe for which you control it’s sys.path absolutely with no external influences, you need a sitecustomize.py to override your sys.path. But for that to run, you must provide your own site.py, in case a system-wide site.py isn’t found.
It is annoying that if a system-wide site.py is found, than this is run. There, already, you have lost some control over your python.exe. Who knows what a malicious system administrator may do in such a file? So even with our approach, there is no absolute control.
It’s also annoying that you need two files to accomplish this task. It would be nice if python.exe could be instructed to not do any automatic path guessing and just take its initial sys.path from a startup file. The fact that python.exe has a built-in mechanism to set a different initial sys.path if it detects that it is being run out of a build folder, indicates that someone sometime recognized the need for this, but only took it half the way.
My suggestion would be this: If a site.py (or site.pyc) is found in an initial place, e.g. next to the executable, then set the initial sys.path to only that place and skip all other magic.
This could then be used to great effect in the build system. Instead of building into python.exe a separate folder structure for built environments, just create a site.py in the PCBuild directory (or the equivalent platform place) and set it up there. Similarly, a site.py could be put in place in c:Python27bin and the entire ugly logic of initial path setting could be removed from python.exe.
As a side note, I have always thought that the initial path-guessing should be a feature of python.exe and not python27.dll as such. python.exe should, in my opinion, call something like Py_Guess_Path() before calling Py_Initialize(), since it is a very specific behaviour of that particular embedding application.