“样板” Python 代码？

Question

Google 有一个 Python 教程，他们将样板代码描述为“不幸的”，并提供了以下示例：

#!/usr/bin/python

# import modules used here -- sys is a very standard one
import sys

# Gather our code in a main() function
def main():
  print 'Hello there', sys.argv[1]
  # Command line args are in sys.argv[1], sys.argv[2] ..
  # sys.argv[0] is the script name itself and can be ignored

# Standard boilerplate to call the main() function to begin
# the program.
if __name__ == '__main__':
  main()

现在，我听说样板代码被描述为“看似重复的代码，一次又一次地出现，以获得一些看起来像的结果”它应该更简单”（示例）。

无论如何，在 Python 中，上面示例中被视为“样板”代码的部分是：

if __name__ == '__main__':
  main()

现在，我的问题如下：

1）Python 中的样板代码（如提供的示例）是否采用与我提供的定义相同的定义？如果是这样，为什么？

2）这段代码有必要吗？在我看来，无论是否有 main 方法，代码都会运行。是什么让使用此代码更好？是不是更好了？

3）我们为什么使用该代码以及它提供什么服务？

4）整个Python都会出现这种情况吗？还有“样板代码”的其他示例吗？

哦，还有一个题外话：你需要 import sys 才能在 Python 中使用命令行参数吗？如果它不存在，它如何处理此类争论？

Answer 1

1. 它是重复的，因为它会针对您可能从命令行执行的每个脚本重复。
2. 如果将主代码放在这样的函数中，则可以导入模块而不执行它。这有时很有用。它还可以让事情变得更有条理。
3. 据我所知，与 #2 相同，
4. Python 通常非常擅长避免样板文件。它足够灵活，在大多数情况下您可以编写代码来生成样板文件，而不是编写样板代码。

题外话：

如果您不编写代码来检查参数，它们将被忽略。

Answer 2

在本例中，if __name__ == "__main__": 块被称为样板文件的原因是它复制了许多其他语言中自动执行的功能。在 Java 或 C++ 等许多其他语言中，当您运行代码时，它会查找 main() 方法并运行它，如果它不存在，甚至会抱怨。 Python 运行文件中的任何代码，因此您需要告诉它运行 main() 方法；一个简单的替代方案是将运行 main() 方法设置为默认功能。

因此， if __name__ == "__main__": 是一种常见的模式，可以更短。您没有理由不能做一些不同的事情，例如：

if __name__ == "__main__":
  print "Hello, Stack Overflow!"

  for i in range(3):
    print i

  exit(0)

这会很好；虽然我的例子有点傻，但你可以看到你可以在那里放任何你喜欢的东西。 Python 设计者选择这种行为而不是自动运行 main() 方法（该方法很可能不存在），大概是因为 Python 是一种“脚本”语言；因此您可以将一些命令直接写入文件中，运行它，然后执行您的命令。我个人更喜欢 Python 方式，因为它让初学者更容易开始使用 Python，而且拥有一种 Hello World 一行的语言总是很好。

Answer 3

您不需要为不打算成为较大项目一部分的一次性脚本添加 if __name__ == '__main__'。请参阅此处了解详细说明。仅当您想单独运行该文件并将其作为模块与其他 python 文件一起包含时才需要它。

如果您只想运行一个文件，则可以使用零样板：

print(1)

并使用 $ python your_file.py

添加shebang 行 #!/usr/bin/python 并运行 chmod +x print_one.py 让您能够使用

./print_one 运行.py

Answer 4

使用“if main”检查的原因是，您可以拥有一个在顶层运行其代码的某些部分的模块（以创建它导出的东西 - 常量、函数或类），而某些部分仅在执行时脚本（例如其功能的单元测试）。

后面的代码应该包装在函数中的原因是因为 main() 块的局部变量会泄漏到模块的作用域中。

现在，另一种设计可能是，作为脚本执行的文件必须声明一个名为 __main__() 的函数，但这意味着向该语言添加一个新的魔术函数名称，而__name__ 机制已经存在。 （并且无法删除，因为每个模块都必须有一个 __name__，并且由于模块名称的分配方式，作为脚本执行的模块必须有一个“特殊”名称。）引入两个做同样的事情只是为了摆脱两行样板的机制 - 通常每个应用程序有两行样板 - 似乎不值得。

Answer 5

我来到此页面的主要原因是一个与您的问题 #3 类似的问题：

我们为什么使用该代码以及它提供什么服务？

我阅读了这些解释，但仍然无法理解这个概念，尽管答案非常详细。在阅读这些解释后，我不得不弄乱一个小例子才能真正理解发生了什么。

这对我来说最终有意义：

# code that runs regardless if it's ran 
# by itself or if it's imported 

if __name__ == "__main__":
    # code that runs only if this file is ran by itself

希望这对某人有帮助

Answer 6

1) 主样板很常见，但不能再简单了

2) 如果没有样板，则不会调用 main()

3) 样板允许模块作为独立脚本使用，和 作为其他程序中的库

4) 它很常见。 doctest 是另一个。

训练成为 Python 大师……祝论文好运！ ;-)

Answer 7

让我们花点时间看看调用 import sys 时发生了什么：

• Python 查看列表并引入 sys 模块，
• 它找到 argv函数并运行它

那么，这里发生了什么？

在其他地方编写的函数用于在当前程序范围内执行某些操作。以这种方式编程有很多好处。它将逻辑与实际劳动分开。

现在，就样板而言，有两个部分：

• 程序本身（逻辑），在 main 下定义，以及
• 检查 main 是否存在的调用部分

您本质上是在 main 下编写程序，使用在定义 main （或其他地方）之前定义的所有函数，并让 Python 查找 main 。

Answer 8

我同样对教程中“样板代码”的含义感到困惑：这是否意味着可以在简单的脚本中避免此代码？或者是对强制使用这种语法的Python特性的批评？或者甚至邀请使用这个“样板”代码？

然而，我不知道，经过多年的 Python 编程，我至少清楚了不同语法的作用，即使我可能仍然不确定最好的方法是什么。

通常，您希望在脚本代码的末尾放置用于测试的代码或想要执行的代码，但这会产生一些影响/副作用：

1. 即使导入脚本，代码也会执行，但很少是需要的。
2. 代码中的变量和值在调用命名空间中定义和导出。
3. 脚本末尾的代码可以通过调用脚本（python script.py）或从 ipython shell 运行（< code>%run script.py)，但无法从其他脚本运行它。

避免在所有情况下执行以下代码的最基本机制是语法：

if __name__ == '__main__':

它使代码仅在脚本被调用或运行时才运行，避免了问题 1。另外两点仍然成立。

具有单独的 main() 函数的“样板”代码添加了进一步的步骤，也排除了上述第 2 点和第 3 点，因此，例如，您可以从不同的脚本调用多个测试，有时可以采取另一个级别（例如：多个函数，每个测试一个，因此可以从外部单独调用它们，以及调用所有测试函数的主函数，而不需要从外部知道它们是哪一个）。

我补充说，除了其复杂性之外，我发现这种结构常常令人不满意的主要原因是，有时我想保留第 2 点，但如果将代码移至单独的函数，我就会失去这种可能性。