如何检查 Python 中模块是否已导入

简介

在这个实验中，你将学习如何检查 Python 中是否导入了某个模块。本实验涵盖了模块导入的基础知识，包括创建和导入一个简单的模块。你将学习如何使用 import 语句将模块引入你的程序，并访问它们的函数和变量。

然后，本实验将探讨 sys.modules 字典，它存储了当前 Python 会话中所有已导入的模块。你还将学习如何使用 importlib 模块来验证某个模块是否已被导入。

Skills Graph

了解模块导入

在这一步中，你将了解 Python 中的模块导入。模块是包含 Python 定义和语句的文件。import 语句用于将模块引入你当前的程序，使你能够使用其中定义的函数和变量。

首先，让我们创建一个简单的模块。在 LabEx 环境中打开 VS Code 编辑器，并在 ~/project 目录下创建一个名为 my_module.py 的新文件。

## ~/project/my_module.py
def greet(name):
    return f"Hello, {name}!"

PI = 3.14159

这个模块定义了一个函数 greet 和一个变量 PI。现在，让我们创建另一个 Python 文件来导入并使用这个模块。在 ~/project 目录下创建一个名为 main.py 的新文件。

## ~/project/main.py
import my_module

name = "LabEx User"
greeting = my_module.greet(name)
print(greeting)
print("PI =", my_module.PI)

在这个 main.py 文件中，我们使用 import my_module 语句引入了我们之前创建的 my_module。然后，我们使用点号表示法 (my_module.greet, my_module.PI) 来访问 greet 函数和 PI 变量。

要运行这段代码，请在 LabEx 环境中打开一个终端（它应该已经在 VS Code 的底部面板中打开）。确保你当前的目录是 ~/project。如果不是，请使用 cd 命令导航到该目录：

cd ~/project

现在，使用 python 命令执行 main.py 脚本：

python main.py

你应该会看到以下输出：

Hello, LabEx User!
PI = 3.14159

这展示了如何导入一个模块并在另一个 Python 文件中使用其内容。

检查 sys.modules 字典

在这一步中，你将探索 sys.modules 字典，它是 Python 模块导入系统的重要组成部分。sys.modules 是一个字典，它保存了当前 Python 会话中已导入的所有模块。了解这个字典有助于你理解 Python 是如何管理模块的。

首先，让我们在 ~/project 目录下创建一个名为 check_modules.py 的 Python 脚本。这个脚本将导入 sys 模块并打印 sys.modules 字典的键。

## ~/project/check_modules.py
import sys

print("Modules currently in sys.modules:")
for module_name in sys.modules.keys():
    print(module_name)

import my_module

print("\nModules after importing my_module:")
for module_name in sys.modules.keys():
    print(module_name)

这个脚本首先导入 sys 模块，然后遍历 sys.modules 字典的键并打印每个模块名。之后，它导入上一步创建的 my_module，并再次打印 sys.modules 字典，以显示新导入的模块。

现在，在终端中使用 python 命令运行该脚本：

cd ~/project
python check_modules.py

你会看到 Python 解释器启动时已经加载的模块列表，接着是在执行 import my_module 语句后添加了 my_module 的相同列表。输出大致如下（具体的模块列表可能会有所不同）：

Modules currently in sys.modules:
builtins
sys
_frozen_importlib
_imp
_warnings
_io
... (many more modules)

Modules after importing my_module:
builtins
sys
_frozen_importlib
_imp
_warnings
_io
... (many more modules)
my_module

注意，在 import 语句执行后，my_module 被添加到了 sys.modules 字典中。这个字典起到了缓存的作用，因此如果你尝试再次导入同一个模块，Python 会直接从 sys.modules 中获取它，而不是从磁盘重新加载。这种优化提高了性能。

使用 importlib 进行验证

在这一步中，你将学习如何使用 importlib 模块以编程方式导入模块并验证其是否存在。importlib 是 Python 标准库的一部分，它提供了一种与导入系统进行交互的方式。

让我们在 ~/project 目录下创建一个名为 verify_import.py 的 Python 脚本。这个脚本将使用 importlib 来导入 my_module 并检查它是否成功导入。

## ~/project/verify_import.py
import importlib

module_name = "my_module"

try:
    module = importlib.import_module(module_name)
    print(f"Module '{module_name}' imported successfully.")
    print(f"Greeting: {module.greet('LabEx')}")
except ImportError:
    print(f"Failed to import module '{module_name}'.")

在这个脚本中，我们使用 importlib.import_module() 来导入 my_module。如果找到了该模块并成功导入，脚本会打印一条成功消息，并调用该模块中的 greet 函数。如果未找到该模块，则会引发 ImportError，脚本会打印一条错误消息。

现在，在终端中使用 python 命令运行该脚本：

cd ~/project
python verify_import.py

你应该会看到以下输出：

Module 'my_module' imported successfully.
Greeting: Hello, LabEx!

如果你将 module_name 更改为一个不存在的模块，例如 "nonexistent_module"，然后再次运行脚本，你会看到：

Failed to import module 'nonexistent_module'.

这展示了如何使用 importlib 动态导入模块并处理可能的导入错误。在你需要根据用户输入或配置文件加载模块的情况下，这尤其有用。

总结

在这个实验中，你学习了 Python 中的模块导入。你创建了一个名为 my_module.py 的模块，其中包含一个 greet 函数和一个 PI 变量。然后，你创建了 main.py 来导入 my_module 并使用其内容，展示了 import 语句如何将模块引入你的程序，以及如何使用点号表示法访问模块内的函数和变量。

你还开始探索了 sys.modules 字典，它保存了当前 Python 会话中已导入的所有模块，这是 Python 模块导入系统的重要组成部分。