c语言编程笔录

首页 >   > 笔记大全

笔记大全

Python中py文件里的name main有什么用

更新时间：2023-10-31

Python中py文件里的name + 'main'有什么用

在Python代码中，可以看到某些py文件的代码可能会包含if __name__=='__main__':，这是一个很常见的语句，本文将为你详细介绍这个语句的作用。

第一段：__name__变量

在理解if __name__=='__main__':语句之前，我们需要先理解__name__变量的概念。__name__是一个内置变量，它用于表示当前模块的名称。当我们在终端中运行一个Python文件时，Python会为该文件生成一个具有__name__值的模块对象，这个值通常就是文件名去掉.py扩展名后的字符串。例如，我们有一个文件名为example.py，那么生成的模块对象__name__值就是'example'。

举个例子：

      # example.py
      print(__name__)
      
      # 在终端中执行命令：python example.py
      # 输出结果为：'__main__'

上述代码中，我们输出了__name__的值，由于我们是从终端中运行example.py文件的，所以当前模块对象的__name__值为'__main__'。

第二段：if __name__=='__main__'语句的作用

if __name__=='__main__':语句通常被用于判断当前模块对象是否为主模块（main module），也就是判断当前代码是否为我们想要直接运行的代码。主模块是指我们在终端中直接运行执行的代码。举个例子，我们有一个文件名为example.py，该文件包含函数sum函数如下：

      # example.py
      def sum(a, b):
          return a + b

如果我们想在另一个文件中使用sum函数，可以通过import导入该函数：

      # main.py
      from example import sum
      
      result=sum(1, 2)
      print(result)

在上述代码中，我们从example模块中导入sum函数，并在main.py中调用了该函数，输出了结果3。

然而，当我们直接运行example.py文件时，我们却输出了一个没有用的结果。这时，就需要使用if __name__=='__main__':语句来判断当前代码是否为主模块，将所有需要输出的代码都放在if语句中，避免无用输出的出现：

      # example.py
      def sum(a, b):
          return a + b
      
      if __name__=='__main__':
          result=sum(1, 2)
          print(result)
      
      # 在终端中执行命令：python example.py
      # 输出结果为：3

上述代码中，我们将调用sum函数的代码放在了if __name__=='__main__':语句中，当文件作为主模块运行时，才会输出结果3。

第三段：多文件运行中if __name__=='__main__':的使用

当一个Python项目包含多个文件时，我们如果从终端中直接运行项目中的某个文件，该文件中的if __name__=='__main__':语句只会判断该文件是否为主模块，不会判断其他文件是否已经被导入。这在某些情况下可能会引起一些问题。例如，我们有一个文件名为example.py，另一个文件名为helper.py，其中helper.py文件导入了example.py文件中的函数，如下所示：

      # example.py
      def sum(a, b):
          return a + b
      
      # helper.py
      from example import sum
      
      print(sum(1, 2))

当我们从终端中直接运行helper.py文件时，我们会发现会输出一个结果3。但是如果我们将example.py文件作为主模块来运行，运行的结果却是2，因为在执行helper.py文件时，它导入了example这个模块，此时example.py文件就不再是主模块，if __name__=='__main__':语句中的代码就不会被执行。要解决这个问题，可以在example.py文件中使用if __name__=='__main__':语句作为测试代码，然后将功能代码放到函数中：

      # example.py
      def sum(a, b):
          return a + b
      
      if __name__=='__main__':
          result=sum(1, 2)
          print(result)
      
      # helper.py
      from example import sum
      
      result=sum(1, 2)
      print(result)

这样，在helper.py文件中导入example模块时，只会运行example.py文件中的sum函数，不会输出无用的结果。

第四段：总结

if __name__=='__main__':语句在Python中是非常重要的语句，它可以帮助我们判断当前代码是否为主模块，并且在多文件导入时保证代码的正常运行。为了更好的规范代码，我们应该将测试代码放到if语句中，保留主模块的代码。这样，不管我们是从终端中运行代码，还是从其他文件中导入代码，都能保证代码的正常运行。希望本文能对大家有所帮助。

图文推荐