Python元类

Posted 2020-12-03 qianyeliange

学懂元类，首先要知道两句话：

• 道生一，一生二，二生三。三生万物
• 我是谁？我从哪里来？我要到那里去？

在Python的世界里，拥有一个永恒的道：type，如此广袤无垠的Python生态圈，都是由type产生出来的。

道生一，一生二，二生三，三生万物。

1. 道：即就是type
2. 一：即是metaclass
3. 二：即是class（或者实例生成器）
4. 三：即是instance

1 关于类

道和一，是我们今天讨论的命题，而二、三、和万物，则是我们常常使用的类、实例、属性和方法，用hello world来举例：

 1 # 创建一个Hello类，拥有属性say_hello ----二的起源
 2 class Hello():
 3     def say_hello(self, name=‘world‘):
 4         print(‘Hello, %s.‘ % name)
 5  
 6  
 7 # 从Hello类创建一个实例hello ----二生三
 8 hello = Hello()
 9  
10 # 使用hello调用方法say_hello ----三生万物
11 hello.say_hello()

输出效果：

Hello, world.

这就是一个标准的“二生三，三生万物”过程。 从类到我们可以调用的方法，用了这两步。

那我们不由自主要问，类从何而来呢？回到代码的第一行。class Hello其实是一个函数的“语义化简称”，只为了让代码更浅显易懂，它的另一个写法是：

1 def fn(self, name=‘world‘): # 假如我们有一个函数叫fn
2     print(‘Hello, %s.‘ % name)
3     
4 Hello = type(‘Hello‘, (object,), dict(say_hello=fn)) # 通过type创建Hello class ---- 神秘的“道”，可以点化一切，这次我们直接从“道”生出了“二”

  这样的写法，就和之前的Class Hello写法作用完全相同，你可以试试创建实例并调用：

1 # 从Hello类创建一个实例hello ----二生三，完全一样
2 hello = Hello()
3  
4 # 使用hello调用方法say_hello ----三生万物，完全一样
5 hello.say_hello()

  输出效果：

Hello, world.

 可以看出，输出的结果一致。

我们回头看一眼最精彩的地方，道直接生出了二：

Hello = type(‘Hello’, (object,), dict(say_hello=fn))

 这就是“道”，python世界的起源，你可以为此而惊叹。

注意它的三个参数！暗合人类的三大永恒命题：我是谁，我从哪里来，我要到哪里去。

• 第一个参数：我是谁。 在这里，我需要一个区分于其它一切的命名，以上的实例将我命名为“Hello”
• 第二个参数：我从哪里来。在这里，我需要知道从哪里来，也就是我的“父类”，以上实例中我的父类是“object”——Python中一种非常初级的类。
• 第三个参数：我要到哪里去。在这里，我们将需要调用的方法和属性包含到一个字典里，再作为参数传入。以上实例中，我们有一个say_hello方法包装进了字典中。

值得注意的是，三大永恒命题，是一切类，一切实例，甚至一切实例属性与方法都具有的。理所应当，它们的“创造者”，道和一，即type和元类，也具有这三个参数。但平常，类的三大永恒命题并不作为参数传入，而是以如下方式传入：

1 class Hello(object){
2 # class 后声明“我是谁”
3 # 小括号内声明“我来自哪里”
4 # 花括号内声明“我要到哪里去”
5     def say_hello(){
6         pass
7     }
8 }

• 造物主，可以直接创造单个的人，但这是一件苦役。造物主会先创造“人”这一物种，再批量创造具体的个人。并将三大永恒命题，一直传递下去。
• “道”可以直接生出“二”，但它会先生出“一”，再批量地制造“二”。
• type可以直接生成类（class），但也可以先生成元类（metaclass），再使用元类批量定制类（class）。

2 元类——道生一，一生二

一般来说，元类均被命名后缀为Metalass。想象一下，我们需要一个可以自动打招呼的元类，它里面的类方法呢，有时需要say_Hello，有时需要say_Hi，有时又需要say_Sayolala，有时需要say_Nihao。

如果每个内置的say_xxx都需要在类里面声明一次，那将是多么可怕的苦役！ 不如使用元类来解决问题。

以下是创建一个专门“打招呼”用的元类代码：

1 class SayMetaClass(type):
2  
3     def __new__(cls, name, bases, attrs):
4         attrs[‘say_‘+name] = lambda self,value,saying=name: print(saying+‘,‘+value+‘!‘)
5         return type.__new__(cls, name, bases, attrs)

 记住两点：

1. 元类是由“type”衍生而出，所以父类需要传入type。【道生一，所以一必须包含道】
2. 元类的操作都在 __new__中完成，它的第一个参数是将创建的类，之后的参数即是三大永恒命题：我是谁，我从哪里来，我将到哪里去。 它返回的对象也是三大永恒命题，接下来，这三个参数将一直陪伴我们。

在__new__中，我只进行了一个操作，就是：

attrs[‘say_‘+name] = lambda self,value,saying=name: print(saying+‘,‘+value+‘!‘)

 它跟据类的名字，创建了一个类方法。比如我们由元类创建的类叫“Hello”，那创建时就自动有了一个叫“say_Hello”的类方法，然后又将类的名字“Hello”作为默认参数saying，传到了方法里面。然后把hello方法调用时的传参作为value传进去，最终打印出来。

那么，一个元类是怎么从创建到调用的呢？

来！一起根据道生一、一生二、二生三、三生万物的准则，走进元类的生命周期吧！

 1 # 道生一：传入type
 2 class SayMetaClass(type):
 3  
 4     # 传入三大永恒命题：类名称、父类、属性
 5     def __new__(cls, name, bases, attrs):
 6         # 创造“天赋”
 7         attrs[‘say_‘+name] = lambda self,value,saying=name: print(saying+‘,‘+value+‘!‘)
 8         # 传承三大永恒命题：类名称、父类、属性
 9         return type.__new__(cls, name, bases, attrs)
10  
11 # 一生二：创建类
12 class Hello(object, metaclass=SayMetaClass):
13     pass
14  
15 # 二生三：创建实列
16 hello = Hello()
17  
18 # 三生万物：调用实例方法
19 hello.say_Hello(‘world!‘)

 输出为:

Hello, world!

 注意：通过元类创建的类，第一个参数是父类，第二个参数是metaclass

普通人出生都不会说话，但有的人出生就会打招呼说“Hello”，“你好”,“sayolala”，这就是天赋的力量。它会给我们面向对象的编程省下无数的麻烦。

现在，保持元类不变，我们还可以继续创建Sayolala， Nihao类，如下：

# 一生二：创建类
class Sayolala(object, metaclass=SayMetaClass):
    pass

class Nihao(object, metaclass=SayMetaClass):
    pass
 
# 二生三：创建实列
s = Sayolala()
n = Nihao()
 
# 三生万物：调用实例方法
s.say_Sayolala(‘japan!‘)
n.say_Nihao(‘中华!‘)

 输出结果为：

Sayolala, japan!
Nihao, 中华!

 再来一个小栗子：

 1 # 道生一
 2 class ListMetaclass(type):
 3     def __new__(cls, name, bases, attrs):
 4         # 天赋：通过add方法将值绑定
 5         attrs[‘add‘] = lambda self, value: self.append(value)
 6         return type.__new__(cls, name, bases, attrs)
 7         
 8 # 一生二
 9 class MyList(list, metaclass=ListMetaclass):
10     pass
11     
12 # 二生三
13 L = MyList()
14  
15 # 三生万物
16 L.add(1)

 现在我们打印一下L:

print(L)
>>> [1]

 而普通的list没有add()方法：

1 L2 = list()
2 L2.add(1)
3  
4 >>>AttributeError: ‘list‘ object has no attribute ‘add‘

 太棒了！学到这里，你是不是已经体验到了造物主的乐趣？

年轻的造物主，请随我一起开创新世界。

我们选择两个领域，一个是Django的核心思想，“Object Relational Mapping”，即对象-关系映射，简称ORM。这是Django的一大难点，但学完了元类，一切变得清晰。你对Django的理解将更上一层楼！

另一个领域是爬虫领域（黑客领域），一个自动搜索网络上的可用代理，然后换着IP去突破别的人反爬虫限制。

这两项技能非常有用，也非常好玩！

3 挑战一：通过元类创建ORM

1. 准备工作，创建一个Field类

1 class Field(object):
2  
3     def __init__(self, name, column_type):
4         self.name = name
5         self.column_type = column_type
6  
7     def __str__(self):
8         return ‘<%s:%s>‘ % (self.__class__.__name__, self.name)

 它的作用是：

　　在Field类实例化时将得到两个参数，name和column_type，它们将被绑定为Field的私有属性，如果要将Field转化为字符串时，将返回“Field:XXX” ， XXX是传入的name名称。

2. 准备工作：创建StringField和IntergerField

1 class StringField(Field):
2  
3     def __init__(self, name):
4         super(StringField, self).__init__(name, ‘varchar(100)‘)
5  
6 class IntegerField(Field):
7  
8     def __init__(self, name):
9         super(IntegerField, self).__init__(name, ‘bigint‘)

 它的作用是：在StringField,IntegerField实例初始化时，时自动调用父类的初始化方式。

3. 道生一

 1 class ModelMetaclass(type):
 2  
 3     def __new__(cls, name, bases, attrs):
 4         if name==‘Model‘:
 5             return type.__new__(cls, name, bases, attrs)
 6         print(‘Found model: %s‘ % name)
 7         mappings = dict()
 8         for k, v in attrs.items():
 9             if isinstance(v, Field):
10                 print(‘Found mapping: %s ==> %s‘ % (k, v))
11                 mappings[k] = v
12         for k in mappings.keys():
13             attrs.pop(k)
14         attrs[‘__mappings__‘] = mappings # 保存属性和列的映射关系
15         attrs[‘__table__‘] = name # 假设表名和类名一致
16         return type.__new__(cls, name, bases, attrs)

 它做了以下几件事

1. 创建一个新的字典mapping
2. 将每一个类的属性，通过.items()遍历其键值对。如果值是Field类，则打印键值，并将这一对键值绑定到mapping字典上。
3. 将刚刚传入值为Field类的属性删除。
4. 创建一个专门的__mappings__属性，保存字典mapping。
5. 创建一个专门的__table__属性，保存传入的类的名称。

4. 一生二

 1 class Model(dict, metaclass=ModelMetaclass):
 2  
 3     def __init__(self, **kwarg):
 4         super(Model, self).__init__(**kwarg)
 5  
 6     def __getattr__(self, key):
 7         try:
 8             return self[key]
 9         except KeyError:
10             raise AttributeError("‘Model‘ object has no attribute ‘%s‘" % key)
11  
12     def __setattr__(self, key, value):
13         self[key] = value
14  
15     # 模拟建表操作
16     def save(self):
17         fields = []
18         args = []
19         for k, v in self.__mappings__.items():
20             fields.append(v.name)
21             args.append(getattr(self, k, None))
22         sql = ‘insert into %s (%s) values (%s)‘ % (self.__table__, ‘,‘.join(fields), ‘,‘.join([str(i) for i in args]))
23         print(‘SQL: %s‘ % sql)
24         print(‘ARGS: %s‘ % str(args))

 如果从Model创建一个子类User：

1 class User(Model):
2     # 定义类的属性到列的映射：
3     id = IntegerField(‘id‘)
4     name = StringField(‘username‘)
5     email = StringField(‘email‘)
6     password = StringField(‘password‘)

 这时id= IntegerField(‘id’)就会自动解析为：

Model.__setattr__(self, ‘id’, IntegerField(‘id’))

因为IntergerField(‘id’)是Field的子类的实例，自动触发元类的__new__，所以将IntergerField(‘id’)存入__mappings__并删除这个键值对。

5. 二生三、三生万物

当你初始化一个实例的时候并调用save()方法时候

1 u = User(id=12345, name=‘Batman‘, email=‘[email protected]‘, password=‘iamback‘)
2 u.save()

 这时先完成了二生三的过程：

1. 先调用Model.__setattr__，将键值载入私有对象
2. 然后调用元类的“天赋”，ModelMetaclass.__new__，将Model中的私有对象，只要是Field的实例，都自动存入u.__mappings__。

接下来完成了三生万物的过程：

通过u.save()模拟数据库存入操作。这里我们仅仅做了一下遍历__mappings__操作，虚拟了sql并打印，在现实情况下是通过输入sql语句与数据库来运行。

输出结果为：

Found model: User
Found mapping: name ==> <StringField:username>
Found mapping: password ==> <StringField:password>
Found mapping: id ==> <IntegerField:id>
Found mapping: email ==> <StringField:email>
SQL: insert into User (username,password,id,email) values (Batman,iamback,12345,[email protected])
ARGS: [‘Batman‘, ‘iamback‘, 12345, ‘[email protected]‘]

• 年轻的造物主，你已经和我一起体验了由“道”演化“万物”的伟大历程，这也是Django中的Model版块核心原理。
• 接下来，请和我一起进行更好玩的爬虫实战（嗯，你现在已经是初级黑客了）：网络代理的爬取吧！

4 挑战二：网络代理的爬取

1. 准备工作，先爬个页面玩玩

请确保已安装requests和pyquery这两个包。

 1 # 文件：get_page.py
 2 import requests
 3  
 4 base_headers = {
 5     ‘User-Agent‘: ‘Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36‘,
 6     ‘Accept-Encoding‘: ‘gzip, deflate, sdch‘,
 7     ‘Accept-Language‘: ‘zh-CN,zh;q=0.8‘
 8 }
 9  
10  
11 def get_page(url):
12     headers = dict(base_headers)
13     print(‘Getting‘, url)
14     try:
15         r = requests.get(url, headers=headers)
16         print(‘Getting result‘, url, r.status_code)
17         if r.status_code == 200:
18             return r.text
19     except ConnectionError:
20         print(‘Crawling Failed‘, url)
21         return None

 这里，我们利用request包，把百度的源码爬了出来：

1 if(__name__ == ‘__main__‘):
2     rs = get_page(‘https://www.baidu.com‘)
3     print(‘result:
‘, rs)

 试一试抓代理：

 1 if(__name__ == ‘__main__‘):
 2     from pyquery import PyQuery as pq
 3     start_url = ‘http://www.proxy360.cn/Region/China‘
 4     print(‘Crawling‘, start_url)
 5     html = get_page(start_url)
 6     if html:
 7         doc = pq(html)
 8         lines = doc(‘div[name="list_proxy_ip"]‘).items()
 9         for line in lines:
10             ip = line.find(‘.tbBottomLine:nth-child(1)‘).text()
11             port = line.find(‘.tbBottomLine:nth-child(2)‘).text()
12             print(ip+‘:‘+port)

 接下来进入正题：使用元类批量抓取代理。

2. 批量处理抓取代理

 1 from getpage import get_page
 2 from pyquery import PyQuery as pq
 3  
 4  
 5 # 道生一：创建抽取代理的metaclass
 6 class ProxyMetaclass(type):
 7     """
 8         元类，在FreeProxyGetter类中加入
 9         __CrawlFunc__和__CrawlFuncCount__
10         两个参数，分别表示爬虫函数，和爬虫函数的数量。
11     """
12     def __new__(cls, name, bases, attrs):
13         count = 0
14         attrs[‘__CrawlFunc__‘] = []
15         attrs[‘__CrawlName__‘] = []
16         for k, v in attrs.items():
17             if ‘crawl_‘ in k:
18                 attrs[‘__CrawlName__‘].append(k)
19                 attrs[‘__CrawlFunc__‘].append(v)
20                 count += 1
21         for k in attrs[‘__CrawlName__‘]:
22             attrs.pop(k)
23         attrs[‘__CrawlFuncCount__‘] = count
24         return type.__new__(cls, name, bases, attrs)
25  
26  
27 # 一生二：创建代理获取类
28  
29 class ProxyGetter(object, metaclass=ProxyMetaclass):
30     def get_raw_proxies(self, site):
31         proxies = []
32         print(‘Site‘, site)
33         for func in self.__CrawlFunc__:
34             if func.__name__==site:
35                 this_page_proxies = func(self)
36                 for proxy in this_page_proxies:
37                     print(‘Getting‘, proxy, ‘from‘, site)
38                     proxies.append(proxy)
39         return proxies
40  
41  
42     def crawl_daili66(self, page_count=4):
43         start_url = ‘http://www.66ip.cn/{}.html‘
44         urls = [start_url.format(page) for page in range(1, page_count + 1)]
45         for url in urls:
46             print(‘Crawling‘, url)
47             html = get_page(url)
48             if html:
49                 doc = pq(html)
50                 trs = doc(‘.containerbox table tr:gt(0)‘).items()
51                 for tr in trs:
52                     ip = tr.find(‘td:nth-child(1)‘).text()
53                     port = tr.find(‘td:nth-child(2)‘).text()
54                     yield ‘:‘.join([ip, port])
55  
56     def crawl_proxy360(self):
57         start_url = ‘http://www.proxy360.cn/Region/China‘
58         print(‘Crawling‘, start_url)
59         html = get_page(start_url)
60         if html:
61             doc = pq(html)
62             lines = doc(‘div[name="list_proxy_ip"]‘).items()
63             for line in lines:
64                 ip = line.find(‘.tbBottomLine:nth-child(1)‘).text()
65                 port = line.find(‘.tbBottomLine:nth-child(2)‘).text()
66                 yield ‘:‘.join([ip, port])
67  
68     def crawl_goubanjia(self):
69         start_url = ‘http://www.goubanjia.com/free/gngn/index.shtml‘
70         html = get_page(start_url)
71         if html:
72             doc = pq(html)
73             tds = doc(‘td.ip‘).items()
74             for td in tds:
75                 td.find(‘p‘).remove()
76                 yield td.text().replace(‘ ‘, ‘‘)
77  
78  
79 if __name__ == ‘__main__‘:
80     # 二生三：实例化ProxyGetter
81     crawler = ProxyGetter()
82     print(crawler.__CrawlName__)
83     # 三生万物
84     for site_label in range(crawler.__CrawlFuncCount__):
85         site = crawler.__CrawlName__[site_label]
86         myProxies = crawler.get_raw_proxies(site)

道生一：元类的__new__中，做了四件事：

1. 将“crawl_”开头的类方法的名称推入ProxyGetter.__CrawlName__
2. 将“crawl_”开头的类方法的本身推入ProxyGetter.__CrawlFunc__
3. 计算符合“crawl_”开头的类方法个数
4. 删除所有符合“crawl_”开头的类方法

怎么样？是不是和之前创建ORM的__mappings__过程极为相似？

一生二：类里面定义了使用pyquery抓取页面元素的方法

分别从三个免费代理网站抓取了页面上显示的全部代理。

如果对yield用法不熟悉，可以查看：廖雪峰的python教程：生成器

二生三：创建实例对象crawler

略

三生万物：遍历每一个__CrawlFunc__

1. 在ProxyGetter.__CrawlName__上面，获取可以抓取的的网址名。
2. 触发类方法ProxyGetter.get_raw_proxies(site)
3. 遍历ProxyGetter.__CrawlFunc__,如果方法名和网址名称相同的，则执行这一个方法
4. 把每个网址获取到的代理整合成数组输出。

那么。。。怎么利用批量代理，冲击别人的网站，套取别人的密码，狂发广告水贴，定时骚扰客户？ 呃！想啥呢！这些自己悟！如果悟不到，请听下回分解！

年轻的造物主，创造世界的工具已经在你手上，请你将它的威力发挥到极致！

请记住挥动工具的口诀：

• 道生一，一生二，二生三，三生万物
• 我是谁，我来自哪里，我要到哪里去

 

 

本文参考资料：http://python.jobbole.com/88795/