Pythonのクラスでインスタンス変数をNoneとして宣言するのは良い習慣ですか？

次のクラスを検討してください。

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

私の同僚は、次のように定義する傾向があります。

class Person:
    name = None
    age = None

    def __init__(self, name, age):
        self.name = name
        self.age = age

これの主な理由は、選択したエディターがオートコンプリートのプロパティを表示することです。

個人的には、後者が嫌いNoneです。クラスにこれらのプロパティがに設定されていることには意味がないからです。

どちらがより良い練習であり、どのような理由でですか？

「これはあなたが思っていることをしない」というルールの下で、私は後者の悪い習慣と呼んでいます。

同僚の立場は次のように書き直すことが__dict__できます。何か。"

1.コードを理解しやすくする

コードは書かれているよりもずっと頻繁に読まれます。コードメンテナーのタスクを簡単にします（来年も自分自身になるかもしれません）。

厳格なルールについては知りませんが、将来のインスタンスの状態を明確に宣言することを好みます。でクラッシュするAttributeErrorだけで十分です。インスタンス属性のライフサイクルがはっきりと見えないのは悪いことです。属性の割り当てにつながる可能性のある呼び出しシーケンスを復元するために必要な精神的な体操の量は、簡単ではなく、エラーにつながる可能性があります。

したがって、私は通常、コンストラクターですべてを定義するだけでなく、可変属性の数を最小限に抑えるよう努めています。

2.クラスレベルとインスタンスレベルのメンバーを混在させないでください

class宣言内で定義するものはすべてクラスに属し、クラスのすべてのインスタンスで共有されます。たとえば、クラス内で関数を定義すると、すべてのインスタンスで同じメソッドになります。データメンバーにも同じことが当てはまります。これは、通常で定義するインスタンス属性とはまったく異なります__init__。

クラスレベルのデータメンバーは、定数として最も便利です。

class Missile(object):
  MAX_SPEED = 100  # all missiles accelerate up to this speed
  ACCELERATION = 5  # rate of acceleration per game frame

  def move(self):
    self.speed += self.ACCELERATION
    if self.speed > self.MAX_SPEED:
      self.speed = self.MAX_SPEED
    # ...

個人的には、__ init __（）メソッドでメンバーを定義します。クラス部分でそれらを定義することを考えたことがありません。しかし、私がいつもしていることは、__ init__メソッドで不要なメンバーも含めて、__ init__メソッドですべてのメンバーを初期化します。

例：

class Person:
    def __init__(self, name, age):
        self._name = name
        self._age = age
        self._selected = None

   def setSelected(self, value):
        self._selected = value

すべてのメンバーを1か所で定義することが重要だと思います。コードが読みやすくなります。__ init __（）の内部にあるか外部にあるかは、それほど重要ではありません。しかし、チームが多かれ少なかれ同じコーディングスタイルにコミットすることは重要です。

ああ、メンバー変数に接頭辞「_」を追加したことにお気づきかもしれません。

これは悪い習慣です。これらの値は必要ありません。コードが乱雑になり、エラーが発生する可能性があります。

考慮してください：

>>> class WithNone:
...   x = None
...   y = None
...   def __init__(self, x, y):
...     self.x = x
...     self.y = y
... 
>>> class InitOnly:
...   def __init__(self, x, y):
...     self.x = x
...     self.y = y
... 
>>> wn = WithNone(1,2)
>>> wn.x
1
>>> WithNone.x #Note that it returns none, no error
>>> io = InitOnly(1,2)
>>> InitOnly.x
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: class InitOnly has no attribute 'x'

「docstringsのようなビット」を使用して、これが常にである限りNone、または他の値の狭い範囲で、すべて不変である限り、この無害を宣言します。

それは、アタビズムと、静的に型付けされた言語への過度の執着を嫌う。そして、それはコードとしては役に立たない。しかし、ドキュメントには、小さな目的が残っています。

予想される名前が文書化されているので、コードを誰かと組み合わせて、誰かが「username」と他のuser_nameを持っている場合、別の方法で同じ変数を使用していないという手がかりがあります。

完全な初期化をポリシーとして強制すると、同じことをよりPython的な方法で実現できますが、に実際のコードがある場合は__init__、使用中の変数を文書化するより明確な場所を提供します。

明らかにここでの大きな問題は、人々が以外の値で初期化することを誘惑するNoneことです。

class X:
    v = {}
x = X()
x.v[1] = 2

グローバルトレースを残し、xのインスタンスを作成しません。

しかし、これはPython全体でこのプラクティスよりも奇妙なことであり、私たちはすでにそれについて偏執狂的であるはずです。