首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >用于多个文件中函数的Python礼仪

问用于多个文件中函数的Python礼仪
EN

Code Review用户
提问于 2019-12-31 04:39:22
回答 1查看 100关注 0票数 2

这里的上下文是:我的代码是为了自动测试OCR (图像到文本程序)的一个科学项目,可以很容易地阅读和理解我的其他项目。该代码包括用于不同目的的一组函数。基本上,有一些函数处理页面的绘制和保存(drawtext()、createpage()等),还有在图像上运行各种OCR的函数(tesseractocr()等)。以及计算两个字符串之间的差异的函数(levenshtein())。

在我看来,在main.py中使用所有这些函数会导致代码混乱。是否更好的做法是:

  1. 将所有这些函数保存在main.py中,以便整个代码位于一个文件中。
  2. 将所有这些函数放在一个functions.py文件中
  3. 将每组函数放入一个文件中,除了levenshtein.py、ocr.py和pagemaker.py之外,还会生成main.py。

老实说,我觉得无论是2还是3都是要做出的选择,我只是不确定。此外,在main.py文件中通常需要什么级别的抽象?如果文件看起来像

代码语言:javascript
复制
import ocr, levenshtein, pagemaker
import "a few other things"
define vars, etc

for page in pages:
    correct = pagemaker.drawpage(input1,input2,(input3,input4),etc) #also saves image
    tesseract_out = ocr.tesseract("img.png")
    tesseract_dist = levenshtein.levenshtein(correct, tesseract_out)
    print(f"Tesseract Distance: {tesseract_dist}")
    #etc for other ocr

还是太抽象了?另外,命令行参数解析(我没有在上面介绍)通常在main.py文件中,或者您应该简单地创建一个名为parseocrargs.py的文件并运行。

pages, color, etc = parseocrargs.argparse(aruments grabbed earlier)

我想主要的问题(S)是:一个独立的函数(不与其他函数交互),而冗长/丑陋的函数应该放在一个单独的文件中吗?几乎所有的函数都不应该在main.py中吗?如果没有,应该有多少人?main.py应该是非常抽象的吗?如果不是,它应该有多抽象?

EN

回答 1

Code Review用户

发布于 2019-12-31 09:05:18

把所有的代码都放在一个文件中是不好的。作为一个非常松散的经验法则,我试图避免让任何源文件超过一千行代码,但真正要遵循的规则是,代码应该被分解成具有连贯和可理解目的的模块,而这些模块应该存在于它们自己的文件中。

经验法则--比如“不超过一千行文件”--的起源是,如果一个文件真的很长,它就不能再被正常的人脑理解,所以你需要考虑如何把你的逻辑分解成更小、更容易理解的部分。一个函数(或一组相互关联的函数)是长的,但是是独立的,并且不与任何其他东西交互,在它自己的文件/模块中有很多意义。

我可能会在主函数中进行参数解析,除非arg解析非常复杂,感觉需要自己的模块。

票数 2
EN
页面原文内容由Code Review提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://codereview.stackexchange.com/questions/234853

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档