Python部落(python.freelycode.com)组织翻译,禁止转载,欢迎转发。
创建名为main()的函数来包含要运行的代码
现在,您可以编写作为脚本由从命令行执行并导入且没有副作用的Python代码。接下来,您将学习如何编写代码并使其他程序员能轻松地理解其含义。
许多语言,如C,C++,Java以及其他的一些语言,都会定义一个叫做main()的函数,当编译程序时,操作系统会自动调用该函数。此函数通常被称为入口点(entry point),因为它是程序进入执行的起始位置。
相比之下,Python没有一个特殊的函数作为脚本的入口点。实际上在Python中可以将入口点定义成任何名称。
尽管Python不要求将函数命名为main(),但是最佳的做法是将入口点函数命名为main()。这样方便其他程序员定位程序的起点。
此外,main()函数应该包含Python解释器执行文件时要运行的任何代码。这比将代码放入条件语块中更好,因为用户可以在导入模块时重复使用main()函数。
修改best_practices.py文件如下所示:
在这个示例中,定义了一个main()函数,它包含了上面的条件语句块。之后修改条件语块执行main()。如果您将此代码作为脚本运行或导入,将获得与上一节相同的输出。
在main()中调用其他函数
另一种常见的实现方式是在main()中调用其他函数,而不是直接将代码写入main()。这样做的好处在于可以实现将几个独立运行的子任务整合。
例如,某个脚本有如下功能:从数据源如数据库,文件,硬盘或web API读取数据。
处理数据。
将处理后的数据写入另一个位置。
如果在单独的函数中各自实现这些子任务,您(或其他用户)可以很容易地实现代码重用。之后您可以在main()函数中创建默认的工作流。
您可以根据自己的情况选择是否使用此方案。将任务拆分为多个函数会使重用更容易,但会增加他人理解代码的难度。
修改best_practices.py文件如下所示:
在此示例代码中,文件的前10行具有与之前相同的内容。第12行的第二个函数创建并返回一些示例数据,第17行的第三个函数模拟将修改后的数据写入数据库。
第21行定义了main()函数。在此示例中,对main()做出修改,它将调用数据读取,数据处理以及数据写入等功能。
首先,从read_data_from_web()中创建data。将data作为参数传入process_data(),之后将返回modified_data。最后,将modified_data传入write_data_to_database()。
脚本的最后两行是条件语块用于验证__name__,并且如果if语句为True,则执行main()。
在命令行中运行如下所示:
根据执行结果,Python解释器在执行main()函数时,将依次执行read_data_from_web(),process_data()以及write_data_to_database()。当然,您也可以导入best_practices.py文件并重用process_data()作为不同的数据输入源,如下所示:
在此示例中,导入了best_practices并且将其简写为bp。
导入过程会导致Python解释器执行best_practices.py的全部代码,因此输出显示解释文件用途的信息。
然后,从文件中存储数据而不是从Web中读取数据。之后,可以重用best_practices.py文件中的process_data()和write_data_to_database()函数。在此情况下,可以利用代码重写来取代在main()函数中实现全部的代码逻辑。
实践总结
以下是Python中main()函数的四个关键最佳实践:将计算时间过长或对计算机产生其他影响的代码写入函数或类,这样可以精确地控制代码的运行时间。
使用不同的__name__值来确定上下文并使用条件语句更改代码的行为。
将入口点函数命名为main(),以便传达函数的意图,即使Python对名为main()的函数并没有赋予特殊的含义。
如果想代码重用,请在main()外定义函数,并在main()中对其进行调用。
结论
恭喜!您现在已经了解如何创建Python main()函数了。
本文介绍了如下内容:了解__name__变量的值对于编写用于可执行脚本和导入模块的双重用途的代码的重要性。
根据执行Python文件的方式,__name__具有不同的值。__name__的取值有以下几种情况:当从命令行执行文件或用python -m(执行某个包的__main__.py文件)时,值为"__main__"。
如果作为模块被导入时,值为模块的名称。
对于开发可重用的代码,Python程序员已经提供了一套良好的方案。
现在,您可以开始编写一些非常棒的关于Python main()函数代码啦!
英文原文:https://realpython.com/python-main-function/
译者:我是昵称耶~