クラス変数の初期化について

Question

Pythonのみならず他の言語でも関係すると思いますが、クラス変数の初期化についての質問です。

初期化を行う際、関数をもちいて値をセットしたい場合があります。

そういった場合、
関数内でセットしてしまうのか、関数によって返ってきた値をセットするのか、
どちらが良いのでしょうか？

class Example():
  def __init__(self):
    self.X = setX()

  def setX():
    return 1

class Example():
  def __init__(self):
    self.X = 0
    self.setX()

  def setX(self):
    self.X = 1

上の方が自然な感じもしますが、下のような書き方も見たことがあります。

Answer 1

回答の前に、一つ用語の誤用を指摘します。
その変数Xは、クラス変数では無くインスタンス変数です。

クラス変数とはクラス宣言直下に置いた変数のことで、他言語のstaticメンバに相当します。

本題

関数内でセットしてしまうのか、関数によって返ってきた値をセットするのか、どちらが良いのでしょうか？

関数によって返ってきた値をセットする、一番目のコードの方法が一般的でしょう。
インスタンス変数を様々なメソッド内で生成すると、どんな属性があるのか管理しきれなくなります。

pylintも次のコードに対しデフォルトで警告を発します。W: の行です。

class Spam:
    def method(self):
        self.answer = 42

>python -m pylint sample.py
No config file found, using default configuration
************* Module sample
C:  1, 0: Missing module docstring (missing-docstring)
C:  1, 0: Missing class docstring (missing-docstring)
C:  2, 4: Missing method docstring (missing-docstring)
W:  3, 8: Attribute 'answer' defined outside __init__ (attribute-defined-outside-init)
R:  1, 0: Too few public methods (1/2) (too-few-public-methods)

---

SOでも同じような議論が交わされています。ぜひ目を通してみて下さい。
python - Instance attribute attribute_name defined outside init - Stack Overflow

Comments

[LouiS0616]

結論部分を真逆に書いていたので修正しました。

[LouiS0616]

説明とコードの順序が捻じれていてややこしいので、誤解の生じないよう表現を変更しました。

[hi-se]

用語の誤りの指摘、ありがとうございます。

init内で
self.answer　= None　
などと記述した際も同じようにpylintで指摘されるのでしょうか？

[LouiS0616]

> init内で ~ 同じようにpylintで指摘されるのでしょうか？

されないです。
この点で私は、__init__内での変数の初期化は、属性の表明に通ずるものだと感じています。

実際次のように書いても警告は回避できますし。

class Spam:
__answer: int

__def method(self):
____self.answer = 42

Answer 2

個人的には前者をオススメしたいです。
ちなみに、前者のコードに誤りがあるので、修正します。

class Example():
  def __init__(self):
    # self.X = setX() <--- self が無いです。
    self.X = self.setX()
    
  # def setX():  <--- self が無いです。
  def setX(self):
    return 1

example = Example()

副作用

なぜなら後者は「副作用」を持っているからです。
副作用というのは、属性（インスタンス変数、またはクラス変数）を変化させることです。

• Python の属性 - クラス変数とインスタンス変数ってなに？

後者のコードは X が１度 0 になってから 1 に変化しています。
これが「副作用」です。

最近プログラムを書くときに「副作用」を嫌傾向にある気がします。
「副作用」をあまり許さない言語として
Elixir や Elm などがあり、これを「関数型言語」と呼ばれるのを目にします。

なぜ「副作用」が嫌われる傾向にあるのかは、こちらに書きました。

• 副作用ってなに？

PEP 8

ちなみに Python では PEP 8 というコーディング規約が使われていています。
本当にほとんど全ての Python を書く人はこれに従っています。
PEP 8 はキャメルケースではなくスネークケースです。

class Example():
  def __init__(self):
    # self.X = self.setX()
    self.X = self.set_x()
  
  # def setX(self):
  def set_x(self):
    return 1

example = Example()

従わないといけない訳では無いのですが、
PEP 8 に沿っておいた方が無難かなという気がします。

• PEP 8 ってなに？

staticmethod

staticmethod を使うと self を書かなくても動くようになります。
staticmethod は使えるときには積極的に使うのが
副作用が無いことを明示している点で望ましいと個人的に感じています。

class Example():
  def __init__(self):
    # self.X = self.setX()
    self.X = self.set_x()
  
  # def set_x(self):
  @staticmethod
  def set_x():
    return 1

example = Example()

• classmethod と staticmethod ってなに？

Comments

[hi-se]

「副作用」というプログラミングをする上での懸念点について触れていただき、また新たに幅が広がったように思います。

自分の間違いを全て指摘していただきありがとうございますorz

用語や記法、しっかりと正しく使っていこうと思います。

[nico25]

そう言っていただけると助かります :)

Answer 3

質問で "関数をもちいて値をセットしたい" とぼんやりとしか書かれていないこの部分の動機次第じゃないでしょうか。
特に、今 setX というまったくよくない名前が付いているこの関数が一体何をするのか、それが明らかになる必要があると思います。

---

def caluculate_x_from_other_environments():
    x = ...  # 何かからxの初期値を計算する
    return x

という関数が外にあったり、あるいはメソッドとしてクラスの中にあるのなら

  def __init__(self):
    self.X = caluculate_x_from_other_environments()  # これは関数が外にある場合

が自然でしょう。

---

    def set_x_and_initialyze_hogehoge(self, x) -> None:
        self.X = x
        ...  # そしてx(self.X)を元に何か別のことをやる必要がある

というメソッドを想定するなら

  def __init__(self):
    self.set_x_and_initialyze_hogehoge(1)

が自然でしょう。

---

初期化をどうするべきか? なんて考えても無駄です。
setXがどういう関数であるべきか? を考えたら初期化の方はそれに応じて自然と決まるはずです。

---

本当に初期化だけが問題の争点であるなら、それはつまり初期化以外のタイミングでその処理をすることがないことが確実だという話になります。
ならば、それを関数にする必要はない、と答えます。

  def __init__(self):
    self.X = 1

もしくは

  def __init__(self):
    val = ...
    # なんか難しい処理
    self.x = 1

とするべきだと思っています。

Comments

[hi-se]

僕のような素人が「可読性」について言及するのは大変おこがましいことですが、
init関数内にインスタンス変数が全て明確に示されている方が"読みやすく"感じます。

確かに、関数が何をするかによって記述の方法が変わってくるのはその通りですね、、、
(適当なsampleのためにsetXなどといった無意味な関数名を用いたのは間違いでしたorz)