Python は他の多くのプログラミング言語同様にオブジェクト指向プログラミングの標準的な機能を備えています。Python（Python3）のクラスとオブジェクトの基本をサンプルコード付きで解説します。
公式ドキュメント
https://docs.python.org/ja/3/tutorial/classes.html
クラスとオブジェクトの実例
ECサイトで商品をカートに入れて合計金額を表示するための処理を例にサンプルコードを書いてみました。下記では商品クラス（Item）とカートクラス（Cart）の2つのクラスを定義、そのインスタンスオブジェクトを用いています。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
""" Python3 のクラスとオブジェクトの基本サンプル 学習目的のため実際上必要な処理を適宜省略しています。 """ class Item: """ 商品クラス """ """ 商品リスト Pythonではメソッド外で定義した変数は「クラス変数」になる点に注意しましょう。 クラス変数はこのクラスから生成したすべてのインスタンスで共有されます。 商品リストをクラス変数にする必要はありませんが、サンプルのためクラス変数にしてみました。 """ item_list = [ {'name': 'None', 'price': 0}, {'name': 'pencil', 'price': 100}, {'name': 'eraser', 'price': 80}, {'name': 'compass', 'price': 300}, ] def __init__(self, item_id): """ コンストラクタ :param item_id: 商品ID """ item = self.search_item_by_id(item_id) """ メソッド内で self.name のように定義すると「インスタンス変数」になります。 インスタンス変数は生成したインスタンス固有のものとなります。 """ self.id = item_id self.name = item['name'] self.price = item['price'] def search_item_by_id(self, item_id): """ 商品情報をセット :param item_id: 商品ID :rtype: dict :return: 商品データ（辞書型） """ # 簡単のためitem_idのチェックは省略 return self.item_list[item_id] class Cart: """ ショッピングカートクラス """ def __init__(self): self.items = [] def add_item(self, item, number): """ 商品をカートに加える :param item: Itemオブジェクト :param number: 数量 :return: None """ for i in range(number): # 説明のため print() しますが、ビュー以外で print() するのは保守性を著しく低下させるのでやめましょう。 print(item.name + ': ' + str(item.price) + '円') self.items.append(item) def calc_subtotal(self): """ 小計を計算 :return: 小計金額 """ p = 0 for item in self.items: p += item.price return p @staticmethod def add_tax(price): """ 税を加算（税込金額を取得） メソッド定義の直前に @staticmethod デコレータを書くとスタティックメソッドになります。 スタティックメソッドはインスタンス化なしに使用できる静的メソッドです。 引数に self は不要となる点に注意しましょう。 :param price: 金額 :return: 税込価格 """ return int(round(price + price * TAX_RATE * 0.01)) # 税率を設定 TAX_RATE = 8 # 商品をカートに追加して小計と合計を計算 my_cart = Cart() my_cart.add_item(Item(1), 2) # 鉛筆2個 my_cart.add_item(Item(2), 1) # 消ゴム1個 my_cart.add_item(Item(3), 1) # コンパス1個 subtotal = my_cart.calc_subtotal() # 小計 # staticmethod はインスタンス化せず クラス名.メソッド名() で実行可能。 total = Cart.add_tax(subtotal) # 合計 print('----------------') print('小計: ' + str(subtotal) + '円') print('合計: ' + str(total) + '円') print('----------------') # staticmethod は インスタンス.メソッド名() でも実行可能です。 print('合計: ' + str(my_cart.add_tax(subtotal)) + '円 - インスタンスメソッドで計算') |
実行結果は以下のようになります。
|
1 2 3 4 5 6 7 8 9 |
pencil: 100円 pencil: 100円 eraser: 80円 compass: 300円 ---------------- 小計: 580円 合計: 626円 ---------------- 合計: 626円 - インスタンスメソッドで計算 |
Github にこのページのソースコードをアップしています。
https://github.com/toksan/python3_study/blob/master/class/example_basic_1.py
Pythonのクラスの注意点（主に多言語経験者向け）
1. コンストラクタ・デストラクタ
コンストラクタは def __init__(self): となります。引数をもつ場合は def __init__(self, arg1, arg2): のように書きます。上記サンプルでは使用していませんが、デストラクタは __del__ というメソッドになります。
2. インスタンスメソッドの第一引数は必ず self
インスタンスメソッドを定義するとき最初の引数は必ず self にします。selfはインスタンス自身のことで、Java/JavaScript/PHPの this （$this）のようなものです（thisとは色々違いますが…）。
多言語経験者からすると毎回selfと書くのがめんどくさく感じるかもしれませんが、PyCharmのようなPython用のIDE / エディタ使用すれば自動補完・入力してくれます。
メソッドを呼び出して使うときには self に対応する引数は不要であることに気をつけましょう。たとえば def set_name(self, str): を呼び出すときは object.set_name(‘太郎’) のように引数は１つだけです。
なお、def_set_name(this, str): というふうに最初の引数を「self」でなくて「this」としても構文上は問題ありませんが、Pythonではselfにするのが一般的です。self ついて公式ドキュメントでは下記のように書かれています。
よく、メソッドの最初の引数を self と呼びます。この名前付けは単なる慣習でしかありません。 self という名前は、 Python では何ら特殊な意味を持ちません。とはいえ、この慣行に従わないと、コードは他の Python プログラマにとってやや読みにくいものとなります。また、 クラスブラウザ (class browser) プログラムがこの慣行をあてにして書かれているかもしれません。
https://docs.python.org/ja/3/tutorial/classes.htmlより引用
3. メソッド外で定義した変数
Pythonではメソッド外で定義した変数は（インスタンス変数ではなく）「クラス変数」になり、インスタンス間で共有されることに注意しましょう。他言語経験者はハマる可能性が大きいかと思います。
※上記サンプルスクリプトの Item.item_list が該当します。
インスタンス変数はコンストラクタ（__init__メソッド）でまとめて定義（+初期化）するのがよいでしょう。
4. アクセス修飾子はない！
private や protected などのアクセス修飾子はありません。原則 public となりますが、def __hoge(self): のようにメソッドや変数の前にアンダースコアを2つつけると private 相当になり、インスタンスから直接アクセスできなくなります。（ただし、アクセスする方法があるので、他言語のprivateとは若干異なります。）
あとは慣習ですが、アンダースコア1つをつけると private 相当に扱うという暗黙のコーディングルールがあります。
オブジェクトの中からしかアクセス出来ない 「プライベート」 インスタンス変数は、 Python にはありません。しかし、ほとんどの Python コードが従っている慣習があります。アンダースコアで始まる名前 (例えば _spam) は、 (関数であれメソッドであれデータメンバであれ) 非 public なAPIとして扱います。これらは、予告なく変更されるかもしれない実装の詳細として扱われるべきです。
https://docs.python.org/ja/3/tutorial/classes.html より引用
5. new は不要
サンプルコードからもわかりますが、インスタンス化するにあたって new は不要です。返り値のある関数と同じシンタックスになります。
Python のクラスとオブジェクトの基本（１）は以上となります。Python（Python3） のクラス・オブジェクトは良くも悪くもカジュアルなので、変数名やメソッド名には注意する必要があるでしょう。
コメントを残す