Pythonのクラスについて

Question

現在、pythonを勉強していますがとあるサイトリンク内容で以下のコードを見つけたのですが
return cls(friend_name, origin.school, *args)と
mitsu = WorkingStudent.friend(hiro, "Mitsu", 15.00)のコードが一体何をしているのかわかりません。
ご教授お願い致します。

※コードとコメントは引用です。

class Student:
    def __init__(self, name, school):
        self.name = name
        self.school = school
        self.marks = []

    def average(self):
        """平均成績を返す

        インスタンス変数にアクセスしたいのでinstancemethodを使う。
        """
        return sum(self.marks) / len(self.marks)

    @classmethod
    def friend(cls, origin, friend_name, *args):
        """同じ学校の友達を追加する。

        継承クラスで動作が変わるべき(継承クラスでは salaryプロパティがある)
        なのでclassmethodを使う。
        子クラスの初期化引数は *argsで受けるのがいい
        """
        return cls(friend_name, origin.school, *args)

    @staticmethod
    def say_hello():
        """先生に挨拶する

        継承しても同じ動きでいいのでstaticmethodを使う
        """
        print("Hello Teacher!")

class WorkingStudent(Student):
    def __init__(self, name, school, salary):
        super().__init__(name, school)
        self.salary = salary

hiro = WorkingStudent("Hiro", "Stanford", 20.00)
mitsu = WorkingStudent.friend(hiro, "Mitsu", 15.00)
print(mitsu.salary)

Comments

[Orlofsky]

質問に、その[とあるサイト]のURLを https://teratail.com/help/question-tips#questionTips3-7 の [リンク] で
[リンク先の説明](http...) で追加しては？

[bbbjoker1218]

ご指摘ありがとうございます。
コードの引用元のURLを追加しました。

[meg_]

デバッグしてコードの動きを追ってみるのが良いと思います。

Answer 1

まずはクラス、クラスメソッド、継承についてさらっと記載します。

クラス

Python言語ではクラス構文を利用して、クラスに変数や関数を定義できます。

クラスと呼ばれるテンプレートの様なものから、インスタンスと呼ばれる値を埋め込んだものを作成できます。

class Person:
	# __init__はPerson()としたときに必ず呼ばれる関数
	# 変数nameを設定している
	def __init__(self, name):
		self.name = name
		
	def get_name(self):
		return self.name
	
my = Person('yamada')

print(my.get_name()) # クラスに関数が設定されている
print(my.name)       # クラスに変数が設定されている

クラスメソッド

先ほどクラスはテンプレートの様なもの、と記載しました。
クラスメソッドでは引数にクラスそのものが入るので、クラス自身を指します。

class Person:
	name = 'tanaka' # クラス変数
	
	def __init__(self, name):
		self.name = name # メンバ変数
		
	@classmethod
	def get_name_from_class(cls):
		return cls.name
		
	def get_name_from_member(self):
		return self.name

print(Person('yamada').get_name_from_class())
print(Person('yamada').get_name_from_member())

get_name_from_class関数はクラスメソッドなので、cls引数にはPersonクラスが入ります。
それに対してget_name_from_memberはクラスメソッドではないので、self引数にはPerson('yamada')インスタンスが入ります。

継承について

また親クラスを子クラスが継承することが出来ます。

class Person:
	def __init__(self, name):
		self.name = name
		
	def get_name(self):
		return self.name
		

class Child(Person): # class 子クラス名(親クラス名)で継承できる
	def __init__(self,name,  age):
		super().__init__(name) # superメソッドで親クラスを参照できる
		self.age = age
		
	def get_age(self):
		return self.age
	
my = Child('yamada', 12)

print(my.get_name()) # 親クラスの変数、関数を利用できる
print(my.get_age())  # 子クラスの機能も利用できる

上記を踏まえた上で説明します。

WorkingStudent("Hiro", "Stanford", 20.00)でWorkingStudentクラスが初期化されます。

WorkingStudentは親クラスStudentを継承しているので、friend関数が使えます。

そしてfriend関数はStudentのクラスのクラスメソッドです。
またクラスメソッドは呼び出したクラスに属します。

第一引数であるcls変数にはWorkingStudentクラス自身が入ります。
第二引数であるoriginにはhiroインスタンスが入ります。

そしてfriend_nameに"Mitsu"、*argsに15.00が入ります。

なのでreturn cls(friend_name, origin.school, *args)で実質WorkingStudent("Mitsu", hiro.school, 15.00)となるわけです。

Comments

[bbbjoker1218]

丁寧な解説ありがとうございます。
理解できました。

[nobodytolove123]

お役に立てれば幸いです。

一部嘘をついてしまったので、修正させて下さい...。

[bbbjoker1218]

どの部分が間違いだったのでしょうか？

[nobodytolove123]

失礼しました。

クラスインスタンスは継承されたのクラスに属すと記載しましたが、正しくは呼び出されたクラスに属す。です。

[bbbjoker1218]

訂正ありがとうございました。
ちなみに、クラスメソッドとスタティックメソッドはどのように使い分けたらいいのでしょうか？

[nobodytolove123]

僕も詳しくないのでただの意見になってしまいますが、クラスメソッドは引数に自分自身を取れるので、自身を利用した新しいインスタンスを作る場合に使う時とかですかね。

スタティックメソッドの方が、かなり汎用的に使われていると思います。

主観ですが、静的な機能を実装する場合、スタティックメソッドの方が汎用的に使い回されている気がします。

リンクの方も参考にしてください。

https://blog.pyq.jp/entry/Python_kaiketsu_190205
https://www.st-hakky-blog.com/entry/2017/11/15/155523?amp=1

[bbbjoker1218]

ありがとうございます。
いろいろ調べたのですがこれといった解説がされているサイトがなかったので質問させていただきました。
リンクを参考にいろいろコードを書いてみます。

Answer 2

    @classmethod
    def friend(cls, origin, friend_name, *args):
        """同じ学校の友達を追加する。

        継承クラスで動作が変わるべき(継承クラスでは salaryプロパティがある)
        なのでclassmethodを使う。
        子クラスの初期化引数は *argsで受けるのがいい
        """
        return cls(friend_name, origin.school, *args)

このクラスメソッドが第一引数で受け取ったクラスをインスタンス化して返しています。第一引数には、メソッドが属するクラスが自動的にバインドされます。

mitsu = WorkingStudent.friend(hiro, "Mitsu", 15.00)

シンプルに上述のクラスメソッドを呼び出しています。

Comments

[bbbjoker1218]

わかり易い解説ありがとうございます。