Avoid deb_system and --install-layout deb (#507)

* Avoid deb_system and --install-layout deb

Signed-off-by: Shane Loretz <[email protected]>

* Fix comment

Signed-off-by: Shane Loretz <[email protected]>

* Add hardcodes to words

Signed-off-by: Shane Loretz <[email protected]>

* The latter -> which

Signed-off-by: Shane Loretz <[email protected]>

Co-authored-by: Steven! Ragnarök <[email protected]>

* Add install-layout code back to non-symlink install

Signed-off-by: Shane Loretz <[email protected]>

Co-authored-by: Steven! Ragnarök <[email protected]>

Author: sloretz

colcon_core/python_install_path.py

@@ -18,7 +18,9 @@ def get_python_install_path(name, vars_=()):
     """
     kwargs = {}
     kwargs['vars'] = dict(vars_)
+    # Avoid deb_system because it means using --install-layout deb
+    # which ignores --prefix and hardcodes it to /usr
     if 'deb_system' in sysconfig.get_scheme_names():
-        kwargs['scheme'] = 'deb_system'
+        kwargs['scheme'] = 'posix_prefix'
 
     return Path(sysconfig.get_path(name, **kwargs))

colcon_core/task/python/build.py

@@ -110,7 +110,6 @@ async def build(self, *, additional_hooks=None):  # noqa: D102
                 ]
                 if setup_py_data.get('data_files'):
                     cmd += ['install_data', '--install-dir', args.install_base]
-                self._append_install_layout(args, cmd)
                 completed = await run(
                     self.context, cmd, cwd=args.build_base, env=env)
             finally:
@@ -300,5 +299,9 @@ def _get_python_lib(self, args):
         return os.path.relpath(path, start=args.install_base)
 
     def _append_install_layout(self, args, cmd):
+        # Debian patches sysconfig to return a path containing dist-packages
+        # instead of site-packages when using the default install scheme.
+        # TODO(sloretz) this is potentially unused now that
+        # get_python_install_path avoids the deb_system scheme.
         if 'dist-packages' in self._get_python_lib(args):
             cmd += ['--install-layout', 'deb']

test/spell_check.words

@@ -41,6 +41,7 @@ getcategory
 getpid
 getpreferredencoding
 github
+hardcodes
 hookimpl
 hookwrapper
 https
@@ -100,6 +101,7 @@ setupscript
 setuptools
 shlex
 sigint
+sloretz
 stacklevel
 staticmethod
 stdeb