Pythonのクラスメソッドの使い方

pythonを勉強していて、クラスメソッドとは？の疑問に答える記事になります。

コンテンツ

クラスメソッドとは

クラスメソッドは、クラスに紐づくメソッドで、第一引数にクラスオブジェクトが渡されます。

クラスメソッドは@classmethodを付ける点以外はインスタンスメソッドと同様に定義できます。

ただし、第一引数がクラスオブジェクトですので、selfではなくclsとすることが一般的です。

それでは実際にコードを書いて理解をしてみます。

クラスメソッドを実際に使ったコード

コードの概要としては、問い合わせフォームで入力された数字(27行目)に対して対応する日本語を返すコードになります。

class InquiryStatus():
    Pending = 0
    Ignore = 1
    Completed = 2
    
    INQUIRY_STATUS_CHOICES = [
        (Pending, '未対応'),
        (Ignore, '無視する'),
        (Completed, '対応済み')
    ]
    
    @classmethod
    def status_as_str(cls, inquiry_status):
        if inquiry_status == cls.Pending:
            return cls.INQUIRY_STATUS_CHOICES[0][1]
        
        elif inquiry_status == cls.Ignore:
            return cls.INQUIRY_STATUS_CHOICES[1][1]
        
        elif inquiry_status == cls.Completed:
            return cls.INQUIRY_STATUS_CHOICES[2][1]
        
        else:
            raise RuntimeError('invalid')
            

inquiry_status = 1
inquiry_status_as_str = InquiryStatus.status_as_str(inquiry_status)
print(inquiry_status_as_str) # 無視する
print(InquiryStatus.Pending) # 0

27行目で、inquiry_statusの値を設定できるようになっていて、右辺に、0 or 1 or 2 or　それ以外の数字を入れてみてください。

printで日本語が出力されるようになっています。