Python-selectors高级I/O复用库

迷南。 2022-12-16 06:44 125阅读 0赞

**目录**

概述

类

SelectorKey

BaseSelector

抽象方法 register(fileobj, events, data=None)

抽象方法unregister(fileobj)

抽象方法select(timeout=None)

DefaultSelector

SelectSelector

PollSelector

EpollSelector

DevpollSelector

KqueueSelector

例子

--------------------

# 概述 #

这个模块允许在select模块原语的基础上实现高水平和高效的I/O复用。我们鼓励用户改用这个模块，除非想精确控制所使用的操作系统级原语。  
它定义了一个BaseSelector抽象基类，以及几个具体的实现（KqueueSelector、EpollSelector…），可以用来等待多个文件对象上的I/O就绪通知。在下面的“file object”中，“file object”是指具有fileno()方法或原始文件描述符的任何对象。请参见文件对象。  
**DefaultSelector**是当前平台上最有效的实现的别名：对于大多数用户来说，这应该是默认的选择。

注意：

支持的文件对象的类型取决于平台：在Windows上， 支持套接字，但不支持管道，而在Unix上，两者都受支持 （也可能支持其他一些类型，例如fifos或特殊文件设备）。

# 类 #

类层次结构：

BaseSelector
    +-- SelectSelector
    +-- PollSelector
    +-- EpollSelector
    +-- DevpollSelector
    +-- KqueueSelector

在下文中， ***event***是一个位掩码，指示在给定的file对象上应该等待哪些I/O事件。它可以是以下模块的组合：

## `SelectorKey` ##

SelectorKey是一个命名元组，用于将文件对象与其基础文件描述符、选定的事件掩码和附加数据相关联。它由几个BaseSelector方法返回。

*  fileobj：已注册的文件对象。
 *  fd：基础文件描述符。
 *  events：必须在此文件对象上等待的事件。
 *  data：与此文件对象关联的可选不透明数据：例如， 可用于存储每个客户端会话ID。

## `BaseSelector` ##

BaseSelector用于等待多个文件对象上的I/O事件准备就绪。它支持文件流注册、注销和等待这些流上的I/O事件的方法，并提供可选的超时。它是一个抽象基类，因此无法实例化。如果想具体使用一个实现，那么请改用**DefaultSelector**，或者使用SelectSelector、KqueueSelector等之一。BaseSelector及其具体实现支持上下文管理器协议。

### *抽象方法* `register`(*fileobj*, *events*, *data=None*) ###

注册一个文件对象以供选择，监视它的I/O事件。  
fileobj是要监视的文件对象。FileDescriptor()可以是不带整数的FileDescriptor方法。

event是要监视的事件的位掩码。

data是一个不透明的对象。  
返回一个新的SelectorKey实例，如果事件掩码或文件描述符无效，则引发ValueError；如果文件对象已注册，则引发KeyError。

### 抽象方法`unregister`(*fileobj*) ###

从选择中注销文件对象，将其从监视中删除。文件对象在关闭之前应注销。  
fileobj必须是以前注册的文件对象。  
返回关联的SelectorKey实例，或者在fileobj未注册的情况下引发KeyError。如果fileobj无效（例如，它没有fileno()方法或其fileno()方法的返回值无效），则会引发ValueError。

### 抽象方法select(timeout=None) ###

等待一些注册的文件对象准备就绪，或者超时过期。  
如果timeout>0，则指定最大等待时间（以秒为单位）。如果timeout<=0，则调用不会阻塞，并将报告当前就绪的文件对象。如果一个timeout为“None”，调用将被阻止，直到被监视的文件对象准备就绪。  
返回（key，events）元组的列表，每个就绪file对象一个。

*  key是与ready file对象对应的SelectorKey实例。
 *  events是此文件对象上准备好的事件的位掩码。

注意：

如果当前进程接收到信号，则此方法可以在任何文件对象准备就绪或超时之前返回：在这种情况下，将返回一个空列表。

## `DefaultSelector` ##

默认选择器类，使用当前平台上最有效的实现。这应该是大多数用户的默认选择。

## `SelectSelector` ##

基于选择器select.selector()。

## `PollSelector` ##

基于选择器select.poll()。

## `EpollSelector` ##

基于选择器select.epoll()。

`fileno`():返回底层使用的文件描述符select.epoll()对象。

## `DevpollSelector` ##

基于选择器select.devpoll()。

`fileno`():返回底层使用的文件描述符select.devpoll()对象。

## `KqueueSelector` ##

基于选择器select.kqueuepoll()。

`fileno`():返回底层使用的文件描述符select.kqueue()对象。

# 例子 #

这是一个简单的回显服务器实现：

import selectors
    import socket
    
    sel = selectors.DefaultSelector()
    
    def accept(sock, mask):
        conn, addr = sock.accept()  # Should be ready
        print('accepted', conn, 'from', addr)
        conn.setblocking(False)
        sel.register(conn, selectors.EVENT_READ, read)
    
    def read(conn, mask):
        data = conn.recv(1000)  # Should be ready
        if data:
            print('echoing', repr(data), 'to', conn)
            conn.send(data)  # Hope it won't block
        else:
            print('closing', conn)
            sel.unregister(conn)
            conn.close()
    
    sock = socket.socket()
    sock.bind(('localhost', 6633))
    sock.listen(100)
    sock.setblocking(False)
    sel.register(sock, selectors.EVENT_READ, accept)
    
    while True:
        events = sel.select()
        for key, mask in events:
            callback = key.data
            callback(key.fileobj, mask)

上篇文章[python-网络编程之socket][python-_socket]的Tcp客户端：

import socket
    import time
    
    IP = '127.0.0.1'
    PORT = 6633
    DELAY = 2  # 延迟时间
    DATA = "Hello Socket"
    
    
    def TcpClient():
        # 建立一个客户端
        client = socket.socket(socket.AF_INET, socket.SOCK_STREAM)  # 声明socket类型，同时生成链接对象
        try:
            client.connect((IP, PORT))  # 建立一个链接，连接到本地的6969端口
        except ConnectionRefusedError:
            print("服务器无法连接，请确保服务器端已打开。")
            exit(0)
        while True:
            try:
                client.sendall(DATA.encode("utf-8"))
                print(DATA, "已发送")
                data = client.recv(1024)  # 接收一个信息，并指定接收的大小 为1024字节
                print("接收到:", data)
                time.sleep(DELAY)
            except ConnectionAbortedError:
                print("服务器无法连接，请确保服务器端已打开。")
                exit(0)
            except KeyboardInterrupt:
                client.close()
                print("Tcp 客户端已关闭")
                exit(0)
    
    
    if __name__ == "__main__":
        TcpClient()

结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhZHlfa2lsbGVyOQ_size_16_color_FFFFFF_t_70][] 服务器端

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhZHlfa2lsbGVyOQ_size_16_color_FFFFFF_t_70 1][] 客户端

刚学完，有更多例子再来补充。

更多python相关内容：[【python总结】python学习框架梳理][python_python]

本人b站账号:[lady\_killer9][lady_killer9]

有问题请下方评论，转载请注明出处，并附有原文链接，谢谢！如有侵权，请及时联系。如果您感觉有所收获，自愿打赏，可选择支付宝18833895206（小于），您的支持是我不断更新的动力。

[python-_socket]: https://blog.csdn.net/lady_killer9/article/details/107000864
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhZHlfa2lsbGVyOQ_size_16_color_FFFFFF_t_70]: /images/20221123/032cadf868874a7a934fd07152154a9b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhZHlfa2lsbGVyOQ_size_16_color_FFFFFF_t_70 1]: /images/20221123/49e3ccb925ed4902a2fd7dbd0d1ff10d.png
[python_python]: https://blog.csdn.net/lady_killer9/article/details/108763489
[lady_killer9]: https://space.bilibili.com/374432302