'__new__()'、'__init__()'の使い分け、メタクラスの存在意義について

Question

インスタンスアロケータ - Python学習講座 https://www.python.ambitious-engineer.com/archives/310

上記サイトで学んでいますが、'new()'と'init()'の使い分けがいまいち理解できません。

どちらもクラスからインスタンスを生成する際には必ず呼ばれているとの認識でしたが、以下のページを見ると、'init()'は呼ばれない場合もあるとのことです。

__new__と__init__とメタクラスと - Qiita https://qiita.com/FGtatsuro/items/49f907a809e53b874b18

であれば、【質問①】なぜ多くの教本等ではインスタンスを生成する際には'init()'を使うのでしょうか。必ず呼ばれる'new()'を用いれば良いのではと思ってしまいます。

また、【質問②】上記Qiitaのページにあるメタクラスとは何者なのでしょうか。いくつかページを巡回してみましたが、存在意義がまったく理解できませんでした。もし、「こういった際に使うものだよ、実業務のなかでこう使ってるよ」というものがあればご教示いただければ幸いです。

素人質問で恐縮ですが、何卒、よろしくお願いいたします。

Answer 1

【質問①】なぜ多くの教本等ではインスタンスを生成する際には'init'を使うのでしょうか。必ず呼ばれる'new()'を用いれば良いのではと思ってしまいます。

そもそも、__new__が必ず呼ばれる、という事が間違っています。
参考にされているサイトでは、「super().__init__を呼ばなければ」という条件を出していますが、そうであればsuper().__new__を呼び出さない事もできます。

class Hoge:
    def __new__(cls, *args, **kwargs):
        print('Hoge.new')
        return super().__new__(cls, *args, **kwargs)

class Piyo(Hoge):
    def __new__(cls, *args, **kwargs):
        print('Piyo.new')
        return object.__new__(cls, *args, **kwargs)

「__new__」は、インスタンスを生成するメソッド。「__init__」は、インスタンスを初期化するメソッドです。
ですので、初期化を行うコードは「__init__」に書くのが自然ですし、皆そのように従っているだけかと思います。

【質問②】上記Qiitaのページにあるメタクラスとは何者なのでしょうか。

メタクラスに関して、自分も最近真面目に調べた程度の浅い知識なのですが。
その時に参考にしたのが、以下のサイトです。

• Pythonのクラスアトリビュートとメタクラスの話

一言で言えば、「クラスのクラス」です。と言ってもさっぱりわかりませんが。

Pythonにおいて、モジュールもメソッドも全てobjectです。それはクラスに関しても例外ではありません。
そして、全てのobjectは型オブジェクトを持ちます。

普通にクラスを定義した場合、型オブジェクトはtypeになります。

>>> class Hoge:
...  pass
...
>>> type(Hoge)
<class 'type'>
>>>

この型オブジェクトを、自分で定義した物がメタクラスです。

>>> class Metaclass(type):
...  pass
...
>>> class Hoge(metaclass=Metaclass):
...  pass
...
>>> type(Hoge)
<class '__main__.Metaclass'>
>>>

では、どのように使うかと言えば、クラス定義をした際にそのクラスインスタンスに対して処理する用途などに使います。
そういった意味ではデコレータと似ていると思いますが、デコレータと違う点は。

• 「@decorator」というような記述をしなくてもよい。
• クラス、もしくはその派生クラスにしか適用できない。
• デコレータは生成されたクラスインスタンスに対して処理するのに対し、メタクラスはクラスインスタンスを生成する前にも処理を行うことができる。

です。

例えば、PyQtの場合、自分のクラスにシグナルを追加する場合、クラス属性にシグナルを追加します。

from PyQt5 import QtCore
class MyObject(QtCore.QObject):
  mysignal = QtCore.pyqtSignal()

または、SQLAlchemyのテーブル定義では、クラス属性にテーブル名なりカラム定義なりを追加します。

from sqlalchemy import Column, String
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class MyTable(Base):
  __tablename__ = 'mytable'
  name = Column(String, primary_key)
Base.metadata.create_all(engine)

このように、クラス属性を定義して振る舞いを指定する事は何らかのモジュールを使っている上で多々ある事ですが、大抵の場合属性を定義するだけではなく、何らかの処理が必要になるはずです。

class Parent:
  subclasses = {}

  @staticmethod
  def init_class(cls):
    Parent.subclass[cls.__clsname__] = cls

class Hoge(Parent):
 __clsname__ = 'hoge'
Parent.init_cls(Hoge)

上記のようにParent.init_classを呼び出せば処理ができますが、実際にはそのような処理は記述しません。
そこで、メタクラスを使います。

class Metaclass(type):
  subclasses = {}
  def __init__(cls, name, bases, attrs):
    super().__init__(name, bases, attrs)
    Metaclass.subclasses[cls.__clsname__] = cls

class Parent(metaclass=Metaclass):
  __clsname__ = 'parent'
  pass

class Hoge(Parent):
  __clsname__ = 'hoge'

print(Metaclass.subclasses)

このようにしておけば、Parentを継承するクラスは__clsname__を定義しておくだけでOKというようになります。

そもそもメタクラスのようなメタプログラミング技法は、ライブラリ作成者がディベロッパに対して余計な手間を省くために使用されることが多いですから、一般的にはあまり使用しないと思います。

Comments

[退会済みユーザー]

ご回答ありがとうございます。また、サンプルコードや実例混じえてのご説明、本当に分かりやすく参考になります。ただし、1度読んだだけではぼんやりとわかった気になったレベルだったので、明日、もう一度、読み込んでから解決済みにしたいと思います。

今しばらくOPENのままお待ちいただければ幸いです。。

Answer 2

__new__ はインスタンスを生成する前段階の処理を書けます。
例えば、唯一無二のインスタンスを生成して、そのインスタンスをみんなで共有したい場合があります。デザインパターンで「シングルトンパターン」という名前が付いている方法です。
それを実現するのに、そのクラスのインスタンスを一度も生成してなければ生成してキャッシュしておき、インスタンス生成済であればキャッシュしてあるインスタンスを返す、という処理を __new__ に書きます。

メタクラスは、インスタンス生成時の処理を書けます。
必ず必要なメンバーやメソッドが定義されていなければ例外を発生させたり、
自動的にメンバーやメソッドを作り出して追加するようなこともできます。

__init__ はインスタンス生成後の初期化処理です。
インスタンス生成しなければ呼び出しません。
インスタンス生成すれば呼び出します。

Comments

[退会済みユーザー]

ご回答ありがとうございます。非常にわかりやすく、助かります。

シングルトンの例で言えば、インスタンスが生成される前にインスタンスの存在有無をチェックし、インスタンスが２つ存在しないようにしているということですね。

メタクラスの例については、実装のチェックを行っているようなイメージでしょうか？ もしこの認識に相違なければ、実装に誤りがあった場合、それを単体テストで見つけるのか、メタクラスで見つけるのかの違いのように感じるのですがいかがでしょうか。

[shiracamus]

テストにも使える、ですかね。
メタクラスはクラスを定義するためのクラスなので、いろいろなことができます。
チェックだけじゃなく、機能拡張したり、他のクラスと連携させたり。
ネット検索するといろいろな記事が見つかります。
https://www.google.com/search?q=python+metaclass