提问人:MWB 提问时间:2/4/2016 最后编辑:Karl KnechtelMWB 更新时间:9/23/2022 访问量:15937
如何避免“self.x = x;self.y = y;self.z = z“ 模式在__init__?
How do I avoid the "self.x = x; self.y = y; self.z = z" pattern in __init__?
问:
我看到这样的模式
def __init__(self, x, y, z):
...
self.x = x
self.y = y
self.z = z
...
相当频繁,通常具有更多参数。有没有好方法可以避免这种乏味的重复?该类是否应该继承自?namedtuple
答:
显性总比隐性好...... 所以可以肯定的是,你可以让它更简洁:
def __init__(self,a,b,c):
for k,v in locals().items():
if k != "self":
setattr(self,k,v)
更好的问题是:你应该吗?
...也就是说,如果你想要一个命名的元组,我建议使用一个命名的元组(记住,元组附加了某些条件)......也许你想要一个 OrderedDict,甚至只是一个 dict ......
评论
if k != "self":
if v is not self:
__init__
self
locals
set_fields_from_locals(locals())
免責聲明:似乎有几个人担心提出这个解决方案,所以我将提供一个非常明确的免责声明。不应使用此解决方案。我只提供它作为信息,所以你知道这门语言能够做到这一点。答案的其余部分只是展示语言能力,而不是认可以这种方式使用它们。
将参数显式复制到属性中实际上没有任何问题。如果 ctor 中的参数太多,有时会被认为是代码异味,也许您应该将这些参数分组到更少的对象中。其他时候,这是必要的,没有任何问题。无论如何,明确地这样做是要走的路。
但是,既然您问的是“如何完成”(而不是是否应该完成),那么一个解决方案是这样的:
class A:
def __init__(self, **kwargs):
for key in kwargs:
setattr(self, key, kwargs[key])
a = A(l=1, d=2)
a.l # will return 1
a.d # will return 2
评论
self.__dict__.update(kwargs)
A.__init__
kwargs
my_method
my_method
update()
您还可以执行以下操作:
locs = locals()
for arg in inspect.getargspec(self.__init__)[0][1:]:
setattr(self, arg, locs[arg])
当然,您必须导入该模块。inspect
正如其他人所提到的,重复还不错,但在某些情况下,命名元组可能非常适合此类问题。这避免了使用 locals() 或 kwargs,这通常是一个坏主意。
from collections import namedtuple
# declare a new object type with three properties; x y z
# the first arg of namedtuple is a typename
# the second arg is comma-separated or space-separated property names
XYZ = namedtuple("XYZ", "x, y, z")
# create an object of type XYZ. properties are in order
abc = XYZ("one", "two", 3)
print abc.x
print abc.y
print abc.z
我发现它的用途有限,但您可以像继承任何其他对象一样继承命名元组(示例继续):
class MySuperXYZ(XYZ):
""" I add a helper function which returns the original properties """
def properties(self):
return self.x, self.y, self.z
abc2 = MySuperXYZ(4, "five", "six")
print abc2.x
print abc2.y
print abc2.z
print abc2.properties()
评论
properties
return tuple(self)
XYZ = namedtuple("XYZ", "x y z")
namedtuple
namedtuple
abc.x += 1
编辑: 如果你有python 3.7+,只需使用数据类
保留签名的装饰器解决方案:
import decorator
import inspect
import sys
@decorator.decorator
def simple_init(func, self, *args, **kws):
"""
@simple_init
def __init__(self,a,b,...,z)
dosomething()
behaves like
def __init__(self,a,b,...,z)
self.a = a
self.b = b
...
self.z = z
dosomething()
"""
#init_argumentnames_without_self = ['a','b',...,'z']
if sys.version_info.major == 2:
init_argumentnames_without_self = inspect.getargspec(func).args[1:]
else:
init_argumentnames_without_self = tuple(inspect.signature(func).parameters.keys())[1:]
positional_values = args
keyword_values_in_correct_order = tuple(kws[key] for key in init_argumentnames_without_self if key in kws)
attribute_values = positional_values + keyword_values_in_correct_order
for attribute_name,attribute_value in zip(init_argumentnames_without_self,attribute_values):
setattr(self,attribute_name,attribute_value)
# call the original __init__
func(self, *args, **kws)
class Test():
@simple_init
def __init__(self,a,b,c,d=4):
print(self.a,self.b,self.c,self.d)
#prints 1 3 2 4
t = Test(1,c=2,b=3)
#keeps signature
#prints ['self', 'a', 'b', 'c', 'd']
if sys.version_info.major == 2:
print(inspect.getargspec(Test.__init__).args)
else:
print(inspect.signature(Test.__init__))
评论
signature
为了扩展答案,我使用了如下模式:gruszczy
class X:
x = None
y = None
z = None
def __init__(self, **kwargs):
for (k, v) in kwargs.items():
if hasattr(self, k):
setattr(self, k, v)
else:
raise TypeError('Unknown keyword argument: {:s}'.format(k))
我喜欢这种方法,因为它:
- 避免重复
- 在构造对象时防止拼写错误
- 适用于子类化(可以
super().__init(...)
) - 允许在类级别(它们所属的位置)而不是
X.__init__
在 Python 3.6 之前,这无法控制属性的设置顺序,如果某些属性是具有访问其他属性的 setter 的属性,则这可能是一个问题。
它可能会有所改进,但我是我自己代码的唯一用户,所以我不担心任何形式的输入卫生。也许会更合适。AttributeError
这是一个无需任何额外导入的解决方案。
Helper 函数
一个小小的助手功能,让它更加方便和可重用:
def auto_init(local_name_space):
"""Set instance attributes from arguments.
"""
self = local_name_space.pop('self')
for name, value in local_name_space.items():
setattr(self, name, value)
应用
您需要用以下命令来调用它:locals()
class A:
def __init__(self, x, y, z):
auto_init(locals())
测试
a = A(1, 2, 3)
print(a.__dict__)
输出:
{'y': 2, 'z': 3, 'x': 1}
不变locals()
如果您不想更改,请使用此版本:locals()
def auto_init(local_name_space):
"""Set instance attributes from arguments.
"""
for name, value in local_name_space.items():
if name != 'self':
setattr(local_name_space['self'], name, value)
评论
locals()
self
self
__init__
我的 0.02 美元。它与乔兰·比斯利的回答非常接近,但更优雅:
def __init__(self, a, b, c, d, e, f):
vars(self).update((k, v) for k, v in locals().items() if v is not self)
此外,Mike Müller 的答案(最适合我的口味)可以用这种技术来减少:
def auto_init(ns):
self = ns.pop('self')
vars(self).update(ns)
而你的电话auto_init(locals())
__init__
评论
一个有趣的库可以处理这个问题(并避免了很多其他样板)是 attrs。例如,您的示例可以简化为以下值(假设该类名为):MyClass
import attr
@attr.s
class MyClass:
x = attr.ib()
y = attr.ib()
z = attr.ib()
你甚至不再需要一种方法,除非它也能做其他事情。这是 Glyph Lefkowitz 的一个很好的介绍。__init__
评论
Python 3.7 及更高版本
在 Python 3.7 中,您可以(滥用)使用模块中提供的数据类
装饰器。从文档中:dataclasses
该模块提供了一个装饰器和函数,用于自动将生成的特殊方法(如 和)添加到用户定义的类中。它最初是在 PEP 557 中描述的。
__init__()
__repr__()
在这些生成的方法中使用的成员变量是使用 PEP 526 类型注释定义的。例如,以下代码:
@dataclass class InventoryItem: '''Class for keeping track of an item in inventory.''' name: str unit_price: float quantity_on_hand: int = 0 def total_cost(self) -> float: return self.unit_price * self.quantity_on_hand
除其他事项外,将添加如下所示的:
__init__()
def __init__(self, name: str, unit_price: float, quantity_on_hand: int=0): self.name = name self.unit_price = unit_price self.quantity_on_hand = quantity_on_hand
请注意,此方法会自动添加到类中:它不直接在上面显示的 InventoryItem 定义中指定。
如果您的类很大且很复杂,则使用 .我是在 Python 3.7.0 发布当天写这篇文章的,所以使用模式还没有很好地建立起来。dataclass
评论
__slots__
用于此目的;它有点不蟒蛇(为了节省内存而更冗长),但我喜欢它很大程度上是为了避免如果我打错名称就会自动激活一个全新的属性的风险。ini <shortcut> x, y, z): <shortcut>