Mastering Python’s __name__ and __main__: Understanding Script Execution and Module Imports

介绍

python 的 name 和 main 是两个经常被误解的概念，它们在脚本的执行方式和模块的导入方式中发挥着至关重要的作用。在这篇文章中，我们将详细解释 name 和 main 的实际含义、它们为何如此重要，以及如何利用它们来编写更加模块化、可测试和可重用的代码。最后，您将熟悉这个基本概念，并准备好使用它来有效地构建您自己的项目。

终极 python 程序员实践测试

名字是什么？

在 python 中，每个模块（python 文件）都有一个名为 name 的内置属性。此属性帮助 python 确定文件的使用方式：作为独立脚本或作为导入模块。

• 直接运行 python 文件（如 python my_script.py）时，name 变量会自动设置为 main.

• 如果文件在另一个脚本中作为模块导入，则 name 设置为模块的名称（不带 .py 扩展名的文件名）。
  这种区别非常有用，因为它允许您控制文件导入时和直接执行时应运行文件的哪些部分。

if name == "main" 的力量

为了利用此功能，python 开发人员通常使用 if 语句来检查 name 的值。这使您可以控制代码的哪些部分仅在文件作为独立脚本运行时才执行。

这是基本结构：

def main():
    print("running as a standalone script")

if __name__ == "__main__":
    main()

在此示例中，如果运行 python my_script.py，它将打印“作为独立脚本运行”，因为 name 设置为 main。但是，如果您将此文件作为模块导入（例如导入 my_script），则不会打印任何内容，因为不满足 if 条件。

为什么使用这种模式？

if name == "main" 模式有几个主要优点：

1. 组织代码以实现可重用性：您可以将函数、类或常量放入模块中，并在其他脚本中使用它们，而无需运行不必要的代码。
2. 支持单元测试：无需执行不相关的代码即可更轻松地测试模块。
3. 更好的代码结构：将执行代码与定义（函数、类）分开，提高了可读性和模块化性。

实际用例

1. 使用可重用代码编写独立脚本
   如果您正在开发一个既具有独立功能又具有对其他脚本有用的部分的工具，那么这种模式至关重要。例如，数据处理脚本可能包含用于数据清理的可重用函数，您也希望将其导入到另一个数据分析脚本中。

2. 构建 cli（命令行界面）工具
   这种模式在构建 cli 工具时特别有用。通过定义作为入口点的 main() 函数，您可以使代码更干净、更结构化。
   

# cli_tool.py
import argparse

def main():
    parser = argparse.ArgumentParser(description="A CLI tool example")
    parser.add_argument("name", type=str, help="Your name")
    args = parser.parse_args()
    print(f"Hello, {args.name}!")

if __name__ == "__main__":
    main()

现在你可以使用 python cli_tool.py john 从命令行运行这个工具，它会用“hello, john!”向用户打招呼。如果需要，该脚本还可以作为其他 python 程序中的模块导入。

理解 name 和 main 允许您创建模块化、可重用的 python 代码。通过在脚本中使用 if name == "main"，您可以根据脚本的运行方式来控制应执行代码的哪些部分。这种模式对于编写可测试的、有组织的和通用的代码至关重要，无论是一次性脚本还是计划在项目中重用的模块。

终极 python 程序员实践测试

以上就是Mastering Python’s __name__ and __main__: Understanding Script Execution and Module Imports的详细内容，更多请关注其它相关文章！