summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTodd Gamblin <tgamblin@llnl.gov>2023-12-21 16:25:12 -0800
committerGitHub <noreply@github.com>2023-12-21 16:25:12 -0800
commit0da1fae709cda5f224f166b2048d642914cb6e9c (patch)
tree314d445bcdf6c8129ad30899cdfbebcfa2ecf6d2
parent94fc2314f163b1f8dcdf072c4b66afccff9c83b4 (diff)
downloadspack-0da1fae709cda5f224f166b2048d642914cb6e9c.tar.gz
spack-0da1fae709cda5f224f166b2048d642914cb6e9c.tar.bz2
spack-0da1fae709cda5f224f166b2048d642914cb6e9c.tar.xz
spack-0da1fae709cda5f224f166b2048d642914cb6e9c.zip
Consolidate definition of Spack's extra `sys.path` components (#41816)
To work properly, Spack requires a few directories from its repository to be added to `sys.path`. Previously these were buried in `spack_installable.main.main()`, but it's sometimes useful to get the paths separately, e.g., if you want to set up your own functioning spack environment. With this change, adding the paths is much simpler: ```python import spack_installable sys.path[:0] = get_spack_sys_paths(spack_prefix) ``` - [x] Add `get_spack_sys_paths()` method with extra paths in order. - [x] Refactor `spack_installable.main.main()` to use it.
-rw-r--r--lib/spack/spack_installable/main.py19
1 files changed, 12 insertions, 7 deletions
diff --git a/lib/spack/spack_installable/main.py b/lib/spack/spack_installable/main.py
index af4355f69b..8932d1797e 100644
--- a/lib/spack/spack_installable/main.py
+++ b/lib/spack/spack_installable/main.py
@@ -7,19 +7,24 @@ import sys
from os.path import dirname as dn
+def get_spack_sys_paths(spack_prefix):
+ """Given a spack prefix, return all the paths Spack needs to function."""
+ spack_libs = os.path.join(spack_prefix, "lib", "spack")
+ external_libs = os.path.join(spack_libs, "external")
+ vendored_libs = os.path.join(external_libs, "_vendoring")
+
+ # spack externals take precedence, then vendored packages, then spack itself
+ return [external_libs, vendored_libs, spack_libs]
+
+
def main(argv=None):
# Find spack's location and its prefix.
this_file = os.path.realpath(os.path.expanduser(__file__))
spack_prefix = dn(dn(dn(dn(this_file))))
- # Allow spack libs to be imported in our scripts
- spack_lib_path = os.path.join(spack_prefix, "lib", "spack")
- sys.path.insert(0, spack_lib_path)
+ # Add all the sys paths that allow spack libs to be imported
+ sys.path[:0] = get_spack_sys_paths(spack_prefix)
- # Add external libs
- spack_external_libs = os.path.join(spack_lib_path, "external")
- sys.path.insert(0, os.path.join(spack_external_libs, "_vendoring"))
- sys.path.insert(0, spack_external_libs)
# Here we delete ruamel.yaml in case it has been already imported from site
# (see #9206 for a broader description of the issue).
#