プライベート変数とカプセル化 — getter / setter で安全にアクセスする

前回までで OOP の三大要素のうち継承とポリモーフィズムを押さえました。最後にカプセル化について解説します。

プライベート変数 — Python に「真のプライベート」は存在しない

Java や C++ にはprivateキーワードがあり、宣言した瞬間に外部からアクセスできなくなります。一方Python には言語が強制する真のプライベートは存在しません。代わりにアンダースコアの個数で「これは内部用ですよ」「直接触らないでください」とプログラマー間の約束として伝える慣習があります。

シングルアンダースコア _x — 慣習的プライベート

属性名の先頭に_ を 1 つ付けると、Python のコミュニティでは「この属性はクラスの内部で使うもの。外から直接アクセスしないでください」というメッセージになります。__init__の引数の方は普通の名前で受け取り、self に格納するときだけ _ を付けるのが定番です。

class UserAccount:
    def __init__(self, owner_name, balance):
        self._owner_name = owner_name      # 内部用 → _ を付ける
        self._balance    = balance

    def get_info(self):                     # 外向きの取り出し口
        return {"owner": self._owner_name, "balance": self._balance}


user = UserAccount("田中", 50000)
print(user._balance)        # 50000  ← 一応動くが推奨されない
print(user.get_info())      # {'owner': '田中', 'balance': 50000}  ← 推奨

ブログサイトの記事クラスBlogPostを題材に、_の意味を体感します（上のサンプルとは別のシナリオで同じパターンを書いてみる練習です）。

① class BlogPost:を定義し、__init__(self, title, views)でself._titleとself._viewsに代入してください。

② summary(self)メソッドを定義し、{"title": self._title, "views": self._views}をreturnしてください。

③ post = BlogPost("Python の始め方", 100)を作り、まず直接アクセスで post._viewsをprintしてください（動くが本来は禁止のパターン）。

④ 次に推奨パターンとしてpost.summary()の戻り値をprintしてください。

（正しく実行できれば解説が表示されます）

ダブルアンダースコア __x — 名前修飾（name mangling）

属性名の先頭に_ を 2 つ付けると、Python は内部で属性名そのものを書き換えます。たとえばAccountクラスの中でself.__pin = 1234と書くと、実際にインスタンスに保存される名前は_Account__pinに変換されます。これを名前修飾（name mangling）と呼び、外からobj.__pinと書いても見つからないため、事実上アクセスを難しくできます。

class Account:
    def __init__(self, owner, pin):
        self._owner = owner       # 慣習的プライベート
        self.__pin  = pin         # 名前修飾あり（_Account__pin に変換）

acc = Account("田中", 1234)

print(acc._owner)              # 田中             ← 普通に動く
# print(acc.__pin)             # AttributeError ← 直接は見えない
print(acc._Account__pin)       # 1234            ← 修飾された名前なら届く

ログインフォームのクラスLoginFormを題材に、__passwordが本当に名前変換されていることを目で確かめます（上のAccountサンプルとは別シナリオで同じ挙動を再現する練習です）。

① class LoginForm:を定義し、__init__(self, username, password)でself._username = usernameとself.__password = passwordを代入してください。

② form = LoginForm("taro", "p@ssw0rd")を作り、print(form._username)でシングル側はそのまま読めることを確認してください。

③ print(form._LoginForm__password)で名前修飾された属性経由でパスワード文字列が取れることを確認してください。

④ print([n for n in dir(form) if not n.startswith('__')])でインスタンス内に保存されている属性名一覧を出し、_LoginForm__passwordが並んでいることを目で確認してください。

「__」も完全な防壁ではない

ダブルアンダースコアは直接 obj.__pin ではアクセスできないという意味で 1 段強い保護になりますが、obj._Account__pinという変換後の名前を知っていれば結局触れます。完全プライベートではないことは押さえておきましょう。実プロジェクトでは特殊な事情がない限り、シングルアンダースコア _x を使う方が一般的です。

カプセル化 — メソッド経由で「触り方」を制限する

カプセル化は「データ属性とその操作（メソッド）を 1 つのクラスにまとめ、外部からは公開された入口だけを通してアクセスさせる」設計思想です。ではどのように外部に公開する入り口を作るのか考えましょう。

もっとも素朴な書き方は、get_xxx / set_xxxという名前のメソッドを自分で並べる方式です。セッターの中でisinstance による型チェックや値の範囲チェックを行い、おかしな値が来たらraise ValueError(...)で止めれば、_priceに変な値が入る心配がなくなります。

class Product:
    def __init__(self, name, price, stock):
        self._name  = name
        self._price = price
        self._stock = stock

    def get_price(self):
        return self._price

    def set_price(self, price):
        if isinstance(price, int) and price >= 0:
            self._price = price
        else:
            raise ValueError("price は 0 以上の整数で指定してください")


product = Product("Tシャツ", 1500, 30)
print(product.get_price())     # 1500
product.set_price(2000)
print(product.get_price())     # 2000
# product.set_price(-100)      # ValueError

ユーザー登録フォームの会員クラスUserProfileに、age（年齢）専用のゲッターとセッターを実装します。年齢にはマイナスや 200 歳といった不正値が入らないように、セッター側で範囲チェックをかけるのがポイントです。

① class UserProfile:を定義し、__init__(self, name, age)で_name / _ageに代入してください。

② get_age(self)を定義してreturn self._ageしてください。

③ set_age(self, age)を定義し、age が int 型かつ 0 以上 150 以下のときだけself._age = age、それ以外はraise ValueError("age は 0〜150 の整数で指定してください")してください。

④ user = UserProfile("田中", 30)を作り、user.get_age()をprintし、続けてuser.set_age(31)してから再度get_age()の結果をprintしてください。

⑤ 不正値の挙動を確認するため、try / except ValueError as e:でuser.set_age(-5)を囲み、print("NG:", e)を出力してください。

@property と @xxx.setter

get_price() / set_price(...)方式は分かりやすい一方で、呼び出し側のコードがメソッド呼び出しっぽくなりスマートではないです。Python ではより洗練された書き方として、@propertyと@xxx.setterという 2 つのデコレータを使う方法が主流です。

これを使うと、外から見たときの記法はproduct.price / product.price = 2000という属性そのものへのアクセスに見えるのに、実際には裏でゲッター／セッターメソッドが呼ばれるという二重構造になります。

class Product:
    def __init__(self, name, price):
        self._name  = name
        self._price = price

    @property
    def price(self):                 # ゲッター
        return self._price

    @price.setter
    def price(self, value):          # セッター。メソッド名はゲッターと一致させる
        if not isinstance(value, int) or value < 0:
            raise ValueError("price は 0 以上の整数で指定してください")
        self._price = value

    @property
    def label(self):                 # 計算プロパティ — 派生値も @property で表現できる
        return f"{self._name} ({self._price}円)"


product = Product("Tシャツ", 1500)
print(product.price)         # 1500           ← @property が呼ばれる
product.price = 2000         # ← @price.setter が呼ばれる
print(product.price)         # 2000
print(product.label)         # Tシャツ (2000円)  ← 計算プロパティ

セッターの名前はゲッターと「同じ」にする

@price.setterのpriceは直前の @property def price のメソッド名と必ず一致させます。Python は「priceという同じ名前のオブジェクトに、読み取り版と書き込み版を張り合わせる」ような形でデコレータを解釈するため、ここで名前がズレると別物として扱われます。

実践 3 と同じUserProfileを、@property / @age.setterに書き直し、さらに計算プロパティ age_group（未成年 / 成人 / シニア）を追加します。

① class UserProfile:を定義し、__init__(self, name, age)で_name / _ageに代入してください。

② @property def age(self):でreturn self._ageしてください。

③ @age.setter def age(self, value):を定義し、isinstance(value, int) and 0 <= value <= 150のときだけself._age = value、それ以外はraise ValueError("age は 0〜150 の整数で指定してください")してください。

④ @property def age_group(self):を定義し、self._age < 18なら"未成年"、self._age < 65なら"成人"、それ以上は"シニア"を返してください（セッターは作らない = 読み取り専用）。

⑤ user = UserProfile("田中", 30)を作ってuser.ageとuser.age_groupをprintし、続けてuser.age = 70で更新後にもう一度age_groupをprintしてください。

OOP 三大要素