Автоматично ініціалізувати змінні екземпляра?


89

У мене є клас python, який виглядає так:

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

а потім:

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

Чи є спосіб автоініціалізації цих змінних екземпляра, як список ініціалізації C ++? Це заощадить багато зайвого коду.


1
Див. Також обговорення autoassignрецепту активного стану та альтернативну autoargsреалізацію за адресою: Який найкращий спосіб зробити автоматичне присвоєння атрибутів у Python, і чи є це гарною ідеєю? - Переповнення стеку
nealmcb

Відповіді:


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
Це працює і відповідає на питання, тому я проголосував. Але я дотримався відповіді Фердідана Бейера: "Явне краще, ніж неявне"
Лукас Габріель Санчес,

14
+1 За чудову відповідь, яка вирішила мою проблему. Але чи не повинно це бути основним функціоналом мови? Як ви вважаєте, чи варто писати PEP?
Адам Матан,

3
Це дійсно хороша відповідь - це потрапило прямо до мого набору інструментів.
Michael van der Westhuizen

3
@NadiaAlramli Я думаю, що в коді є невелика помилка. Подивіться тут gist.github.com/pmav99/137dbf4681be9a58de74 (original.py)
pmav99

2
Поточний приклад має помилку і не буде працювати, якщо підпис не включає аргументи за замовчуванням. Потрібно включити прапорець, щоб переконатися, що імена та за замовчуванням не мають значення None. Приклад: якщо імена та за замовчуванням:

36

Якщо ви використовуєте Python 2.6 або новішої версії, ви можете використовувати collection.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+ ви можете використовувати клас даних , який є дуже пітонічним і ремонтопридатним способом робити те, що ви хочете.

Це дозволяє визначити поля для вашого класу, які є вашими автоматично ініціалізованими змінними екземпляра.

Це виглядало б приблизно так:

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

__init__Метод вже буде в вашому класі.

Зверніть увагу, що тут потрібна підказка типу , саме тому я використав intі strв прикладі. Якщо ви не знаєте типу вашого поля, ви можете використовувати будь-який із typingмодуля .

Клас даних має багато переваг порівняно із запропонованими рішеннями:

  • Це чітко : усі поля видно, що поважає дзен Python і робить його читабельним та ремонтопридатним. Порівняйте з використанням **kwargs.
  • Він може мати методи . Як і будь-який інший клас.
  • Це дозволяє вийти за рамки автоматичного __init__використання __post_init__методу.

EDIT: Причини уникати використання NamedTuples

Деякі пропонують використовувати namedtupleдля цього випадку, але іменовані критерії мають деякі особливості поведінки, які відрізняються від класів Python, які спочатку насправді не очевидні і повинні бути добре відомими:

1. Іменовані коти незмінні

Незмінність може бути корисною, але, можливо, це не те, що ви хочете для своїх екземплярів. Класи даних також можуть бути якось незмінними, якщо ви використовуєте аргумент frozen=Trueна @dataclassдекораторі.

2. NamedTuples __eq__поводиться як Tuple

У Python SomeNamedTuple(a=1, b=2) == AnotherNamedTuple(c=1, d=2)є True! __eq__Функція NamedTuple, використовується для порівняння, тільки розглядає цінності і позицію цих значень в порівнянні примірників, а не імена їх або полів класів.


Це слід використовувати, лише якщо метою класу є зберігання даних.
JC Rocamonde

Або розвиватися навколо зберігання даних.
JC Rocamonde

3
Ви б пояснили, чому dataclass слід використовувати лише для класів, що зберігають дані, а не мати іншої поведінки? Я можу створити нову публікацію SO для цього, щоб краще зрозуміти відповідні випадки використання. Дякую.
Вахід Пазіранде

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

26

Цитуючи дзен Пітона ,

Явне краще, ніж неявне.


10
Чи не буде декларація списку ініціалізації достатньо явною?
Адам Матан,

Я вважаю. Але я не бачу причини додавати щось подібне до мови. Я явно віддаю перевагу кільком заявам про доручення перед якимись декоративними магіями за лаштунками.
Фердинанд Бейер,

29
@Ferdinand, я згоден, що було б нерозумно мати в мові щось, що цілком може бути в stdlib, але, це ПОВИННО бути в stdlib, тому що "красиве - це краще, ніж потворне", має перевагу, і багато повторюваних завдань є потворними (як і будь-яка форма повторення).
Алекс Мартеллі,

Ну, для протидії: DWIM> DWIS
Терренс Бреннон

Я б погодився, що декоратор
кращий

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
Хороший улов на видаленні "self"
Майкл

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

Можна також використовувати місцеві жителі () і наводити нормальні аргументи.
mk12

7

Рішення Наді є кращим і потужнішим, але я думаю, що це також цікаво:

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

Мені потрібно було щось із тією ж метою, але жодна з існуючих відповідей не охоплювала всіх випадків, які я перевірив. Відповідь Наді була найближчою до того, що я шукав, тому я почав з її коду як основи.

Декоратор нижче працює з усіма допустимими комбінаціями аргументів:

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

Можливо, не потрібно буде ініціалізувати змінні, оскільки local () вже містить значення!

клас Dummy (об'єкт):

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

d = фіктивний (2, 3)

д .парами

{'a': 2, 'b': 3, 'default': 'Fred'}

d.params ['b']

3

Звичайно, всередині класу можна використовувати self.params


Це хороший і оригінальний підхід, але d['b']написано в Пайтон загальновживаного часу 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 , який включає цю функцію як декоратор функцій. У модулі README зазначено, що " [...] продуктивність тепер лише на 30-40% гірша, ніж явна ініціалізація під CPython ".

Приклад використання, вилучений прямо з документації модуля :

>>> 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()див. Тут


0

Для цього є допоміжна функція у бібліотеці швидкого доступу https://fastcore.fast.ai/utils.html#store_attr .

from fastcore.utils import store_attr

class Process:
    def __init__(self, PID, PPID, cmd, FDs, reachable, user):
        store_attr() # this will do the same as self.PID = PID etc.
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.