为什么 Python 在导入模块时运行它？如何停止它？

Question

我正在构建一个 Python 程序，可以通过两种方式运行：第一种是调用 python main.py，它会以友好的方式提示用户输入，然后运行用户通过程序输入。另一种方法是调用 python batch.py​​ -file- ，它将传递所有友好的输入收集，并通过程序在单个文件中运行整个文件的输入。去。

问题是，当我运行 batch.py​​ 时，它从 main.py 导入一些变量/方法/等，当它运行此代码

import main

时 ：程序立即出错，因为它尝试运行 main.py 中的代码。

如何阻止 Python 运行我正在导入的 main 模块中包含的代码？

Answer 1

因为这就是 Python 的工作方式 - 诸如 class 和 def 之类的关键字不是声明。相反，它们是被执行的实时语句。如果它们没有被执行，你的模块将是空的。

惯用的方法是：

# stuff to run always here such as class/def
def main():
    pass

if __name__ == "__main__":
   # stuff only to run when not called via 'import' here
   main()

Answer 2

由于 Python 的工作方式，它有必要在导入模块时运行它们。

要防止模块中的代码在导入时执行，但仅在直接运行时执行，您可以使用此 if 来保护它：

if __name__ == "__main__":
    # this won't be run when imported

您可能希望将此代码放在 main() 方法，这样您可以直接执行文件，也可以导入模块并调用 main()。例如，假设它位于文件 foo.py 中。

def main():
    print "Hello World"

if __name__ == "__main__":
    main()

该程序可以通过 python foo.py 运行，也可以从另一个 Python 脚本运行：

import foo

...

foo.main()

Answer 3

使用 if __name__ == '__main__' 习惯用法 -- __name__ 是一个特殊变量，如果模块正在运行，其值为 '__main__'作为脚本，以及模块名称（如果导入）。所以你会做类似的事情

# imports
# class/function definitions
if __name__ == '__main__':
    # code here will only run when you invoke 'python main.py'

Answer 4

不幸的是，你没有。这是导入语法工作原理的一部分，这样做很重要——记住 def 实际上是执行的东西，如果 Python 没有执行导入，你就会被困住，没有功能。

不过，由于您可能有权访问该文件，因此您也许可以查看导致错误的原因。可以修改您的环境来防止错误发生。

Answer 5

有一个 Python 增强提案 PEP 299 旨在替换 if __name__ == '__main__': 成语与 def __main__:，但被拒绝了。了解使用 if __name__ = '__main__': 时要记住的内容仍然是一本好书。

Answer 6

将代码放入函数中，直到调用该函数后它才会运行。您的 main.py 中应该有一个 main 函数。语句：

if __name__ == '__main__':
  main()

然后，如果您调用 python main.py，则 main() 函数将运行。如果您导入 main.py，则不会。另外，为了清楚起见，您可能应该将 main.py 重命名为其他名称。

Answer 7

我做了一个简单的测试：

#test.py

x = 1
print("1, has it been executed?")


def t1():
     print("hello")
     print("2, has it been executed?")


def t2():
     print("world")
     print("3, has it been executed?")


def main():
     print("Hello World")
     print("4, has it been executed?")


print("5, has it been executed?")
print(x)

# while True:
# t2()

if x == 1:
     print("6, has it been executed?")

#test2.py

import test

执行或运行test2.py时，运行结果：

1, has it been executed?

5, has it been executed?

1

6, has it been executed?

结论：导入模块时不添加if __name__ ==“__main__”：，运行当前模块，导入模块中不在函数中的代码依次执行，不在函数中的代码则不执行叫。

此外：

def main():
    # Put all your code you need to execute directly when this script run directly.
    pass

if __name__ == '__main__':
    main() 
else:
    # Put functions you need to be executed only whenever imported

Answer 8

你可以这样写你的“main.py”：

#!/usr/bin/env python

__all__=["somevar", "do_something"]

somevar=""

def do_something():
    pass #blahblah

if __name__=="__main__":
    do_something()

Answer 9

可能发生的一个小错误（至少发生在我身上），特别是在分发执行完整分析的 python 脚本/函数时，是直接在函数 .py 文件末尾调用该函数。
用户唯一需要修改的是输入文件和参数。
导入时这样做，您将立即运行该函数。为了正确的行为，您只需删除对函数的内部调用并将其保留给真正的调用文件/函数/代码部分

Answer 10

另一种选择是使用二进制环境变量，例如我们将其称为“run_code”。如果run_code = 0（False）构造main.py来绕过代码（但暂时绕过的函数仍会作为模块导入）。稍后，当您准备使用导入的函数（现在是一个模块）时，设置环境变量 run_code = 1 (True)。使用 os.environ 命令设置和检索二进制变量，但请确保在检索时将其转换为整数（或重构 if 语句以读取字符串值），

在 main.py 中：

import os

#set environment variable to 0 (False):
os.environ['run_code'] = '0'


def binary_module():
    #retrieve environment variable, convert to integer
    run_code_val = int(os.environ['run_code'] )
    
    if run_code_val  == 0:
        print('nope. not doing it.')
    if run_code_val == 1:
        print('executing code...')
        # [do something]

...在任何脚本中加载 main.py：

import os,main

main.binary_module() 

输出：不。不做。

# now flip the on switch!
os.environ['run_code'] = '1'
main.binary_module()

输出：执行代码...

*注意：上面的代码假定 main.py 以及导入它的任何脚本都存在于同一目录中。

Answer 11

虽然你不能在不运行代码的情况下使用import；有一种非常快捷的方法可以输入变量；通过使用 numpy.savez，它将变量作为 numpy 数组存储在 .npz 文件中。之后，您可以使用 numpy.load 加载变量。

请参阅 scipy 文档中的完整说明

请注意这一点仅适用于变量和变量数组，不适用于方法等。

Answer 12

尝试从 main.py 导入所需的函数？因此，

from main import SomeFunction

可能您在batch.py​​中为一个函数命名为与main.py中的函数相同，并且当您导入main.py时，程序运行main.py函数而不是batch.py​​函数；执行上述操作应该可以解决这个问题。我希望。