我有一个带有几个辅助函数的函数。这是相当普遍的情况。我想将它们分组在一个共同的上下文中以便于阅读,我想知道如何正确地做到这一点。
- 他们需要~15行
- 只有主函数从其他地方调用
- 没有计划在不久的将来重用辅助功能
简化示例:
def create_filled_template_in_temp(path, values_mapping):
template_text = path.read_text()
filled_template = _fill_template(template_text, values_mapping)
result_path = _save_in_temp(filled_template)
return result_path
def _fill_template(template_text, values_mapping):
...
def _save_in_temp(filled_template):
_, pathname = tempfile.mkstemp(suffix='.ini', text=True)
path = pathlib.Path(pathname)
path.write_text(text)
return path
...
create_filled_template_in_temp(path, values_mapping)
请注意,我不希望模块级别的辅助方法,因为它们只属于一种方法。想象一下,在同一模块中有如上所述的几个这样的例子。模块级别的Maany非公共功能。一团糟(这种情况多次发生)。此外,我想给他们上下文,并使用上下文的名称来简化内部命名。
解决方案#0:一个模块
把它放在另一个模块中:
template_fillers.create_in_temp(path, values_mapping)
问题:
- 添加文件的代码太少,特别是当已经有很多文件时(这会造成混乱)
- 这是一个动作,现在我被迫为模块创建一个基于名词的名称(或打破模块命名规则)。而且简化它会使它太宽泛(在这种情况下创建一个真正是单身的集合)。
最后,这只是为它添加模块的代码太少。
解决方案#1:一堂课
创建一个没有的类 __init__
并且只有一个公共(通过命名约定)方法:
class TemplateFillerIntoTemp:
def run(self, path, values_mapping):
template_text = path.read_text()
filled_template = self._fill_template(template_text, values_mapping)
result_path = self._save_in_temp(filled_template)
return result_path
def _fill_template(self, template_text, values_mapping):
...
def _save_in_temp(self, filled_template):
_, pathname = tempfile.mkstemp(suffix='.ini', text=True)
path = pathlib.Path(pathname)
path.write_text(text)
return path
...
TemplateFillerIntoTemp().run(path, values_mapping)
这是我过去多次做过的事情。问题:
- 没有副作用,所以没有必要拥有类的实例
- 这是一个动作,现在我被迫为类创建一个基于名词的名称(或打破类命名规则)。这导致许多“管理者”或“创造者”。
- 这是对类概念的误用,这只是一个带有单个函数接口的小执行树,而不是一类东西。滥用概念会降低理解速度,并可能导致使用之间进一步混合。我知道在OOP中这很常见,因为在某些语言中你不能真正在类之外创建一个函数,但这对于代码中的顺序来说是过于激进的方法。当对象最接近您的想法时,它们很有用。事实并非如此。强迫不合适的顺序矛盾地产生不同类型的混乱:)
解决方案#2:静态类
采取解决方案#1,添加 @staticmethod
到处。可能还有ABC元类。
TemplateFillerIntoTemp.run(path, values_mapping)
亲:有一个明确的迹象表明这一切都与实例无关。 Con:还有更多的代码。
解决方案#3:带有__call__的类
解决方案#1,创建一个 __call__
使用main方法函数,然后在模块级别创建一个名为的实例 create_filled_template_in_temp
。
create_filled_template_in_temp(path, values_mapping)
Pro:调用就像一个函数。骗局:实施过于夸张,并不适合此目的。
解决方案#4:将辅助函数插入main函数
将它们添加到里面
def create_filled_template_in_temp(path, values_mapping):
def _fill_template(template_text, values_mapping):
...
def _save_in_temp(filled_template):
_, pathname = tempfile.mkstemp(suffix='.ini', text=True)
path = pathlib.Path(pathname)
path.write_text(text)
return path
template_text = path.read_text()
filled_template = _fill_template(template_text, values_mapping)
result_path = _save_in_temp(filled_template)
return result_path
...
create_filled_template_in_temp(path, values_mapping)
亲:如果总行数很少且辅助函数很少,这看起来很好。骗局:否则没有。