安装paramiko后首次导入失败问题及优化方案咨询

问题描述 #

我需要导入paramiko库，但它并非始终处于已安装状态，于是写了自动安装并导入的代码：

import sys
import subprocess

install_path='./external'
try:
    import paramiko
except:
    sys.path.insert(1, install_path)
    try:
        import paramiko
    except:
        subprocess.run([sys.executable, '-m', 'pip', 'install', 'paramiko', '--target', install_path])
        try:
            import paramiko
        except:
            print(f'Unable to load paramiko')
            exit(-1)

但首次运行时，库已经安装到指定路径，却依然导入失败；第二次运行时，添加路径后就能成功导入。想知道原因，同时找一个不用每次执行pip安装的解决办法。

问题原因 #

这是Python模块导入的缓存机制导致的：

• 第一次import paramiko失败后，Python会把paramiko这个模块名记录到sys.modules字典里，标记为导入失败状态。
• 就算后续通过pip把paramiko安装到了指定路径，并且把路径加入了sys.path，再次执行import paramiko时，Python会直接读取sys.modules里的缓存记录，不会重新去搜索新添加的路径下的模块，所以还是导入失败。
• 第二次运行程序时，进程重新启动，sys.modules缓存被清空，此时install_path已经被加入sys.path，Python能找到刚安装的paramiko，自然导入成功。

解决办法 #

方案1：提前将安装路径加入sys.path（推荐） #

把指定路径的插入操作放到最前面，让Python一开始就搜索这个目录，从根源避免缓存问题：

import sys
import subprocess

install_path = './external'
# 提前加入路径，让Python优先搜索指定目录
sys.path.insert(1, install_path)

try:
    import paramiko
except ImportError:
    # 只有路径里也找不到时才执行安装
    subprocess.run(
        [sys.executable, '-m', 'pip', 'install', 'paramiko', '--target', install_path],
        check=True,
        capture_output=True
    )
    try:
        import paramiko
    except ImportError:
        print('Unable to load paramiko')
        exit(-1)

方案2：安装后清理模块缓存再导入 #

如果必须保持原有的尝试顺序，在安装完成后，手动删除sys.modules里的paramiko失败记录，再重新导入：

import sys
import subprocess

install_path='./external'
try:
    import paramiko
except ImportError:
    sys.path.insert(1, install_path)
    try:
        import paramiko
    except ImportError:
        subprocess.run(
            [sys.executable, '-m', 'pip', 'install', 'paramiko', '--target', install_path],
            check=True,
            capture_output=True
        )
        # 清理缓存的失败记录
        if 'paramiko' in sys.modules:
            del sys.modules['paramiko']
        try:
            import paramiko
        except ImportError:
            print(f'Unable to load paramiko')
            exit(-1)

注意：用except ImportError代替裸except，避免捕获无关异常；subprocess.run加上check=True可以确保安装失败时直接抛出异常，方便排查问题。

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