关于调整虚拟环境下sys.path的相关经验

问题引入

bug是在我想要在虚拟环境中使用tensorboard绘制训练损失图的时候，报错。报错信息为：TensorBoard logging requires TensorBoard version 1.15 or above.

根据这条报错信息，大概了解到应该是环境中tensorboard版本太低的缘故，遂
conda install tensorboard
还是报错，百度后继续安装
conda install tb-nightly
还是报错，继续安装
conda install tensorboardx
还是报错…

通过conda list可以看到， tensorboard的版本已经是2.X了，根本满足了1.15以上的要求，仔细看下报错信息中包的引入位置，是在非虚拟环境即源环境下的。

python中包的引入

几经查询后，了解到python中包的引入是按照 sys.path 的list顺序进行的，而对应虚拟环境下进行

import sys
print(sys.path)

也确实可以看到，源环境下的site-package 是在虚拟环境的site-package前面的。

调整 对应虚拟环境下的sys.path

命令行中执行

python -m site

可以看到sys.path 的详细信息

通过命令python -m site -help可以看到site.py的路径，进入到site.py，发现下列函数会根据系统路径和python版本自动获取一个路径–USER_SITE，如果USER_SITE真实存在，就加到sys.path中。

def _getuserbase():
    env_base = os.environ.get("PYTHONUSERBASE", None)
    if env_base:
        return env_base

    def joinuser(*args):
        return os.path.expanduser(os.path.join(*args))

    if os.name == "nt":
        base = os.environ.get("APPDATA") or "~"
        return joinuser(base, "Python")

    if sys.platform == "darwin" and sys._framework:
        return joinuser("~", "Library", sys._framework,
                        "%d.%d" % sys.version_info[:2])

    return joinuser("~", ".local")

而注意到 site.py 文件中有一个全局变量

ENABLE_USER_SITE = None

初始化设置为None，修改为False就好啦。