Apakah ini praktik yang baik untuk mendeklarasikan variabel instan sebagai Tidak Ada dalam kelas dengan Python?

Pertimbangkan kelas berikut:

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

Rekan kerja saya cenderung mendefinisikannya seperti ini:

class Person:
    name = None
    age = None

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

Alasan utama untuk ini adalah bahwa editor pilihan mereka menunjukkan properti untuk pelengkapan otomatis.

Secara pribadi, saya tidak suka yang terakhir, karena tidak masuk akal bahwa kelas memiliki sifat-sifat tersebut None.

Yang mana yang akan menjadi praktik yang lebih baik dan untuk alasan apa?

Saya menyebut praktik buruk yang terakhir di bawah aturan "ini tidak melakukan apa yang Anda pikirkan".

Posisi rekan kerja Anda dapat ditulis ulang sebagai: "Saya akan membuat sekelompok variabel quasi-global kelas-statis yang tidak pernah diakses, tetapi yang mengambil ruang di berbagai tabel namespace kelas ( __dict__), hanya untuk membuat IDE saya lakukan sesuatu."

1. Buat kode Anda mudah dimengerti

Kode dibaca lebih sering daripada tertulis. Jadikan tugas pengelola kode Anda lebih mudah (mungkin juga Anda sendiri tahun depan).

Saya tidak tahu tentang aturan keras apa pun, tetapi saya lebih suka memiliki keadaan instance di masa depan yang dinyatakan dengan jelas. Menabrak dengan AttributeErrorsudah cukup buruk. Tidak melihat dengan jelas siklus hidup atribut instance lebih buruk. Jumlah senam mental yang diperlukan untuk mengembalikan kemungkinan urutan panggilan yang mengarah pada atribut yang ditugaskan dapat dengan mudah menjadi non-sepele, yang menyebabkan kesalahan.

Jadi saya biasanya tidak hanya mendefinisikan segala sesuatu di konstruktor, tetapi juga berusaha untuk menjaga jumlah atribut yang dapat diubah ke minimum.

2. Jangan mencampur anggota tingkat kelas dan tingkat kejadian

Apa pun yang Anda tetapkan tepat di dalam classdeklarasi adalah milik kelas dan dibagikan oleh semua instance kelas. Misalnya ketika Anda mendefinisikan fungsi di dalam kelas, itu menjadi metode yang sama untuk semua instance. Hal yang sama berlaku untuk anggota data. Ini sama sekali berbeda dengan atribut instance yang biasanya Anda definisikan __init__.

Anggota data tingkat kelas paling berguna sebagai konstanta:

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
    # ...

Secara pribadi saya mendefinisikan anggota dalam metode __ init __ (). Saya tidak pernah berpikir untuk mendefinisikan mereka di bagian kelas. Tetapi apa yang selalu saya lakukan: Saya init semua anggota dalam metode __ init__, bahkan mereka yang tidak diperlukan dalam metode __ init__.

Contoh:

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

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

Saya pikir penting untuk mendefinisikan semua anggota di satu tempat. Itu membuat kode lebih mudah dibaca. Apakah itu di dalam __ init __ () atau di luar, tidak begitu penting. Tetapi penting bagi sebuah tim untuk berkomitmen pada gaya pengkodean yang kurang lebih sama.

Oh, dan Anda mungkin memperhatikan bahwa saya pernah menambahkan awalan "_" ke variabel anggota.

Ini adalah praktik yang buruk. Anda tidak perlu nilai-nilai itu, mereka mengacaukan kode, dan mereka dapat menyebabkan kesalahan.

Mempertimbangkan:

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

Saya akan pergi dengan "sedikit seperti dokumen, lalu" dan menyatakan ini tidak berbahaya, selama itu selaluNone , atau kisaran sempit dari nilai-nilai lain, semua tidak berubah.

Itu berbau atavisme, dan lampiran berlebihan untuk bahasa yang diketik secara statis. Dan tidak ada gunanya sebagai kode. Tetapi memiliki tujuan kecil yang tersisa, dalam dokumentasi.

Ini mendokumentasikan apa nama yang diharapkan, jadi jika saya menggabungkan kode dengan seseorang dan salah satu dari kami memiliki 'nama pengguna' dan nama_pengguna lainnya, ada petunjuk bagi manusia bahwa kami telah berpisah dan tidak menggunakan variabel yang sama.

Memaksa inisialisasi penuh sebagai kebijakan mencapai hal yang sama dengan cara yang lebih Pythonic, tetapi jika ada kode aktual dalam __init__, ini menyediakan tempat yang lebih jelas untuk mendokumentasikan variabel yang digunakan.

Jelas masalah BESAR di sini adalah bahwa ia menggoda orang untuk menginisialisasi dengan nilai selain None, yang bisa buruk:

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

meninggalkan jejak global dan tidak membuat turunan untuk x.

Tapi itu lebih merupakan kekhasan dalam Python secara keseluruhan daripada dalam praktik ini, dan kita seharusnya sudah paranoid tentang hal itu.