クラスのメンバー変数をpublicじゃなくprivateにしてgetter、setter関数を定義して呼び出す意味とは？

Question

クラスのメンバー変数をわざわざpublicじゃなくprivateにしてgetter、setter関数を定義して呼び出す意味がなんでかわかりません。

class MyClass:
    def __init__(self):
        self._x = 12345
    @property
    def x(self):
        return self._x
    @x.setter
    def x(self,x):
        self._x = x
instance = MyClass()
print(instance.x)

これはクラスの変数をプライベートにしてgetter、setter変数を介して変数にアクセスできるようにしています。

class MyClass:
    def __init__(self):
        self.x = 12345
instance = MyClass()
print(instance.x)

しかし、わざわざわかりにくく書かなくても最初からprivateなんてせずにこう書けばいいんじゃないかと思ってしまいます。
以前、PHPの勉強をしている時このような書き方を見た時はあまり意義がわからず、放置していたのですが、pythonでも出て来て、なぜこのような煩わしい書き方をするのかはっきりさせておきたいと思いました。
わかる方、教えてください。よろしくお願いします。

Answer 1

例えば人を表すクラスを考えるとします。身長と体重が必要ですかね。
言うまでもなく、身長と体重は負の数になることはあり得ません。

もし、人クラスの身長が public だったら、負の数を設定しても、設定した時点でそれを検知することもできません。private で setter があれば、設定しようとする値をチェックして、明らかにおかしな値（負数だったり250cm超えてたり）だったら、設定させないとか例外を生成するとか、整合性を保つことができるのです。

メンバ変数だと冗長に思えるかも知れませんが、プロパティの概念のある言語だと、通常の代入のように見えて実は setter が呼ばれたりして、可読性がよく堅固なコードを記述できます。

Answer 2

とりあえず思いついたものから。

①getter/setter片方だけを実装することができます。

読み出せるが、書き換えることができないようにしたり、
書き換えられるが今あるものを読み出せないようにしたり。

②挙動を付け加えることができます。

書き換えた時にログを残しておいたり、
読みだす時に、バリデーションをかけたり。

Comments

[tachikoma]

②はクラスの振る舞いを変えずにリファクタリングする時に便利。

Answer 3

アンダーバーを付けたメンバー変数をprivateと呼ぶ回答が多いので補足的な意味合いで回答します。

Pythonにはいわゆるprivateは存在せず、アンダーバーから始まる変数はモジュールやクラスの内部用であることを慣習的に示しているに過ぎません。例えば、_xとしてもinstance._xでアクセスできます。ただし、__xのようにアンダーバーを先頭に2つ以上付けるとname manglingと呼ばれる機能にアクセスしにくくなります。

Comments

[退会済みユーザー]

なるほど、確かにそうなってますね。
慣習的にということは、実質的な意味においてはプロパティの先頭に_をつけることは何も効果が無いということでしょうか？

[tachikoma]

tabキーなどによるコード補完機能で頭に_が一つのものは表示しないというルールがある程度ですね。

[LouiS0616]

後は * を用いたimportにも影響しますね。
まあこれも from module import _spam とか明示的に書かれては無力なわけですが。

[tachikoma]

それがありましたか。フォローありがとうございます。

Answer 4

こういう仕組みって、一回動いたらOKというプログラムを書くだけ（例えばプログラミングを学び始めた時など・・・）なら、まったくありがたみがわからないように思います。

一度書いたプログラムの処理改善や、機能追加をする時、一部分の変更が、いろんなところに影響して、芋づる式に変更箇所が増えていくと、「修正するより作り直した方が・・・」という事になってしまいます。

毎度、リニューアルしていては大変ですので、そうならないように、できるだけメンテナンスしやすいプログラムを書くための仕組み、知恵だと思います。

たとえば、MyClass.xは数値が代入される変数だとすると、それを参照する外部のロジックも当然、数値として扱うことになります。

その後、MyClassにある機能追加をしようとした時、MyClass.xの値は、文字列で持った方が都合が良いことがわかった時、直接参照されていると、すべての外部ロジックも文字列を扱うよう編集しなければならなくなります。

getter(プロパティ)としてMyClass.xを提供していれば、MyClass._xとして、文字列を持ち、MyClass.xとしては、MyClass._xを数値に変換した値を渡すことができるので、より影響が少なく変更を行えます。

外部ロジックから、MyClass.xに数値が代入された時も、setterで、MyClass._xに文字列変換して格納することで、内部処理の都合にも合わせることができます。

Answer 5

すべて自分で書いて、覚えているということであればあんまり意味はありません。
役に立つのは、ほかの人と共同で書くようになった時や、長くて複雑なコードを書くときです。
public にしておけば確かにすべての場所からアクセスできるので便利なんですが、逆に言えばすべての場所から好きにいじれるということです。
コンプライアンス的に変数の中身を教えたくない、勝手に変数の中をいじられたくない、いじられると壊れてしまう。
などといったときにprivateにしておけば外部からのアクセスはgetterとsetterを通してでしかアクセスできなくなります。

ほかの人も言っていた通り、冗長性を高める目的でprivateは使うこと多いです。

Answer 6

誰かがinstance.xに変な値を代入しちゃうかもしれません。あるいは、気軽にprintしてみたらパスワードとか機密情報が入っていて大変、とか。

また、外から見ると一つの状態に見えるだけで、内部的には変更があるたびに整合を取るための処理が走るとかのパターンも……（いやだな、それ）。

実際問題としては、基本的にpythonはゆるいので、有名ライブラリでもself.x的な（publicにする）方法で済ませているものはたくさんあります。要求される安全性の水準が高くなくて、プロパティにする他の動機（便利に使えるとか）がなければやらなくても良いとは思います。