Source code for spack.modules.tcl

# Copyright 2013-2024 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)

"""This module implements the classes necessary to generate Tcl
non-hierarchical modules.
"""
import os.path
from typing import Dict, Optional, Tuple

import spack.config
import spack.spec
import spack.tengine as tengine

from .common import BaseConfiguration, BaseContext, BaseFileLayout, BaseModuleFileWriter


#: Tcl specific part of the configuration
[docs] def configuration(module_set_name: str) -> dict: return spack.config.get(f"modules:{module_set_name}:tcl", {})
# Caches the configuration {spec_hash: configuration} configuration_registry: Dict[Tuple[str, str, bool], BaseConfiguration] = {}
[docs] def make_configuration( spec: spack.spec.Spec, module_set_name: str, explicit: Optional[bool] = None ) -> BaseConfiguration: """Returns the tcl configuration for spec""" explicit = bool(spec._installed_explicitly()) if explicit is None else explicit key = (spec.dag_hash(), module_set_name, explicit) try: return configuration_registry[key] except KeyError: return configuration_registry.setdefault( key, TclConfiguration(spec, module_set_name, explicit) )
[docs] def make_layout( spec: spack.spec.Spec, module_set_name: str, explicit: Optional[bool] = None ) -> BaseFileLayout: """Returns the layout information for spec""" return TclFileLayout(make_configuration(spec, module_set_name, explicit))
[docs] def make_context( spec: spack.spec.Spec, module_set_name: str, explicit: Optional[bool] = None ) -> BaseContext: """Returns the context information for spec""" return TclContext(make_configuration(spec, module_set_name, explicit))
[docs] class TclConfiguration(BaseConfiguration): """Configuration class for tcl module files."""
[docs] class TclFileLayout(BaseFileLayout): """File layout for tcl module files.""" @property def modulerc(self): """Returns the modulerc file associated with current module file""" return os.path.join(os.path.dirname(self.filename), ".modulerc")
[docs] class TclContext(BaseContext): """Context class for tcl module files.""" @tengine.context_property def prerequisites(self): """List of modules that needs to be loaded automatically.""" return self._create_module_list_of("specs_to_prereq")
[docs] class TclModulefileWriter(BaseModuleFileWriter): """Writer class for tcl module files.""" default_template = "modules/modulefile.tcl" modulerc_header = ["#%Module4.7"] hide_cmd_format = "module-hide --soft --hidden-loaded %s"