python - 如何在没有副作用的情况下对功能进行分组？

Question

我有一个包含多个辅助函数的函数。这是相当普遍的情况。我想将它们放在一个共同的上下文中以提高可读性，我想知道如何正确地做到这一点。

• 他们需要大约 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)

请注意，我不想要模块级别的辅助方法，因为它们只属于一个方法。想象一下，在同一个模块中有几个这样的例子。模块级别的许多非公共(public)功能。一团糟(这种情况发生了很多次)。另外我想给他们上下文并使用上下文的名称来简化内部命名。

解决方案 #0:模块

把它放在另一个模块中:

template_fillers.create_in_temp(path, values_mapping)

问题:

• 添加文件的代码太少，尤其是当已经有很多文件时(这会造成困惑)
• 这是一个 Action ，现在我被迫为模块创建一个基于名词的名称(或打破模块命名规则)。此外，让它变得简单会使它变得过于宽泛(在这种情况下，创建的集合实际上是一个单例)。

最后，代码太少，无法为其添加模块。

解决方案 #1:A 类

创建一个没有 __init__ 且只有一个公共(public)(按照命名约定)方法的类:

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)

这是我过去多次做的。问题:

• 没有副作用，所以不需要类的实例
• 这是一个 Action ，现在我不得不为类创建一个基于名词的名称(或打破类命名规则)。这导致了许多“管理者”或“创造者”。
• 这是对类概念的误用，这只是一个带有单一函数接口(interface)的小执行树，而不是一个类的东西。滥用概念会减慢理解速度，并可能导致用途之间的进一步混合。我知道在 OOP 中这很常见，因为在某些语言中你不能真正在类之外创建函数，但这种方法过于激进，无法在代码中排序。当对象最接近您的想法时，它们很有用。事实并非如此。矛盾的是，强制不符合顺序会产生另一种困惑:)

解决方案 #2:静态类

采取解决方案#1，在所有地方添加@staticmethod。也可能是 ABC 元类。

 TemplateFillerIntoTemp.run(path, values_mapping)

Pro:有一个明确的迹象表明这一切都是实例无关的。缺点:代码更多。

解决方案 #3:使用 __call__ 上课

采用解决方案 #1，使用 main 方法创建一个 __call__ 函数，然后在模块级别创建一个名为 create_filled_template_in_temp 的实例。

create_filled_template_in_temp(path, values_mapping)

专业版:像单个函数一样调用。缺点:实现被夸大了，不符合目的。

解决方案 #4:将辅助函数插入主函数

将它们添加到里面。

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)

Pro:如果总行数很少并且辅助函数很少，这看起来不错。缺点:否则不会。

Answer 1

#4 的修改:创建内部函数，并将函数体作为内部函数。这具有仍然从上到下阅读的好特性，而不是让正文一直在底部。

def create_filled_template_in_temp(path, values_mapping):
    def body():
        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

    return body()

(我不关心前导下划线，所以它们没有存在。)