使用environment modules在bash中覆盖并恢复环境变量的方法

问题根因 #

你写的模块逻辑失效的核心原因是，Environment Modules执行unload操作时会重新解析整个模块文件，load阶段创建的Tcl临时变量不会被保留，部分旧版本的Modules在unload阶段读取环境变量时，会优先读取模块初始加载前的上下文快照，而非当前用户shell的实际环境值，导致你存入ORIGINAL_FOO的取值为空。

可行方案 #

方案1：使用内置自动恢复（推荐，兼容Modules 3.2.10及以上版本） #

Environment Modules的setenv命令本身自带原始值追踪能力，不需要手动编写条件判断逻辑，卸载模块时会自动恢复变量的初始值，直接简化模块文件为以下内容即可：

#%Module########################################################################
##
## test modulefile
##
proc ModulesHelp { } {
  puts stderr "This module modifies an environment variable FOO."
}

module-whatis "Modify environment variable FOO"

setenv FOO "123"

方案2：手动兼容旧版本Modules #

如果你使用的是更老版本的Modules，需要手动处理恢复逻辑，可以用以下写法，兼容变量初始存在/不存在两种场景：

#%Module########################################################################
##
## test modulefile
##
proc ModulesHelp { } {
  puts stderr "This module modifies an environment variable FOO."
}

module-whatis "Modify environment variable FOO"

if { [module-info mode load] } {
  # 保存原始值，优先存入模块内部变量，同时写入环境变量避免unload阶段丢失
  if { [info exists ::env(FOO)] } {
    variable ORIGINAL_FOO $::env(FOO)
    setenv ORIGINAL_FOO $::env(FOO)
  }
  setenv FOO "123"
} elseif { [module-info mode unload] } {
  # 恢复逻辑，先判断原始值是否存在
  if { [info exists ::env(ORIGINAL_FOO)] } {
    setenv FOO $::env(ORIGINAL_FOO)
    unsetenv ORIGINAL_FOO
  } else {
    # 初始不存在FOO的场景直接移除变量
    unsetenv FOO
  }
}

测试验证 #

使用上述任意一种方案后，运行效果如下：

$ export FOO=bar
$ module load use.own && module load test
$ echo $FOO
123
$ module unload test
$ echo $FOO
bar

内容的提问来源于stack exchange，提问作者gkaf