Question

我有一个带有几个辅助函数的函数。这是相当普遍的情况。我想将它们分组在一个共同的上下文中以便于阅读，我想知道如何正确地做到这一点。

他们需要~15行
只从其他地方调用main函数
没有计划在不久的将来重用辅助功能

简化示例：

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)

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

没有副作用，因此不需要使用类'instance
这是一个动作，现在我被迫为类创建一个基于名词的名称（或打破类命名规则）。这导致了许多“管理者”或“创造者”。
这是对类概念的误用，这只是一个带有单个函数接口的小执行树，而不是一类东西。滥用概念会降低理解速度，并可能导致使用之间进一步混合。我知道在OOP中这很常见，因为在某些语言中你不能真正在类之外创建一个函数，但这对于代码中的命令来说太过激进了。当对象最接近您的想法时，它们很有用。事实并非如此。强迫不合适的顺序矛盾地产生不同类型的混乱：）

解决方案＃2：静态类

采取解决方案＃1，在任何地方添加@staticmethod。也可能是ABC元类。

 TemplateFillerIntoTemp.run(path, values_mapping)

Pro：有一个明确的迹象表明这一切都与实例无关。 Con：还有更多代码。

解决方案＃3：带__call __

的班级

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

create_filled_template_in_temp(path, values_mapping)

Pro：调用就像一个函数。骗局：实施过度，不适合此目的。

解决方案＃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()

（我不关心领先的下划线，所以他们没有生存。）

如何对没有副作用的函数进行分组？

1 个答案: