python - 使用类来组织共享输入的函数是否合适？

Question

为了提供一些背景信息，我正在构建一个风险模型，该模型从各种不同来源提取数据。最初，我将模型编写为单个函数，在执行时将不同的数据源读取为 pandas.DataFrame 对象，并在必要时使用这些对象。随着模型变得越来越复杂，它很快就变得不可读，我发现自己经常复制粘贴代码块。

为了清理代码，我决定创建一个类，在初始化时读取、清理和解析数据。初始化大约需要一分钟的时间来运行并构建完整的模型。

该类还有一些附加功能。有一个generate_email方法可以发送一封包含高风险因素详细信息的电子邮件，另一个方法append_history可以指定风险模型的时间点并保存它，以便我可以运行时间比较。

关于这两种附加方法的问题是，我无法想象在不首先重新校准风险模型的情况下调用它们的情况。所以我考虑过像我的其他方法一样在 init() 中调用它们。我这样做不仅仅是因为我一开始就想证明类的合理性。

我正在咨询这个社区，因为我的项目结构感觉笨重和尴尬。我倾向于认为我根本不应该使用类(class)。仅仅为了组织的目的而创建类是否会令人不悦？另外，在 init() 中调用实例方法(需要一分钟以上的时间才能运行)是不是不好的做法？

最终，我正在寻找保证或更好的代码结构。任何帮助将不胜感激。

这是一些显示我的项目结构的伪代码:

class RiskModel:
    def __init__(self, data_path_a, data_path_b):
        self.data_path_a = data_path_a
        self.data_path_b = data_path_b

        self.historical_data = None
        self.raw_data = None
        self.lookup_table = None
        self._read_in_data()

        self.risk_breakdown = None
        self._generate_risk_breakdown()

        self.risk_summary = None
        self.generate_risk_summary()

    def _read_in_data(self):
        # read in a .csv
        self.historical_data = pd.read_csv(self.data_path_a)

        # read an excel file containing many sheets into an ordered dictionary
        self.raw_data = pd.read_excel(self.data_path_b, sheet_name=None)


        # store a specific sheet from the excel file that is used by most of
        # my class's methods
        self.lookup_table = self.raw_data["Lookup"]

    def _generate_risk_breakdown(self):
        '''
        A function that creates a DataFrame from self.historical_data,
        self.raw_data, and self.lookup_table and stores it in 
        self.risk_breakdown
        '''
        self.risk_breakdown = some_dataframe

    def _generate_risk_summary(self):
        '''
        A function that creates a DataFrame from self.lookup_table and 
        self.risk_breakdown and stores it in self.risk_summary
        '''
        self.risk_summary = some_dataframe

    def generate_email(self, recipient):
        '''
        A function that sends an email with details about high risk factors
        '''

if __name__ == "__main__":
    risk_model = RiskModel(data_path_a, data_path_b)
    risk_model.generate_email(recipient@generic.com)

Answer 1

在我看来，这是组织项目的好方法，特别是因为您提到了部分代码的高重用率。

有一件事，我不会把 _read_in_data , _generate_risk_breakdown和_generate_risk_summary __init__ 里面的方法，而是让用户在初始化 RiskModel 后调用此方法类实例。

这样，用户将能够从不同路径读入数据，或者仅生成风险分割或摘要，而无需再次读入数据。

类似这样的事情:

my_risk_model = RiskModel()
my_risk_model.read_in_data(path_a, path_b)
my_risk_model.generate_risk_breakdown(parameters)
my_risk_model.generate_risk_summary(other_parameters)

如果用户按顺序调用这些方法会破坏逻辑链，则可能会抛出异常，如果 generate_risk_breakdown或generate_risk_summary在read_in_data之前被调用。当然你只能移动generate...方法退出，将数据导入保留在 __init__ 中.

倡导更多地揭露 generate... __init__ 中的方法，考虑一个案例场景，您希望生成多个风险摘要，更改各种参数。不创建 RiskModel 是有道理的。每次都读取相同的数据，但将输入更改为 generate_risk_summary方法:

my_risk_model = RiskModel()
my_risk_model.read_in_data(path_a, path_b)

for parameter in [50, 60, 80]:
    my_risk_model.generate_risk_summary(parameter)
    my_risk_model.generate_email('test@gmail.com')