4.3 インスタンスメソッドとクラスメソッドについて

インスタンスメソッドとクラスメソッドについて

4.3 インスタンスメソッドとクラスメソッドについて

インスタンス変数とクラス変数について勉強してきましたが、実はメソッドにもインスタンスメソッド、クラスメソッドと呼ばれるものがあり、インスタンスを介してアクセスできるのか、クラスから直接アクセスできるのかによって分類できます。
ここではインスタンスメソッドとクラスメソッドについて説明していきます。

4.3.1 デコレータについて

インスタンスメソッドとクラスメソッドについて理解するためには、まずデコレータについて学ぶ必要があります。
デコレータとは、既存の関数(メソッド)の処理を引き継ぐためのもので、既存の関数(メソッド)の中身を直接変更せずに、機能の追加や変更を実現する上で便利なものです。

似たような処理をする関数を作る手間を省くために、デコレータが使われます。具体的にデコレータを実行する方法について確認していきましょう。

1. 一般的な書式

まずデコレータは、新しく定義する関数(デコレートされる関数)を介して、継承元となる既存の関数(デコレートする関数)の処理を実行します。
デコレータを実行するにあたり以下の2点が必要になります。

既存の関数(デコレートする関数)に第一引数(func)を指定する
新しい関数(デコレータされる関数)を定義する前の行で、「@デコレートする関数の名前」を記載する
新しい関数を実行する際には、基本的には括弧( )は不要

書式

func1をデコレートする関数(既存の関数)、func2をデコレートされる関数(新しく定義される関数)として、書式をまとめると以下のようになります。

「( )」括弧をつけずにデコレートされる関数(func2)を読み込むと、func2は実行されず、func2自身を引数に、デコレートする関数(func1)が実行されます。
またデコレータする関数(func1)の引数は自由に指定できますが、当テキストではfuncで統一させていただきます。

凡例

1#デコレートする関数を定義
2def func1(func):
3    print("func1")
4 
5#func1の処理を加えるfunc2を定義
6@func1
7def func2():
8    print(‘func2’)
9 
10#func2を読み込む
11func2

実行結果

1 func1

凡例からfunc2が読み込まれてますが、func2の処理は読み込まれず、そのままfunc1が実行されているのがわかります。

図 4.3.1：デコレータ

2. デコレータされる関数の処理を反映させた場合の書式

デコレータでは、新しく定義した関数(以下、func2を記載します。)そのものを引数に既存の関数(以下、func1と記載します。)の処理を実行しましたが、func2の処理の内容を反映させるにはどうすれば良いのでしょうか？

書式

func1は、func2を引数に処理が実行されるため、func1の処理内にfunc2を実行させる命令文を記載すれば、func2の内容は反映されます。
書式にまとめると以下の通りになります。

凡例

1#デコレートする関数を定義
2def func1(func):
3    print("func1")
4    #func2の処理を実行
5    func()
6#func1の処理を加えるfunc2を定義
7@func1
8def func2():
9    print("func2")
10 
11func2

実行結果

1 func1

2 func2

func2が読み込まれていると同時に、func1が実行され、func1の引数としてfunc2が読み込まれているため、引数として指定したfunc()を命令文に記載すると、func1の処理を通じてfunc2が実行されます。
実行結果からfunc2の処理内容より、先にfunc1の処理内容が読み込まれ、その後、func1の処理内容が実行されているので、func1の処理の内容に沿った実行結果になっていることがわかります。

図 4.3.2：デコレータ②

4.3.2 インスタンスメソッドについて

以上がデコレータになります。続いて本題であるインスタンスメソッド、クラスメソッドに戻りたいと思います。

1. インスタンスメソッドとは

まずインスタンスメソッドとは、コンストラクタが定義されたクラス内において、インスタンス自身を紐づかせるためのメソッドです。
直接、アクセスすることはできず、インスタンスを生成した上で、インスタンスを介してアクセスすることができます。

今までコンストラクタを学習する上で扱ってきたメソッドそのものが、インスタンスメソッドに該当します。

2. インスタンスメソッドの定義方法

インスタンスメソッドを定義する際には、第一引数(以下、selfで統一します。)を指定しなければなりません。
selfにはインスタンス自身が引き渡されます。
インスタンスメソッドの定義方法をまとめると以下の書式の通りになります。

書式：インスタンスメソッドの定義方法

1class クラス名:
2    def __init__(self,引数,..)
3        self.インスタンス変数 = 引数
4        …
5    def インスタンスメソッド(self)
6        処理内容

3. インスタンスメソッドへのアクセス方法

またインスタンスメソッドの呼び出しは、インスタンスを介して行われます。そのためインスタンスメソッドの定義方法をまとめると下記の書式の通りです。

書式：インスタンスメソッドへのアクセス方法

`1`	`インスタンス名` `=` `クラス名`

`2`	`インスタンス名.インスタンスメソッド名`

凡例

1class Sample:
2 
3    def __init__(self,name):
4        self.name = name
5    def callName(self):
6        print('名前：',self.name)
7 
8sample1 = Sample("太郎")
9sample1.callName()

実行結果

1 名前：太郎

4.3.3 クラスメソッドについて

続いてクラスメソッドについて説明します。

1. クラスメソッドとは

各インスタンスに紐づかせるインスタンスメソッドに対して、クラスメソッドは、クラスそのものを紐づかせるためのメソッドです。
インスタンスメソッドは、インスタンスを介してアクセスすることができましたが、クラスメソッドは、クラスを介して直接、アクセスすることができます。

2. クラスメソッドの定義方法

クラスメソッドを定義するためには、以下の2点に従う必要があります。

メソッドの1行前に、デコレータである「@classmethod」と追記する
第一引数(以下、clsに統一する)を従える

第一引数のclsには、メソッドを呼び出したときクラス自身が代入されます。引数名はclsである必要はありませんが、一般的にはclsを使用するので、clsを指定してあげるようにしましょう。
クラスメソッドの定義方法をまとめると以下の書式の通りになります。

書式

1class クラス名:
2    def __init__(self,引数,..)
3        self.インスタンス変数 = 引数
4        …
5    @classmethod
6    def クラスメソッド(cls):
7        処理内容

3. クラスメソッドへアクセスする方法

インスタンスメソッドと異なり、クラスメソッドはクラス自身に紐づいたメソッドですので、クラスから直接、呼び出すことができます。
またインスタンスを介して呼び出すことも可能です。書式をまとめると以下の通りです。

書式

`1`	`① クラス名.クラスメソッド名`

`2`	`② インスタンス名.クラスメソッド名`

凡例

1class Sample:
2 
3    def __init__(self,name):
4        self.name = name
5 
6    @classmethod
7    def clsMtd(cls):
8        print('クラスメソッドの実行')
9 
10#クラスから直接アクセス
11Sample.clsMtd()
12#インスタンスからアクセス
13sample1 = Sample('太郎')
14sample1.clsMtd()

実行結果

`1`	`クラスメソッドの実行`

`2`	`クラスメソッドの実行`

凡例のイメージをまとめると以下の図の通りになります。

図 4.3.3: クラスメソッドへのアクセス

4. クラスメソッド内で変数にアクセスする方法

「4.1.1インスタンス変数の特徴①：アクセス方法」でも説明した通り、インスタンス変数は、インスタンスそのものに紐づかせた変数であり、インスタンスメソッドから呼び出すことができます。
インスタンスメソッドの第一引数であるself自体が、インスタンスそのものを表すため、selfを介してインスタンス変数にアクセスすることができるからです。
またインスタンス変数だけではなくインスタンスメソッドからクラス変数を呼び出すこともできます。

一方、クラスメソッドは、クラスを紐づくメソッドですので、インスタンス変数を呼び出すことはできませんが、クラス変数にアクセスすることはできます。
クラスメソッドの第一引数であるclsが、クラスそのものを表すので、clsを介してクラス変数にアクセスできるからです。

書式：クラスメソッド内からクラス変数にアクセスする方法

ではクラスメソッド内でクラス変数にアクセスするにはどうすれば良いのでしょうか。「cls.クラス変数名」を記載することで、クラス変数にアクセスできます。
書式をまとめると以下の通りです。

`1`	`cls.クラス変数名`

凡例

1class Sample:
2    #クラス変数の宣言
3    clsName = 'クラス変数'
4 
5    def __init__(self,name):
6        self.name = name
7 
8    @classmethod
9    def clsMtd(cls):
10        #クラス変数の呼び出し
11        return cls.clsName
12 
13#クラスメソッドの実行
14print(Sample.clsMtd())

実行結果

1 クラス変数

凡例のイメージをまとめると以下の図の通りになります。

図 4.3.4: クラスメソッドからクラス変数へのアクセス

4.3.4 インスタンスメソッドとクラスメソッドを使ったプログラム

続きまして、インスタンスメソッド、クラスメソッドを使ったプログラムを確認していきましょう。

ソース・フォルダー: /Desktop/Python基礎講座
ファイル名: 第4章.ipynb
アクセスURL: http://localhost:8888/notebooks/Desktop/Python基礎講座/第4章.ipynb

1class Computer:
2 
3    num = 0
4    def __init__(self,name,memory):
5        self.name = name
6        self.memory = memory
7        Computer.num += 1
8 
9    def osMemory(self):
10        print('【作成されたPCの内容】')
11        print('・os名：',self.name)
12        print('・メモリー：',self.memory,'GB')
13 
14    @classmethod
15    def checknum(cls):
16        print('【メンテナンスチェック】')
17        if cls.num > 2:
18            print('作成台数は',cls.num,'台ですので、メンテナンスを実施します。')
19        else:
20            print('作成台数は',cls.num,'台です。メンテナンスは不要です。')
21 
22#作成台数をチェック
23Computer.checknum()
24#PCの生成
25com1 = Computer('Windows',40)
26com1.osMemory()
27#作成台数をチェック
28Computer.checknum()
29#PCの生成
30com2 = Computer('Mac',100)
31com2.osMemory()
32#作成台数をチェック
33Computer.checknum()
34#PCの生成
35com3 = Computer('Windows',90)
36com3.osMemory()
37#作成台数をチェック
38Computer.checknum()

実行結果

1【メンテナンスチェック】
2作成台数は 0 台です。メンテナンスは不要です。
3【作成されたPCの内容】
4・os名： Windows
5・メモリー： 40 GB
6【メンテナンスチェック】
7作成台数は 1 台です。メンテナンスは不要です。
8【作成されたPCの内容】
9・os名： Mac
10・メモリー： 100 GB
11【メンテナンスチェック】
12作成台数は 2 台です。メンテナンスは不要です。
13【作成されたPCの内容】
14・os名： Windows
15・メモリー： 90 GB
16【メンテナンスチェック】
17作成台数は 3 台ですので、メンテナンスを実施します。

解説

1～20行目でComputerというクラスを定義しています。3行目ではクラス変数numを宣言しており、5～8行目でコンストラクタを定義してます。

コンストラクタでは、name、memoryと二つのインスタンス変数を宣言しており、また「Computer.num」によりクラス変数numを呼び出しており、numのインクリメント(変数の値を1つ足す)について記述しています。
クラス変数はインスタンス間で共有の値であり、インスタンスを生成するごとにコンストラクタ内部の処理が実行されるので、インスタンスが生成される度に、numの値が一つずつ増えていきます。

9～12行目では「osMemory」というインスタンスメソッドが定義されてます。こちらのメソッドでは、インスタンス変数のnameとmemoryを出力する処理を行います。

14～20行目では「checknum」というクラスメソッドを定義してます。checknumでは、クラス変数numを呼び出しており、numの値が2より大きい場合と小さい場合で、条件分岐により処理の内容を変えてます。

22～38行目では、クラスメソッドのchecknumの呼び出し、クラスComputerからインスタンスの生成、生成したインスタンスからインスタンスメソッドの呼び出しを、計3回行っています。

クラス変数numは、コンストラクタでインクリメントが記載されているので、23行目で参照すると0が出力されましたが、最終的には3つインスタンスを作成したので、3が出力されるようになります。

NEXT>> 4.4 本章のまとめ