Skip to main content
 首页 » 编程设计

python之我应该在哪里放置使用通用模块的脚本的辅助函数

2025年05月04日12wuhuacong

我一直在开发一组 Python 脚本,为了简单起见,我使用专门为这些脚本编写的解析器来操作一组输入文件。该项目的设计通常如下所示:

/project/project/__init__.py 
/project/project/parser.py 
/project/project/helperfunctions.py 
/project/preferences.ini 
/project/script1.py 
/project/script2.py 

每个脚本都调用 helperfunctions.py 中的某些函数来执行诸如读取首选项文件之类的任务——否则每个脚本都必须复制这些代码。解析器根本不使用辅助函数。

但现在我决定让项目面向解析器本身,同时仍将脚本放在一边。所以现在项目看起来像这样:

/project/scripts/preferences.ini 
/project/scripts/script1.py 
/project/scripts/script2.py 
/project/parser.py 
/project/setup.py 

我认为这是一个更简洁的设计,但问题是我不确定将这些辅助函数放在哪里。我提出的想法是:

  • 让 setup.py 在解析器旁边安装 helperfunctions.py。我反对这一点,因为辅助函数只是提供与解析器无关的便利方法。
  • 将辅助函数作为某种“隐藏”类合并到解析器中。出于与上述相同的原因,我反对这一点。
  • 将辅助函数放入/project/scripts/,避开安装。我不喜欢这个想法,因为这表明 helperfunctions.py 本身就是一个脚本。

解决这个问题最符合 Pythonic 的方法是什么?

请您参考如下方法:

一个选项是将辅助函数放在 __init__.py 中,这样您就可以稍后从解析模块中调用它们?

我不知道你的函数有多复杂......它们只是函数或者辅助类?

思考的方式是从用户的角度(解析器和那些辅助函数)。您(或任何人)将如何调用这些函数?