python - 对 python 脚本文件的说明

Question

只需要一些关于如何设计 python 脚本文件 test.py 的说明。

1. 定义函数时，它们是否必须在导入之后立即位于文件顶部？

2. 我应该在我的文件中进行主要检查吗？

3. 我想在我的服务器上作为 cron 作业运行此文件。如果文件变得太大(其中也有我的 sqlalchemy 定义)，如何将文件分成多个文件？我希望通过将文件放入我的服务器中的文件夹中来轻松部署。

Answer 1

大多数脚本如下所示:

import module1
import module2

CONSTANT=...

def foo():
   ...

def bar():
   ....

class Baz():
   ....

def run(verbose=False):
    ....

if __name__=='__main__':
    import optparse
    def parse_options():
        usage = 'usage: %prog [options]'
        parser = optparse.OptionParser(usage=usage)
        parser.add_option('-v', '--verbose', dest='verbose',
                          action='store_true', 
                          default=False,
                          help="verbose")
        return parser.parse_args()
    def cli():
        opt,args=parse_options()        
        run(verbose=opt.verbose)
    cli()

所以脚本的主体主要由函数/类定义组成。 (通常)很少有代码不在函数/类定义中。

我会尝试以任何有利于组织和可读性的方式对功能进行分组。如果您认为某个函数可以在该特定脚本以外的地方重用，请将其放入模块中，并将该模块导入到此脚本中。

在 crontab 中定义 PYTHONPATH 和 PATH。那么从 cron 运行脚本应该没有问题。