Disable sitecustomize paths if in virtual env (#623)

The purpose of the sitecustomize here is to make setuptools install
stuff to our prefix instead of the global prefix, and to appear enough
like a virtual environment that platform-specific patches to sysconfig
don't interfere with that effort.

It isn't inconceivable that there may be subprocesses involved in the
build, and we want any installation happening in those subprocesses to
also get the redirect, and that currently works as expected as long as
the sitecustomize directory remains on PYTHONPATH somewhere.

However, if some subprocess is also modifying sys.prefix, as would be the
case if a subprocess was using a new virtual environment, we don't want
to override those changes. Since we know what sys.prefix was when colcon
was invoked, we can just check to see if it changed.

Co-authored-by: Luka Juricic <[email protected]>
Co-authored-by: Scott K Logan <[email protected]>

Author: LukaJuricic

colcon_core/task/python/build.py

@@ -70,6 +70,7 @@ async def build(self, *, additional_hooks=None):  # noqa: D102
             Path(__file__).parent / 'template' / 'sitecustomize.py.em',
             prefix_override / 'sitecustomize.py',
             {
+                'current_prefix': sys.prefix,
                 'site_prefix': args.install_base,
             })
 

colcon_core/task/python/template/sitecustomize.py.em

@@ -1,3 +1,4 @@
 import sys
-sys.real_prefix = sys.prefix
-sys.prefix = sys.exec_prefix = @repr(site_prefix)
+if sys.prefix == @repr(current_prefix):
+    sys.real_prefix = sys.prefix
+    sys.prefix = sys.exec_prefix = @repr(site_prefix)