Как избежать шаблона "self.x = x; self.y = y; self.z = z" в init?

Question

Как избежать шаблона "self.x = x; self.y = y; self.z = z" в init?

Я вижу такие шаблоны, как

def __init__(self, x, y, z):
    ...
    self.x = x
    self.y = y
    self.z = z
    ...

довольно часто, часто с гораздо большим количеством параметров. Есть ли хороший способ избежать такого утомительного повторения? Должен ли класс наследовать от namedtuple вместо?

173

python python-2.7 python-decorators namedtuple python-attrs

Источник

user1937197 04 фев '16 в 01:22

11 ответов

Решение

Отказ от ответственности: Кажется, что несколько человек обеспокоены представлением этого решения, поэтому я предоставлю очень четкую оговорку. Вы не должны использовать это решение. Я предоставляю это только в качестве информации, так что вы знаете, что язык способен на это. Остальная часть ответа просто показывает языковые возможности, а не одобряет их использование таким образом.

Нет ничего плохого в том, чтобы явно копировать параметры в атрибуты. Если в 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

109

Источник

user98494 04 фев '16 в 01:29

Явное лучше, чем неявное... так что вы можете сделать его более кратким:

def __init__(self,a,b,c):
    for k,v in locals().items():
        if k != "self":
             setattr(self,k,v)

Лучший вопрос, должен ли ты?

... при этом если вы хотите именованный кортеж, я бы порекомендовал использовать именованный кортеж (помните, что у кортежей есть определенные условия): возможно, вы хотите упорядоченный приговор или даже просто диктовку...

30

Источник

user541038 04 фев '16 в 01:27

Как уже упоминалось, повторение неплохое, но в некоторых случаях именованный кортеж отлично подходит для такого типа проблем. Это позволяет избежать использования 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()

29

Источник

user5802889 04 фев '16 в 02:48

Расширить на gruszczys ответ, я использовал шаблон как:

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 это не давало контроля над порядком, в котором установлены атрибуты, что может быть проблемой, если некоторые атрибуты являются свойствами с установщиками, которые обращаются к другим атрибутам.

Возможно, это можно немного улучшить, но я единственный пользователь своего собственного кода, поэтому я не беспокоюсь о какой-либо форме санитарии ввода. Возможно AttributeError было бы более уместным.

22

Источник

user974555 04 фев '16 в 08:31

Вы также можете сделать:

locs = locals()
for arg in inspect.getargspec(self.__init__)[0][1:]:
    setattr(self, arg, locs[arg])

Конечно, вам придется импортировать inspect модуль.

10

Источник

user5827958 04 фев '16 в 01:35

Это решение без какого-либо дополнительного импорта.

Вспомогательная функция

Небольшая вспомогательная функция делает ее более удобной и многократно используемой:

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)

8

Источник

user837534 06 фев '16 в 09:59

Python 3.7 и выше

В Python 3.7 вы можете (ab) использовать dataclass декоратор, доступный от dataclasses модуль. Из документации:

Этот модуль предоставляет декоратор и функции для автоматического добавления сгенерированных специальных методов, таких как __init__() а также __repr__() для пользовательских классов. Первоначально он был описан в PEP 557.
Переменные-члены, используемые в этих сгенерированных методах, определяются с помощью аннотаций типа 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.

Если ваш класс большой и сложный, может быть нецелесообразно использовать dataclass, Я пишу это в день выпуска Python 3.7.0, поэтому шаблоны использования еще не установлены.

8

Источник

user974555 27 июн '18 в 13:56

Интересная библиотека, которая обрабатывает это (и избегает многих других шаблонов), является attrs. Ваш пример, например, может быть сведен к этому (предположим, что класс называется MyClass):

import attr

@attr.s
class MyClass:
    x = attr.ib()
    y = attr.ib()
    z = attr.ib()

Вам даже не нужно __init__ метод больше, если он не делает другие вещи, а также. Вот хорошее введение от Глифа Лефковица.

7

Источник

user183054 06 янв '17 в 10:04

Мой 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)

Кроме того, ответ Майка Мюллера (лучший на мой вкус) можно уменьшить с помощью этой техники:

def auto_init(ns):
    self = ns.pop('self')
    vars(self).update(ns)

И просто позвони auto_init(locals()) от твоего __init__

5

Источник

user1394590 10 фев '16 в 09:26

Это естественный способ делать вещи в Python. Не пытайтесь придумать что-то более умное, это приведет к чрезмерно умному коду, который никто в вашей команде не поймет. Если вы хотите быть командным игроком, а затем продолжайте писать это так.

4

Источник

user80237 21 фев '16 в 01:35

Другие вопросы по тегам python python-2.7 python-decorators namedtuple python-attrs

user3276974 04 фев '16 в 07:24 2016-02-04 07:24 · Accepted Answer · 2016-02-04 07:24

Решение для декоратора, которое сохраняет подпись:

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__))

Как избежать шаблона "self.x = x; self.y = y; self.z = z" в __init__?

11 ответов

Вспомогательная функция

заявка

Тестовое задание

Без изменения locals()

Python 3.7 и выше

Как избежать шаблона "self.x = x; self.y = y; self.z = z" в init?

Без изменения `locals()`