使用类方法创建实例与__init__(self, kwargs)的替代方案

本文探讨了使用类方法创建实例，特别是结合__init__(self, **kwargs)模式的优缺点。通过分析示例代码和attrs库的建议，我们将深入理解这种模式可能带来的问题，并提供更清晰、更易于维护的替代方案，以提高代码的可读性和可维护性。

在Python中，使用类方法创建实例是一种常见的模式，特别是在需要从不同来源（如文件、数据库等）初始化对象时。一种常见的方式是定义一个通用的__init__(self, **kwargs)方法，然后使用类方法从特定来源读取数据并将其传递给__init__。虽然这种方法简洁灵活，但它也可能导致代码可读性和可维护性下降。

__init__(self, **kwargs)的潜在问题

使用__init__(self, **kwargs)的主要问题在于其不透明性。当类的初始化参数来自外部数据源时，__init__方法变得难以理解，因为它的行为取决于传递给它的kwargs的内容。 这使得代码更难调试和维护。

以下面的代码为例：

class Metadata:
__slots__ = 'question_id', 'testid', 'itemnum', 'subject', 'system', 'topic', 'images', 'tables', 'links'
@classmethod
def from_html(cls, html):
# next two lines will create the dict metadata with keys for
# everything in __slots__
metadata = MyModule.parse_details(html)
metadata['images'] = MyModule.process_images(html)
metadata['tables'] = MyModule.read_tables(html)
metadata['links'] = MyModule.pull_links(html)
return cls(**metadata)
@classmethod
def from_file(cls, filepath: str):
with open(filepath, 'r') as f:
metadata = json.load(f)
return cls(**metadata)
def __init__(self, **kwargs):
for k,v in kwargs.items():
setattr(self, k, v)

在这个例子中，__init__方法接受任意数量的关键字参数，并将它们设置为对象的属性。虽然这使得从不同来源初始化Metadata对象变得容易，但它也隐藏了对象的实际属性。

attrs库的建议

attrs库的文档建议避免直接使用**kwargs模式，因为它可能将类的设计与外部数据模型紧密耦合。如果数据库的字段名发生更改，则需要修改代码中所有使用该字段的地方。

例如，假设有一个JSON文件：

{
"userId": 1,
"id": 1,
"title": "delectus aut autem",
"completed": false
}

如果使用__init__(self, **kwargs)初始化Post类：

class Post:
def __init__(self, **kwargs):
for k, v in kwargs.items():
setattr(self, k, v)
import json
with open("data.json", encoding='utf-8') as f:
data = json.load(f)
post = Post(**data)
if not post.completed:
# do something and exit
else:
print(post.userId)

如果JSON文件中的userId字段被重命名为user_id，则需要修改代码中所有使用post.userId的地方。

更清晰的替代方案

一种更清晰的替代方案是显式地定义__init__方法的参数，并从外部数据源中提取所需的值。

class Post:
def __init__(self, user_id, id, title, completed):
self.user_id = user_id
self.id = id
self.title = title
self.completed = completed
import json
with open("data.json", encoding='utf-8') as f:
data = json.load(f)
post = Post(
user_id=data['userId'],
id=data['id'],
title=data['title'],
completed=data['completed'],
)
if not post.completed:
# do something and exit
else:
print(post.user_id)

在这个例子中，__init__方法显式地接受user_id、id、title和completed作为参数。如果JSON文件中的userId字段被重命名为user_id，则只需要修改初始化Post对象的那一行代码。

使用attrs库

attrs库提供了一种更简洁的方式来定义具有显式属性的类。

import attr
@attr.s
class Post:
user_id = attr.ib()
id = attr.ib()
title = attr.ib()
completed = attr.ib()
import json
with open("data.json", encoding='utf-8') as f:
data = json.load(f)
post = Post(
user_id=data['userId'],
id=data['id'],
title=data['title'],
completed=data['completed'],
)
if not post.completed:
# do something and exit
else:
print(post.user_id)

attrs库会自动生成__init__方法，并提供其他有用的功能，如自动生成__repr__方法。

总结

虽然使用类方法创建实例和__init__(self, **kwargs)模式可以简化代码，但它也可能导致代码可读性和可维护性下降。为了提高代码的质量，建议显式地定义__init__方法的参数，并从外部数据源中提取所需的值。attrs库提供了一种更简洁的方式来定义具有显式属性的类，并提供其他有用的功能。在设计类时，应尽量避免将类的设计与外部数据模型紧密耦合，以便在数据模型发生更改时更容易维护代码。