Python オブジェクトのルールを変更する黒魔術のメタクラス

Xiao Ming が今日共有したいトピックは、クラス定義メタクラス変更のアーティファクトです。

タイトルを見ると、何の役に立つのかと疑問に思うかもしれません。クラスの定義を変更するのですか？メタクラスを使用する必要があるのはどのような場合ですか?

今日は、簡単な ORM フレームワークを設計し、シリアル化ツールである YAML の原理を簡単に分析します。

Python の神クラス タイプ

メタクラスについて言えば、オブジェクトはクラスのインスタンスであり、クラスは型のインスタンスであるという最も基本的な概念を最初に理解する必要があります。繰り返し:

1. オブジェクトはクラスのインスタンスです
2. クラスは型のインスタンスです

オブジェクト指向プログラミング モデルでは、クラスは家の設計図に相当します。 . 対象となるのは、この設計図をもとに建てられた住宅です。

下の図では、おもちゃのモデルはクラスを表し、特定の製造されたおもちゃはオブジェクトを表すことができます。

つまり、クラスは次のとおりです。 created オブジェクトのテンプレート。

そして、type はクラスを作成するためのテンプレートなので、type を通じて必要なクラスを作成できます。

たとえば、Hello クラスを定義します:

class Hello(object):
def hello(self, name='world'):
 print('Hello, %s.' % name)

Python インタープリターが hello モジュールをロードすると、モジュールのすべてのステートメントが順番に実行され、実行結果として動的にHello クラスのオブジェクト。

type() 関数は、型または変数の型をチェックするだけでなく、パラメーターに基づいて新しい型を作成することもできます。たとえば、上記のクラスの定義は本質的に次のとおりです:

def hello(self, name='world'):
print('Hello, %s.' % name)
Hello = type('Hello', (object,), dict(hello=hello))

type( ) 関数は、3 つのパラメータを順番に渡してクラス オブジェクトを作成します:

• クラス class の名前;
• 継承された親クラスのコレクション。 Python は多重継承をサポートしています。親クラスが 1 つしかない場合は、タプルの単一要素の記述方法を忘れないでください。
• クラスのメソッド名は、フィールド名と同様に関数にバインドされます。ここでは関数 fn をメソッド名 hello にバインドします。

type() 関数を通じて作成されたクラスは、クラスを直接記述することとまったく同じです。Python インタープリターはクラス定義に遭遇すると、クラス定義の構文をスキャンして呼び出しを行うだけであるためです。 type() この関数はクラスを作成します。

通常の状況では、クラスを定義するにはクラス Xxx... を使用しますが、 type() 関数を使用するとクラスを動的に作成できます。つまり、動的言語である Python は実行時の動的作成をサポートします。 。これがどれほど強力であるとは感じられないかもしれませんが、静的言語ランタイム中にクラスを作成したい場合は、ソース コード文字列を構築してからコンパイラを呼び出すか、いくつかのツールを使用してバイトコード実装を生成する必要があることを知っておく必要があります。動的コンパイルなので非常に複雑です。

メタクラスとは

型とメタクラスの関係は何ですか?メタクラスとは正確には何ですか?

メタクラスは実際には型または型のサブクラスだと思いますが、型を継承して __call__ 演算子をオーバーロードすることで、クラス オブジェクトの作成時にいくつかの変更を加えることができます。

クラス MyClass の場合:

class MyClass():
 pass

は実際には次と同等です:

class MyClass(metaclass = type):
 pass

そのメタクラスを MyMeta に設定すると:

class MyClass(metaclass = MyMeta):
 pass

MyClass は表されなくなりますネイティブ型の作成では、代わりに MyMeta の __call__ 演算子オーバーロードが呼び出されます。

class = type(classname, superclasses, attributedict)
## 变为了
class = MyMeta(classname, superclasses, attributedict)

継承関係のあるクラスの場合:

class Foo(Bar):
 pass

Python は次の操作を実行します:

• Foo に __metaclass__ 属性はありますか?その場合、Python は __metaclass__
• を通じて Foo という名前のクラス (オブジェクト) を作成します。Python が __metaclass__ を見つけられない場合は、Bar (親クラス) で __metaclass__ 属性を探し続け、次と同じ操作を試みます。前に。
• Python が親クラスで __metaclass__ を見つけられない場合、モジュール階層で __metaclass__ を探し、同じ操作を実行しようとします。
• それでも __metaclass__ が見つからない場合、Python は組み込み型を使用してこのクラス オブジェクトを作成します。

モジュール内のすべてのクラス属性を大文字にする必要があると決定する愚かな例を想像してください。これを行うにはいくつかの方法がありますが、その 1 つはモジュール レベルで __metaclass__ を設定することです。

class UpperAttrMetaClass(type):
## __new__ 是在__init__之前被调用的特殊方法
## __new__是用来创建对象并返回之的方法
## 而__init__只是用来将传入的参数初始化给对象
## 你很少用到__new__，除非你希望能够控制对象的创建
## 这里，创建的对象是类，我们希望能够自定义它，所以我们这里改写__new__
## 如果你希望的话，你也可以在__init__中做些事情
## 还有一些高级的用法会涉及到改写__call__特殊方法，但是我们这里不用
def __new__(cls, future_class_name, future_class_parents, future_class_attr):
##遍历属性字典，把不是__开头的属性名字变为大写
newAttr = {}
for name,value in future_class_attr.items():
if not name.startswith("__"):
newAttr[name.upper()] = value
## 方法1：通过'type'来做类对象的创建
## return type(future_class_name, future_class_parents, newAttr)
## 方法2：复用type.__new__方法，这就是基本的OOP编程
## return type.__new__(cls, future_class_name, future_class_parents, newAttr)
## 方法3：使用super方法
return super(UpperAttrMetaClass, cls).__new__(cls, future_class_name, future_class_parents, newAttr)
class Foo(object, metaclass = UpperAttrMetaClass):
bar = 'bip'
print(hasattr(Foo, 'bar'))
## 输出: False
print(hasattr(Foo, 'BAR'))
## 输出:True
f = Foo()
print(f.BAR)
## 输出:'bip'

シンプルな ORM フレームワークの設計

ORM の正式名は「オブジェクト リレーショナル マッピング」です。つまり、オブジェクト リレーショナル マッピングとは、リレーショナル データベースの行をオブジェクト、つまりクラスとテーブルに対応付けることであり、SQL ステートメントを直接操作することなくコードを記述することが容易になります。

次に、ORM フレームワークの呼び出しインターフェイスを設計します。たとえば、ユーザーが User クラスを通じて対応するデータベース テーブル User を操作したい場合、次のようなコードを記述することが期待されます:

class User(Model):
## 定义类的属性到列的映射：
id = IntegerField('id')
name = StringField('username')
email = StringField('email')
password = StringField('password')
## 创建一个实例：
u = User(id=12345, name='xiaoxiaoming', email='test@orm.org', password='my-pwd')
## 保存到数据库：
u.save()

上記のインターフェースは通常のメソッドを通過します。このメソッドの実装は難しいか、ほぼ困難ですが、メタクラスを介すると比較的簡単です。中心となるアイデアは、メタクラスを通じてクラスの定義を変更し、クラスのすべてのフィールド タイプ属性を追加のディクショナリに保存し、元の定義から削除することです。オブジェクト作成時にユーザーが渡すパラメータ（id=12345、name='xiaoxiaoming'など）は、辞書の実装を模倣するか、dictクラスを直接継承することで保存できます。

其中，父类Model和属性类型StringField、IntegerField是由ORM框架提供的，剩下的魔术方法比如save()全部由metaclass自动完成。虽然metaclass的编写会比较复杂，但ORM的使用者用起来却异常简单。

首先定义Field类，它负责保存数据库表的字段名和字段类型：

class Field(object):
def __init__(self, name, column_type):
self.name = name
self.column_type = column_type
def __str__(self):
return '<%s:%s>' % (self.__class__.__name__, self.name)

在Field的基础上，进一步定义各种类型的Field，比如StringField，IntegerField等等：

class StringField(Field):
def __init__(self, name):
super(StringField, self).__init__(name, 'varchar(100)')
class IntegerField(Field):
def __init__(self, name):
super(IntegerField, self).__init__(name, 'bigint')

下一步，编写ModelMetaclass：

class ModelMetaclass(type):
def __new__(cls, name, bases, attrs):
if name == 'Model':
return type.__new__(cls, name, bases, attrs)
print('Found model: %s' % name)
mappings = dict()
for k, v in attrs.items():
if isinstance(v, Field):
print('Found mapping: %s ==> %s' % (k, v))
mappings[k] = v
for k in mappings.keys():
attrs.pop(k)
attrs['__mappings__'] = mappings## 保存属性和列的映射关系
attrs.setdefault('__table__', name) ## 当未定义__table__属性时，表名直接使用类名
return type.__new__(cls, name, bases, attrs)

以及基类Model：

class Model(dict, metaclass=ModelMetaclass):
def __init__(self, **kw):
super(Model, self).__init__(**kw)
def __getattr__(self, key):
try:
return self[key]
except KeyError:
raise AttributeError(r"'Model' object has no attribute '%s'" % key)
def __setattr__(self, key, value):
self[key] = value
def save(self):
fields = []
params = []
args = []
for k, v in self.__mappings__.items():
fields.append(v.name)
params.append('?')
args.append(getattr(self, k, None))
sql = 'insert into %s (%s) values (%s)' % (self.__table__, ','.join(fields), ','.join(params))
print('SQL: %s' % sql)
print('ARGS: %s' % str(args))

在ModelMetaclass中，一共做了几件事情：

1. 在当前类（比如User）中查找定义的类的所有属性，如果找到一个Field属性，就把它保存到一个__mappings__的dict中，同时从类属性中删除该Field属性（避免实例的属性遮盖类的同名属性）；
2. 当类中未定义__table__字段时，直接将类名保存到__table__字段中作为表名。

在Model类中，就可以定义各种操作数据库的方法，比如save()，delete()，find()，update等等。

我们实现了save()方法，把一个实例保存到数据库中。因为有表名，属性到字段的映射和属性值的集合，就可以构造出INSERT语句。

测试：

u = User(id=12345, name='xiaoxiaoming', email='test@orm.org', password='my-pwd')
u.save()

输出如下：

Found model: User
Found mapping: id ==> <IntegerField:id>
Found mapping: name ==> <StringField:username>
Found mapping: email ==> <StringField:email>
Found mapping: password ==> <StringField:password>
SQL: insert into User (id,username,email,password) values (?,?,?,?)
ARGS: [12345, 'xiaoxiaoming', 'test@orm.org', 'my-pwd']

测试2：

class Blog(Model):
__table__ = 'blogs'
id = IntegerField('id')
user_id = StringField('user_id')
user_name = StringField('user_name')
name = StringField('user_name')
summary = StringField('summary')
content = StringField('content')
b = Blog(id=12345, user_, user_name='xxm', name='orm框架的基本运行机制', summary="简单讲述一下orm框架的基本运行机制",
 content="此处省略一万字...")
b.save()

输出：

Found model: Blog
Found mapping: id ==> <IntegerField:id>
Found mapping: user_id ==> <StringField:user_id>
Found mapping: user_name ==> <StringField:user_name>
Found mapping: name ==> <StringField:user_name>
Found mapping: summary ==> <StringField:summary>
Found mapping: content ==> <StringField:content>
SQL: insert into blogs (id,user_id,user_name,user_name,summary,content) values (?,?,?,?,?,?)
ARGS: [12345, 'user_id1', 'xxm', 'orm框架的基本运行机制', '简单讲述一下orm框架的基本运行机制', '此处省略一万字...']

可以看到，save()方法已经打印出了可执行的SQL语句，以及参数列表，只需要真正连接到数据库，执行该SQL语句，就可以完成真正的功能。

YAML序列化工具的实现原理浅析

YAML是一个家喻户晓的 Python 工具，可以方便地序列化 / 逆序列化结构数据。

官方文档：https://pyyaml.org/wiki/PyYAMLDocumentation

安装：

pip install pyyaml

YAMLObject 的任意子类支持序列化和反序列化（serialization & deserialization）。比如说下面这段代码：

import yaml
class Monster(yaml.YAMLObject):
yaml_tag = '!Monster'
def __init__(self, name, hp, ac, attacks):
self.name = name
self.hp = hp
self.ac = ac
self.attacks = attacks
def __repr__(self):
return f"{self.__class__.__name__}(name={self.name}, hp={self.hp}, ac={self.ac}, attacks={self.attacks})"
monster1 = yaml.load("""
--- !Monster
name: Cave spider
hp: [2,6]
ac: 16
attacks: [BITE, HURT]
""")
print(monster1, type(monster1))
monster2 = Monster(name='Cave lizard', hp=[3, 6], ac=16, attacks=['BITE', 'HURT'])
print(yaml.dump(monster2))

运行结果：

Monster(name=Cave spider, hp=[2, 6], ac=16, attacks=['BITE', 'HURT']) <class '__main__.Monster'>
!Monster
ac: 16
attacks: [BITE, HURT]
hp: [3, 6]
name: Cave lizard

这里面调用统一的 yaml.load()，就能把任意一个 yaml 序列载入成一个 Python Object；而调用统一的 yaml.dump()，就能把一个 YAMLObject 子类序列化。

对于 load() 和 dump() 的使用者来说，他们完全不需要提前知道任何类型信息，这让超动态配置编程成了可能。比方说，在一个智能语音助手的大型项目中，我们有 1 万个语音对话场景，每一个场景都是不同团队开发的。作为智能语音助手的核心团队成员，我不可能去了解每个子场景的实现细节。

在动态配置实验不同场景时，经常是今天我要实验场景 A 和 B 的配置，明天实验 B 和 C 的配置，光配置文件就有几万行量级，工作量不可谓不小。而应用这样的动态配置理念，就可以让引擎根据配置文件，动态加载所需要的 Python 类。

对于 YAML 的使用者也很方便，只要简单地继承 yaml.YAMLObject，就能让你的 Python Object 具有序列化和逆序列化能力。

据说即使是在大厂 Google 的 Python 开发者，发现能深入解释 YAML 这种设计模式优点的人，大概只有 10%。而能知道类似 YAML 的这种动态序列化 / 逆序列化功能正是用 metaclass 实现的人，可能只有 1% 了。而能够将YAML 怎样用 metaclass 实现动态序列化 / 逆序列化功能讲出一二的可能只有 0.1%了。

对于YAMLObject 的 load和dump() 功能，简单来说，我们需要一个全局的注册器，让 YAML 知道，序列化文本中的 !Monster 需要载入成 Monster 这个 Python 类型，Monster 这个 Python 类型需要被序列化为!Monster 标签开头的字符串。

一个很自然的想法就是，那我们建立一个全局变量叫 registry，把所有需要逆序列化的 YAMLObject，都注册进去。比如下面这样：

registry = {}
def add_constructor(target_class):
registry[target_class.yaml_tag] = target_class

然后，在 Monster 类定义后面加上下面这行代码：

add_constructor(Monster)

这样的缺点很明显，对于 YAML 的使用者来说，每一个 YAML 的可逆序列化的类 Foo 定义后，都需要加上一句话add_constructor(Foo)。这无疑给开发者增加了麻烦，也更容易出错，毕竟开发者很容易忘了这一点。

更优雅的实现方式自然是通过metaclass 解决了这个问题，YAML 的源码正是这样实现的：

class YAMLObjectMetaclass(type):
def __init__(cls, name, bases, kwds):
super(YAMLObjectMetaclass, cls).__init__(name, bases, kwds)
if 'yaml_tag' in kwds and kwds['yaml_tag'] is not None:
cls.yaml_loader.add_constructor(cls.yaml_tag, cls.from_yaml)
cls.yaml_dumper.add_representer(cls, cls.to_yaml)
## 省略其余定义
class YAMLObject(metaclass=YAMLObjectMetaclass):
yaml_loader = Loader
yaml_dumper = Dumper
## 省略其余定义

可以看到，YAMLObject 把 metaclass 声明成了 YAMLObjectMetaclass，YAMLObjectMetaclass则会改变YAMLObject类和其子类的定义，就是下面这行代码将YAMLObject 的子类加入到了yaml的两个全局注册表中：

cls.yaml_loader.add_constructor(cls.yaml_tag, cls.from_yaml)
cls.yaml_dumper.add_representer(cls, cls.to_yaml)

YAML 应用 metaclass，拦截了所有 YAMLObject 子类的定义。也就是说，在你定义任何 YAMLObject 子类时，Python 会强行插入运行上面这段代码，把我们之前想要的add_constructor(Foo)和add_representer(Foo)给自动加上。所以 YAML 的使用者，无需自己去手写add_constructor(Foo)和add_representer(Foo)。

概要

この共有では、主にメタクラスの実装メカニズムを簡単に分析します。 ORM フレームワークを実装し、YAML ソース コードを解釈することで、メタクラスについてはすでによく理解できたと思います。

メタクラスは Python の黒魔術レベルの言語機能です。クラスの作成時にクラスの動作を変更する可能性があります。この強力な機能は注意して使用する必要があります。

この記事を読んだ後、デコレータとメタクラスの違いは何だと思いますか?私と話し合うために、以下にメッセージを残してください。補充するには、必ず連続 3 回クリックしてください。

以上がPython オブジェクトのルールを変更する黒魔術のメタクラスの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。