Чи є гарною практикою оголошувати змінні екземпляра як None у класі в Python?

Розглянемо наступний клас:

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__), просто щоб змусити мій IDE щось ».

1. Зробіть свій код легким для розуміння

Код читається набагато частіше, ніж написаний. Зробіть полегшеним завдання Вашого коду (це може бути і ви наступного року).

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

Тому я зазвичай не лише визначаю все в конструкторі, але і прагну до мінімуму число змінних атрибутів.

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

Я думаю, що важливо визначити всіх членів в одному місці. Це робить код більш читабельним. Чи це всередині __ 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 , або вузький діапазон інших значень, все незмінне.

Він нагадує атавізм і надмірну прихильність до мов, які типово набираються. І це не корисно як код. Але це має другорядне призначення, яке залишається в документації.

Він документує, які очікувані імена, тому, якщо я поєдную код з кимось, і хтось із нас має "ім'я користувача", а інше ім'я користувача, люди можуть зрозуміти, що ми розлучились і не використовуємо однакових змінних.

Примушування повної ініціалізації як політики досягає того ж самого більш пітонічного способу, але якщо в коді є фактичний код __init__, це забезпечує більш чітке місце для документування використовуваних змінних.

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

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

залишає глобальний слід і не створює екземпляр для x.

Але це більше химерність в Python в цілому, ніж у цій практиці, і ми вже повинні бути параноїчними щодо цього.