自动初始化实例变量?


89

我有一个看起来像这样的python类:

class Process:
    def __init__(self, PID, PPID, cmd, FDs, reachable, user):

其次是:

        self.PID=PID
        self.PPID=PPID
        self.cmd=cmd
        ...

有没有办法自动初始化这些实例变量,例如C ++的初始化列表?它将节省大量冗余代码。


1
另请参见对autoassignactivestate配方的讨论和以下替代autoargs实现:在Python中进行自动属性分配的最佳方法是什么,这是个好主意吗?-堆栈溢出
nealmcb

Answers:


104

您可以使用装饰器:

from functools import wraps
import inspect

def initializer(func):
    """
    Automatically assigns the parameters.

    >>> class process:
    ...     @initializer
    ...     def __init__(self, cmd, reachable=False, user='root'):
    ...         pass
    >>> p = process('halt', True)
    >>> p.cmd, p.reachable, p.user
    ('halt', True, 'root')
    """
    names, varargs, keywords, defaults = inspect.getargspec(func)

    @wraps(func)
    def wrapper(self, *args, **kargs):
        for name, arg in list(zip(names[1:], args)) + list(kargs.items()):
            setattr(self, name, arg)

        for name, default in zip(reversed(names), reversed(defaults)):
            if not hasattr(self, name):
                setattr(self, name, default)

        func(self, *args, **kargs)

    return wrapper

用它来装饰__init__方法:

class process:
    @initializer
    def __init__(self, PID, PPID, cmd, FDs, reachable, user):
        pass

输出:

>>> c = process(1, 2, 3, 4, 5, 6)
>>> c.PID
1
>>> dir(c)
['FDs', 'PID', 'PPID', '__doc__', '__init__', '__module__', 'cmd', 'reachable', 'user'

5
这可行并回答了问题,所以我投了赞成票。但是我一直让Ferdidand Beyer回答:“显性胜于隐性”
卢卡斯·加布里埃尔·桑切斯

14
+1对于解决我的问题的好答案。但是这不是语言的核心功能吗?您认为写PEP值得吗?
亚当·马坦

3
这是一个非常好的答案-这已直接进入我的工具箱。
Michael van der Westhuizen,2009年

3
@NadiaAlramli我认为代码中有一个小错误。看看这里gist.github.com/pmav99/137dbf4681be9a58de74(original.py)
pmav99

2
当前示例存在一个错误,如果签名不包含默认参数,则该示例将不起作用。您需要包括一项检查,以确保名称和默认值不为None。例如:如果名称和默认名称:

36

如果您使用的是Python 2.6或更高版本,则可以使用collections.namedtuple

>>> from collections import namedtuple
>>> Process = namedtuple('Process', 'PID PPID cmd')
>>> proc = Process(1, 2, 3)
>>> proc.PID
1
>>> proc.PPID
2

当您的班级实际上只是一大包价值观时,这尤其合适。


2
“这是适当的,特别是当您的课堂实际上只是一大包价值观时。” 在这种情况下,您也可以这样做:https
//docs.python.org/3.3/tutorial/classes.html#odds-and-ends

34

对于Python 3.7+,您可以使用Data Class,这是一种非常Python化且可维护的方式来完成您想要的事情。

它允许您为类定义字段,它们是自动初始化的实例变量。

它看起来像这样:

@dataclass
class Process:
    PID: int
    PPID: int
    cmd: str
    ...

__init__方法将已经在您的班级中。

请注意,在这里键入提示是必需的,这就是为什么我已经使用intstr在本例中。如果您不知道字段的类型,则可以使用模块中的任何typing

与建议的解决方案相比,数据类具有许多优点:

  • 这很明确:所有字段都是可见的,这尊重Python的Zen,使其可读性和可维护性。将其与的使用进行比较**kwargs
  • 它可以有方法。就像其他任何课程一样。
  • 它使您可以超越自动__init__使用__post_init__方法。

编辑:避免使用NamedTuples的原因

有人建议在namedtuple这种情况下使用,但是namedtuple的某些行为与Python类有所不同,这些行为起初并不十分明显,应该众所周知:

1. NamedTuples是不可变的

不变性可能很有用,但也许不是您想要的实例。如果您frozen=True@dataclass装饰器上使用参数,则DataClasses也可能是不可变的。

2. NamedTuples的__eq__行为类似于Tuple的行为

在Python中,SomeNamedTuple(a=1, b=2) == AnotherNamedTuple(c=1, d=2)True!该__eq__NamedTuple的功能,在比较中使用,只考虑了值,并将这些值的位置上进行比较的情况下,不是他们的阶级或字段的名称。


仅当该类的目的是存储数据时才应使用此方法。
罗卡蒙德

或围绕存储数据进行开发。
罗卡蒙德

3
您能否解释为什么dataclass仅用于存储数据的类,而不要具有其他行为?我可能会为此专门创建一个新的SO帖子,以更好地了解其适当的用例。谢谢。
Vahid Pazirandeh '18

Data Classes can be thought of as "mutable namedtuples with defaults". -PEP557
aafulei

26

引用Python禅宗

显式胜于隐式。


10
初始化列表声明不够明确吗?
亚当·马坦

我猜。但是我看不出在语言中添加类似内容的理由。与幕后的装饰魔术师相比,我显然更喜欢使用多个赋值语句。
费迪南德·拜尔

29
@Ferdinand,我同意用某种语言完美地包含在stdlib中会很愚蠢,但是应该放在stdlib中,因为“美丽胜于丑陋”优先,而且许多重复的工作都是丑陋的(以及任何形式的重复)。
亚历克斯·马丁里

好吧,来对付:DWIM> DWIS
Terrence Brannon

我会同意装饰器比任务列表更漂亮,但是PyCharm通过不理解它而变得更丑陋:-(
user110954 '17

23

您可以做的另一件事:

class X(object):
    def __init__(self, a,b,c,d):
        vars = locals() # dict of local names
        self.__dict__.update(vars) # __dict__ holds and object's attributes
        del self.__dict__["self"] # don't need `self`

但是我建议的唯一解决方案,除了将其说明清楚外,还应是“在编辑器中创建一个宏”; -p


1
删除“自我”的好习惯。
迈克尔

15

您可以使用关键字参数轻松做到这一点,例如:

>>> class D:
    def __init__(self, **kwargs):
        for k, v in kwargs.items():
            setattr(self, k, v)

>>> D(test='d').test
'd'

位置参数的类似实现是:

>> class C:
    def __init__(self, *args):
        self.t, self.d = args


>>> C('abc', 'def').t
'abc'
>>> C('abc', 'def').d
'def'

在我看来,这似乎并不能解决您的问题。


3
我喜欢的另一种变化是self.__dict__.update( **kwargs )
S.Lott

最好使用locals()并放置普通参数。
09年

7

Nadia的解决方案更好,更强大,但是我认为这也很有趣:

def constructor(*arg_names):
  def __init__(self, *args):
    for name, val in zip(arg_names, args):
      self.__setattr__(name, val)
  return __init__


class MyClass(object):
  __init__ = constructor("var1", "var2", "var3")


>>> c = MyClass("fish", "cheese", "beans")
>>> c.var2
"cheese"

5

我出于相同的目的需要一些东西,但是现有的答案都没有涵盖我测试过的所有案例。Nadia的答案最接近我想要的答案,因此我从她的代码作为基础开始。

下面的装饰器适用于所有有效的参数组合:

Positional                                          __init__(self, a, b                )
Keyword                                             __init__(self, a=None, b=None      )
Positional + Keyword                                __init__(self, a, b, c=None, d=None)
Variable Positional                                 __init__(self, *a                  )
Variable Positional + Keyword                       __init__(self, *a, b=None          )
Variable Positional + Variable Keyword              __init__(self, *a, **kwargs        )
Positional + Variable Positional + Keyword          __init__(self, a, *b, c=None       )
Positional + Variable Positional + Variable Keyword __init__(self, a, *b, **kwargs     )
Keyword Only                                        __init__(self, *, a=None           )
Positional + Keyword Only                           __init__(self, a, *, b=None        )

它还实现了标准的_-prefix约定,以允许__init__-private变量不会分配给类实例。


###  StdLib  ###
from functools import wraps
import inspect


###########################################################################################################################
#//////|   Decorator   |//////////////////////////////////////////////////////////////////////////////////////////////////#
###########################################################################################################################

def auto_assign_arguments(function):

  @wraps(function)
  def wrapped(self, *args, **kwargs):
    _assign_args(self, list(args), kwargs, function)
    function(self, *args, **kwargs)

  return wrapped


###########################################################################################################################
#//////|   Utils   |//////////////////////////////////////////////////////////////////////////////////////////////////////#
###########################################################################################################################

def _assign_args(instance, args, kwargs, function):

  def set_attribute(instance, parameter, default_arg):
    if not(parameter.startswith("_")):
      setattr(instance, parameter, default_arg)

  def assign_keyword_defaults(parameters, defaults):
    for parameter, default_arg in zip(reversed(parameters), reversed(defaults)):
      set_attribute(instance, parameter, default_arg)

  def assign_positional_args(parameters, args):
    for parameter, arg in zip(parameters, args.copy()):
      set_attribute(instance, parameter, arg)
      args.remove(arg)

  def assign_keyword_args(kwargs):
    for parameter, arg in kwargs.items():
      set_attribute(instance, parameter, arg)
  def assign_keyword_only_defaults(defaults):
    return assign_keyword_args(defaults)

  def assign_variable_args(parameter, args):
    set_attribute(instance, parameter, args)

  POSITIONAL_PARAMS, VARIABLE_PARAM, _, KEYWORD_DEFAULTS, _, KEYWORD_ONLY_DEFAULTS, _ = inspect.getfullargspec(function)
  POSITIONAL_PARAMS = POSITIONAL_PARAMS[1:] # remove 'self'

  if(KEYWORD_DEFAULTS     ): assign_keyword_defaults     (parameters=POSITIONAL_PARAMS,  defaults=KEYWORD_DEFAULTS)
  if(KEYWORD_ONLY_DEFAULTS): assign_keyword_only_defaults(defaults=KEYWORD_ONLY_DEFAULTS                          )
  if(args                 ): assign_positional_args      (parameters=POSITIONAL_PARAMS,  args=args                )
  if(kwargs               ): assign_keyword_args         (kwargs=kwargs                                           )
  if(VARIABLE_PARAM       ): assign_variable_args        (parameter=VARIABLE_PARAM,      args=args                )


###########################################################################################################################$#//////|   Tests   |//////////////////////////////////////////////////////////////////////////////////////////////////////#$###########################################################################################################################$$if __name__ == "__main__":$$#######|   Positional   |##################################################################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, a, b):$      pass$$  t = T(1, 2)$  assert (t.a == 1) and (t.b == 2)$$#######|   Keyword   |#####################################################################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, a="KW_DEFAULT_1", b="KW_DEFAULT_2"):$      pass$$  t = T(a="kw_arg_1", b="kw_arg_2")$  assert (t.a == "kw_arg_1") and (t.b == "kw_arg_2")$$#######|   Positional + Keyword   |########################################################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, a, b, c="KW_DEFAULT_1", d="KW_DEFAULT_2"):$      pass$$  t = T(1, 2)$  assert (t.a == 1) and (t.b == 2) and (t.c == "KW_DEFAULT_1") and (t.d == "KW_DEFAULT_2")$$  t = T(1, 2, c="kw_arg_1")$  assert (t.a == 1) and (t.b == 2) and (t.c == "kw_arg_1") and (t.d == "KW_DEFAULT_2")$$  t = T(1, 2, d="kw_arg_2")$  assert (t.a == 1) and (t.b == 2) and (t.c == "KW_DEFAULT_1") and (t.d == "kw_arg_2")$$#######|   Variable Positional   |#########################################################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, *a):$      pass$$  t = T(1, 2, 3)$  assert (t.a == [1, 2, 3])$$#######|   Variable Positional + Keyword   |###############################################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, *a, b="KW_DEFAULT_1"):$      pass$$  t = T(1, 2, 3)$  assert (t.a == [1, 2, 3]) and (t.b == "KW_DEFAULT_1")$$  t = T(1, 2, 3, b="kw_arg_1")$  assert (t.a == [1, 2, 3]) and (t.b == "kw_arg_1")$$#######|   Variable Positional + Variable Keyword   |######################################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, *a, **kwargs):$      pass$$  t = T(1, 2, 3, b="kw_arg_1", c="kw_arg_2")$  assert (t.a == [1, 2, 3]) and (t.b == "kw_arg_1") and (t.c == "kw_arg_2")$$#######|   Positional + Variable Positional + Keyword   |##################################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, a, *b, c="KW_DEFAULT_1"):$      pass$$  t = T(1, 2, 3, c="kw_arg_1")$  assert (t.a == 1) and (t.b == [2, 3]) and (t.c == "kw_arg_1")$$#######|   Positional + Variable Positional + Variable Keyword   |#########################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, a, *b, **kwargs):$      pass$$  t = T(1, 2, 3, c="kw_arg_1", d="kw_arg_2")$  assert (t.a == 1) and (t.b == [2, 3]) and (t.c == "kw_arg_1") and (t.d == "kw_arg_2")$$#######|   Keyword Only   |################################################################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, *, a="KW_DEFAULT_1"):$      pass$$  t = T(a="kw_arg_1")$  assert (t.a == "kw_arg_1")$$#######|   Positional + Keyword Only   |###################################################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, a, *, b="KW_DEFAULT_1"):$      pass$$  t = T(1)$  assert (t.a == 1) and (t.b == "KW_DEFAULT_1")$$  t = T(1, b="kw_arg_1")$  assert (t.a == 1) and (t.b == "kw_arg_1")$$#######|   Private __init__ Variables (underscored)   |####################################################################$$  class T:$    @auto_assign_arguments$    def __init__(self, a, b, _c):$      pass$$  t = T(1, 2, 3)$  assert hasattr(t, "a") and hasattr(t, "b") and not(hasattr(t, "_c"))

注意:

我包括了测试,但是为了简洁起见,将它们折叠到最后一行(58)。您可以通过用换行符为find/replace所有$字符-扩展测试,详细描述所有潜在的用例。


3

可能不需要初始化变量,因为locals()已包含值!

类Dummy(object):

def __init__(self, a, b, default='Fred'):
    self.params = {k:v for k,v in locals().items() if k != 'self'}

d =虚拟(2,3)

d。参数

{'a':2,'b':3,'默认':'Fred'}

d.params ['b']

3

当然,在一堂课中,可以使用self.params


这是一种不错的原始方法,但是d['b']使用Python的通用语言编写,同时d.params['b']会使代码阅读器感到困惑。
亚当·马坦

3

只要getargspec是因为Python 3.5不赞成使用,这是一个使用的解决方案inspect.signature

from inspect import signature, Parameter
import functools


def auto_assign(func):
    # Signature:
    sig = signature(func)
    for name, param in sig.parameters.items():
        if param.kind in (Parameter.VAR_POSITIONAL, Parameter.VAR_KEYWORD):
            raise RuntimeError('Unable to auto assign if *args or **kwargs in signature.')
    # Wrapper:
    @functools.wraps(func)
    def wrapper(self, *args, **kwargs):
        for i, (name, param) in enumerate(sig.parameters.items()):
            # Skip 'self' param:
            if i == 0: continue
            # Search value in args, kwargs or defaults:
            if i - 1 < len(args):
                val = args[i - 1]
            elif name in kwargs:
                val = kwargs[name]
            else:
                val = param.default
            setattr(self, name, val)
        func(self, *args, **kwargs)
    return wrapper

检查是否有效:

class Foo(object):
    @auto_assign
    def __init__(self, a, b, c=None, d=None, e=3):
        pass

f = Foo(1, 2, d="a")
assert f.a == 1
assert f.b == 2
assert f.c is None
assert f.d == "a"
assert f.e == 3

print("Ok")

2

对于Python 3.3+:

from functools import wraps
from inspect import Parameter, signature


def instance_variables(f):
    sig = signature(f)
    @wraps(f)
    def wrapper(self, *args, **kwargs):
        values = sig.bind(self, *args, **kwargs)
        for k, p in sig.parameters.items():
            if k != 'self':
                if k in values.arguments:
                    val = values.arguments[k]
                    if p.kind in (Parameter.POSITIONAL_OR_KEYWORD, Parameter.KEYWORD_ONLY):
                        setattr(self, k, val)
                    elif p.kind == Parameter.VAR_KEYWORD:
                        for k, v in values.arguments[k].items():
                            setattr(self, k, v) 
                else:
                    setattr(self, k, p.default) 
    return wrapper

class Point(object):
    @instance_variables 
    def __init__(self, x, y, z=1, *, m='meh', **kwargs):
        pass

演示:

>>> p = Point('foo', 'bar', r=100, u=200)
>>> p.x, p.y, p.z, p.m, p.r, p.u
('foo', 'bar', 1, 'meh', 100, 200)

使用框架的Python 2和3的非装饰器方法:

import inspect


def populate_self(self):
    frame = inspect.getouterframes(inspect.currentframe())[1][0]
    for k, v in frame.f_locals.items():
        if k != 'self':
            setattr(self, k, v)


class Point(object):
    def __init__(self, x, y):
        populate_self(self)

演示:

>>> p = Point('foo', 'bar')
>>> p.x
'foo'
>>> p.y
'bar'

1

nu11ptr制作了一个小模块PyInstanceVars,其中包含此功能作为函数装饰器。该模块的自述文件指出“现在的性能仅比在CPython下显式初始化差30-40% ”。

使用示例,直接从模块的文档中提取:

>>> from instancevars import *
>>> class TestMe(object):
...     @instancevars(omit=['arg2_'])
...     def __init__(self, _arg1, arg2_, arg3='test'):
...             self.arg2 = arg2_ + 1
...
>>> testme = TestMe(1, 2)
>>> testme._arg1
1
>>> testme.arg2_
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'TestMe' object has no attribute 'arg2_'
>>> testme.arg2
3
>>> testme.arg3
'test'

0

也许这是一个封闭的问题,但是我想提出我的解决方案,以便了解您对此的看法。我已经使用了将装饰器应用于init方法的元类

import inspect

class AutoInit(type):
    def __new__(meta, classname, supers, classdict):
        classdict['__init__'] = wrapper(classdict['__init__'])
        return type.__new__(meta, classname, supers, classdict)

def wrapper(old_init):
    def autoinit(*args):
        formals = inspect.getfullargspec(old_init).args
        for name, value in zip(formals[1:], args[1:]):
            setattr(args[0], name, value)
    return autoinit


0

init函数的末尾:

for var in list(locals().keys()):
    setattr(self,var,locals()[var])

有关更多信息,setattr()请参阅此处


By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.