Wie vermeide ich das "self.x = x; self.y = y; self.z = z ”Muster in __init__?

Ich sehe Muster wie

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

ziemlich häufig, oft mit viel mehr Parametern. Gibt es eine gute Möglichkeit, diese Art von langwieriger Wiederholung zu vermeiden? Sollte die Klasse namedtuplestattdessen erben ?

Bearbeiten: Wenn Sie Python 3.7+ haben, verwenden Sie einfach Datenklassen

Eine Dekorationslösung, die die Signatur behält:

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

Haftungsausschluss: Es scheint, dass mehrere Personen besorgt sind, diese Lösung vorzustellen, daher werde ich einen sehr klaren Haftungsausschluss geben. Sie sollten diese Lösung nicht verwenden. Ich gebe es nur als Information, damit Sie wissen, dass die Sprache dazu in der Lage ist. Der Rest der Antwort zeigt nur die Sprachfähigkeiten und unterstützt sie nicht auf diese Weise.

Es ist eigentlich nichts Falsches daran, Parameter explizit in Attribute zu kopieren. Wenn Sie zu viele Parameter im ctor haben, wird dies manchmal als Codegeruch angesehen, und Sie sollten diese Parameter möglicherweise in weniger Objekte gruppieren. In anderen Fällen ist es notwendig und es ist nichts falsch daran. Auf jeden Fall ist es der richtige Weg, dies explizit zu tun.

Da Sie jedoch fragen, wie dies getan werden kann (und nicht, ob es getan werden soll), lautet eine Lösung:

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

Wie andere bereits erwähnt haben, ist die Wiederholung nicht schlecht, aber in einigen Fällen kann ein benanntes Tupel gut zu dieser Art von Problem passen. Dies vermeidet die Verwendung von Einheimischen () oder Kwargs, was normalerweise eine schlechte Idee ist.

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

Ich habe eine begrenzte Verwendung dafür gefunden, aber Sie können ein benanntes Tupel wie bei jedem anderen Objekt erben (Beispiel wird fortgesetzt):

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

explizit ist besser als implizit ... so sicher, dass Sie es prägnanter gestalten können:

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

Die bessere Frage ist, sollten Sie?

... das heißt, wenn Sie ein benanntes Tupel möchten, würde ich die Verwendung eines benannten Tupels empfehlen (denken Sie daran, dass an Tupel bestimmte Bedingungen geknüpft sind) ... vielleicht möchten Sie ein geordnetes Diktat oder sogar nur ein Diktat ...

Um die gruszczyAntwort zu erweitern , habe ich ein Muster wie das folgende verwendet:

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

Ich mag diese Methode, weil es:

• vermeidet Wiederholungen
• ist beim Erstellen eines Objekts gegen Tippfehler resistent
• funktioniert gut mit Unterklassen (kann nur super().__init(...))
• Ermöglicht die Dokumentation der Attribute auf Klassenebene (wo sie hingehören) und nicht in X.__init__

Vor Python 3.6 gibt dies keine Kontrolle über die Reihenfolge, in der die Attribute festgelegt werden. Dies kann ein Problem sein, wenn einige Attribute Eigenschaften mit Setzern sind, die auf andere Attribute zugreifen.

Es könnte wahrscheinlich ein bisschen verbessert werden, aber ich bin der einzige Benutzer meines eigenen Codes, sodass ich mir keine Sorgen über irgendeine Form der Eingabesanierung mache. Vielleicht AttributeErrorwäre ein passender.

Sie könnten auch tun:

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

Natürlich müssten Sie das inspectModul importieren .

Dies ist eine Lösung ohne zusätzliche Importe.

Hilfsfunktion

Eine kleine Hilfsfunktion macht es bequemer und wiederverwendbarer:

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)

Anwendung

Sie müssen es aufrufen mit locals():

class A:
    def __init__(self, x, y, z):
        auto_init(locals())

Prüfung

a = A(1, 2, 3)
print(a.__dict__)

Ausgabe:

{'y': 2, 'z': 3, 'x': 1}

Ohne Veränderung locals()

Wenn Sie nicht ändern möchten, locals()verwenden Sie diese Version:

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)

Eine interessante Bibliothek, die dies handhabt (und viele andere Boilerplates vermeidet), ist attrs . Ihr Beispiel könnte zum Beispiel darauf reduziert werden (vorausgesetzt, die Klasse heißt MyClass):

import attr

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

Sie brauchen nicht einmal __init__mehr eine Methode, es sei denn, sie erledigt auch andere Dinge. Hier ist eine schöne Einführung von Glyph Lefkowitz .

Meine 0,02 $. Es ist sehr nah an Joran Beasleys Antwort, aber eleganter:

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)

Zusätzlich kann die Antwort von Mike Müller (die beste nach meinem Geschmack) mit dieser Technik reduziert werden:

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

Und der gerade Anruf auto_init(locals())von Ihrem__init__

Es ist eine natürliche Art, Dinge in Python zu tun. Versuchen Sie nicht, etwas Klügeres zu erfinden, da dies zu übermäßig cleverem Code führt, den niemand in Ihrem Team verstehen wird. Wenn du ein Teamplayer sein willst und es dann so weiter schreibst.

Ab Python 3.7

In Python 3.7 können Sie (ab) den dataclassDekorator verwenden, der im dataclassesModul verfügbar ist . Aus der Dokumentation:

Dieses Modul bietet einen Dekorator und Funktionen zum automatischen Hinzufügen generierter Spezialmethoden wie __init__()und__repr__() zu benutzerdefinierten Klassen. Es wurde ursprünglich in PEP 557 beschrieben.

Die in diesen generierten Methoden zu verwendenden Elementvariablen werden mithilfe von Annotationen vom Typ PEP 526 definiert. Zum Beispiel dieser Code:

@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

Fügt unter anderem __init__()Folgendes hinzu:

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

Beachten Sie, dass diese Methode automatisch zur Klasse hinzugefügt wird: Sie wird in der oben gezeigten InventoryItem-Definition nicht direkt angegeben.

Wenn Ihre Klasse groß und komplex ist, kann es unangemessen sein, a zu verwenden dataclass. Ich schreibe dies am Tag der Veröffentlichung von Python 3.7.0, daher sind die Verwendungsmuster noch nicht gut etabliert.