Skip to content

Commit

Permalink
Override sys.prefix only if it hasn't been changed
Browse files Browse the repository at this point in the history
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.path, 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.
  • Loading branch information
cottsay committed Jun 7, 2024
1 parent d95da69 commit dd58dfc
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions colcon_core/task/python/build.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
})

Expand Down
2 changes: 1 addition & 1 deletion colcon_core/task/python/template/sitecustomize.py.em
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import sys
if sys.prefix == sys.base_prefix:
if sys.prefix == @repr(current_prefix):
sys.real_prefix = sys.prefix
sys.prefix = sys.exec_prefix = @repr(site_prefix)

0 comments on commit dd58dfc

Please sign in to comment.