探索Python3.4中新引入的asyncio模块


Posted in Python onApril 08, 2015

使用 Simple Protocol

asyncio.BaseProtocol 类是asyncio模块中协议接口(protocol interface)的一个常见的基类。asyncio.Protocolclass 继承自asyncio.BaseProtocol 并为stream protocols提供了一个接口。下面的代码演示了asyncio.Protocol 接口的一个简单实现,它的行为1就像一个echo server,同时,它还会在Python的控制台中输出一些信息。SimpleEchoProtocol 继承自asyncio.Protocol,并且实现了3个方法:connection_made, data_received 以及 andconnection_lost:

import asyncio
 
class SimpleEchoProtocol(asyncio.Protocol):
  def connection_made(self, transport):
    """
    Called when a connection is made.
    The argument is the transport representing the pipe connection.
    To receive data, wait for data_received() calls.
    When the connection is closed, connection_lost() is called.
    """
    print("Connection received!")
    self.transport = transport
 
  def data_received(self, data):
    """
    Called when some data is received.
    The argument is a bytes object.
    """
    print(data)
    self.transport.write(b'echo:')
    self.transport.write(data)
 
  def connection_lost(self, exc):
    """
    Called when the connection is lost or closed.
    The argument is an exception object or None (the latter
    meaning a regular EOF is received or the connection was
    aborted or closed).
    """
    print("Connection lost! Closing server...")
    server.close()
 
loop = asyncio.get_event_loop()
server = loop.run_until_complete(loop.create_server(SimpleEchoProtocol, 'localhost', 2222))
loop.run_until_complete(server.wait_closed())

你可以通过运行一个telnet客户端程序,并且连接到localhost的2222端口来测试这个echo server。如果你正在使用这个端口,你可以将这个端口号修改为任何其他可以使用的端口。如果你使用默认的值,你可以在Python的控制台中运行上面的代码,之后在命令提示符或终端中运行 telnet localhost 2222。你将会看到 Connection received! 的信息显示在Python的控制台中。接下来,你在telnet的控制台中输入的任何字符都会以echo:跟上输入的字符的形式展示出来,同时,在Python的控制台中会显示出刚才新输入的字符。当你退出telnet控制台时,你会看到Connection lost! Closing server... 的信息展示在Python的控制台中。

举个例子,如果你在开启telnet之后输入 abc,你将会在telnet的窗口中看到下面的消息:

echo:abecho:bcecho:c

此外,在Python的控制台中会显示下面的消息:

Connection received!
 b'a'
 b'b'
 b'c'
 Connection lost! Closing server...

在创建了一个名为loop的事件循环之后,代码将会调用loop.run_until_complete来运行loop.create_server这个协程(coroutine)。这个协程创建了一个TCP服务器并使用protocol的工厂类绑定到指定主机的指定端口(在这个例子中是localhost上的2222端口,使用的工厂类是SimpleEchoProtocol)并返回一个Server的对象,以便用来停止服务。代码将这个实例赋值给server变量。用这种方式,当建立一个客户端连接时,会创建一个新的SimpleEchoProtocol的实例并且该类中的方法会被执行。

当成功的创建了一个连接之后,connection_made 方法里面的代码输出了一条消息,并将收到的内容作为一个参数赋值给transport成员变量,以便稍后在另一个方法中使用。

当收到了传来的数据时,data_received方面里面的代码会将收到的数据字节输出,并且通过调用两次self.transport.write 方法将echo: 和收到数据发送给客户端。当然了,也可以只调用一次self.transport.write将所有的数据返回,但是我想更清楚的将发送echo:的代码和发送收到的数据的代码区分开来。

当连接关掉或者断开时,connection_lost方法中的代码将会输出一条消息,并且调用server.close();此时,那个在服务器关闭前一直运行的循环停止了运行。
使用 Clients and Servers

在上面的例子中,telnet是一个客户端。asyncio模块提供了一个协程方便你很容易的使用stream reader 和 writer来编写服务端和客户端。下面的代码演示了一个简单的echo server,该server监听localhost上的2222端口。你可以在Python的控制台中运行下面的代码,之后在另一个Python的控制台中运行客户端的代码作为客户端。

import asyncio
 
@asyncio.coroutine
def simple_echo_server():
  # Start a socket server, call back for each client connected.
  # The client_connected_handler coroutine will be automatically converted to a Task
  yield from asyncio.start_server(client_connected_handler, 'localhost', 2222)
 
@asyncio.coroutine
def client_connected_handler(client_reader, client_writer):
  # Runs for each client connected
  # client_reader is a StreamReader object
  # client_writer is a StreamWriter object
  print("Connection received!")
  while True:
    data = yield from client_reader.read(8192)
    if not data:
      break
    print(data)
    client_writer.write(data)
 
loop = asyncio.get_event_loop()
loop.run_until_complete(simple_echo_server())
try:
  loop.run_forever()
finally:
  loop.close()

下面的代码演示了一个客户端程序连接了localhost上的2222端口,并且使用asyncio.StreamWriter对象写了几行数据,之后使用asyncio.StreamWriter对象读取服务端返回的数据。
 

import asyncio
 
LASTLINE = b'Last line.\n'
 
@asyncio.coroutine
 def simple_echo_client():
  # Open a connection and write a few lines by using the StreamWriter object
  reader, writer = yield from asyncio.open_connection('localhost', 2222)
  # reader is a StreamReader object
  # writer is a StreamWriter object
  writer.write(b'First line.\n')
  writer.write(b'Second line.\n')
  writer.write(b'Third line.\n')
  writer.write(LASTLINE)
 
  # Now, read a few lines by using the StreamReader object
  print("Lines received")
  while True:
    line = yield from reader.readline()
    print(line)
    if line == LASTLINE or not line:
      break
  writer.close()
 
loop = asyncio.get_event_loop()
loop.run_until_complete(simple_echo_client())

你可以在不同的Python控制台中执行客户端的代码。如果服务端正在运行,控制台中会输出下面的内容:

Lines received
b'First line.\n'
b'Second line.\n'
b'Third line.\n'
b'Last line.\n'

执行服务端代码的Python控制台会显示下面的内容:

Connection received!
 b'First line.\nSecond line.\nThird line.\nLast line.\n'

首先,让我们关注一下服务端的代码。在创建完一个叫loop的事件循环之后,代码会调用loop.run_until_complete来运行这个simple_echo_server协程。该协程调用asyncio.start_server协程来开启一个socket服务器,绑定到指定的主机和端口号,之后,对每一个客户端连接执行作为参数传入的回调函数——client_connected_handler。在这个例子中,client_connected_handler是另一个协程,并且不会被自动的转换为一个Task。除了协程(coroutine)之外,你可以指定一个普通的回调函数。

Python 相关文章推荐
python 解析XML python模块xml.dom解析xml实例代码
Feb 07 Python
在Python中使用PIL模块处理图像的教程
Apr 29 Python
python fabric使用笔记
May 09 Python
HTML中使用python屏蔽一些基本功能的方法
Jul 07 Python
python利用urllib实现爬取京东网站商品图片的爬虫实例
Aug 24 Python
python虚拟环境virtualenv的安装与使用
Sep 21 Python
python自定义线程池控制线程数量的示例
Feb 22 Python
Python、 Pycharm、Django安装详细教程(图文)
Apr 12 Python
Python完成哈夫曼树编码过程及原理详解
Jul 29 Python
Python使用gluon/mxnet模块实现的mnist手写数字识别功能完整示例
Dec 18 Python
python实现的分层随机抽样案例
Feb 25 Python
详解python中的异常和文件读写
Jan 03 Python
Windows下用py2exe将Python程序打包成exe程序的教程
Apr 08 #Python
Python bsddb模块操作Berkeley DB数据库介绍
Apr 08 #Python
Python使用scrapy采集数据过程中放回下载过大页面的方法
Apr 08 #Python
在Python中使用M2Crypto模块实现AES加密的教程
Apr 08 #Python
Python使用scrapy采集时伪装成HTTP/1.1的方法
Apr 08 #Python
Python打印scrapy蜘蛛抓取树结构的方法
Apr 08 #Python
使用IPython来操作Docker容器的入门指引
Apr 08 #Python
You might like
php树型类实例
2014/12/05 PHP
php函数式编程简单示例
2019/08/08 PHP
JavaScript 克隆数组最简单的方法
2009/02/12 Javascript
jQuery调用RESTful WCF示例代码(GET方法/POST方法)
2014/01/26 Javascript
了解Javascript的模块化开发
2015/03/02 Javascript
javascript实现的多个层切换效果通用函数实例
2015/07/06 Javascript
JS脚本根据手机浏览器类型跳转WAP手机网站(两种方式)
2015/08/04 Javascript
纯JavaScript代码实现移动设备绘图解锁
2015/10/16 Javascript
Nodejs学习item【入门手上】
2016/05/05 NodeJs
js html5 css俄罗斯方块游戏再现
2016/10/17 Javascript
面试常见的js算法题
2017/03/23 Javascript
JS获取填报扩展单元格控件的值的解决办法
2017/07/14 Javascript
浅谈AngularJS中使用$resource(已更新)
2017/09/14 Javascript
微信小程序纯文本实现@功能
2020/04/08 Javascript
Vue实现指令式动态追加小球动画组件的步骤
2020/12/18 Vue.js
[03:58]2014DOTA2国际邀请赛 龙宝赛后解密DK获胜之道
2014/07/14 DOTA
python类型强制转换long to int的代码
2013/02/10 Python
python实现从网络下载文件并获得文件大小及类型的方法
2015/04/28 Python
详解Python中open()函数指定文件打开方式的用法
2016/06/04 Python
Python单元测试实例详解
2018/05/25 Python
python中将zip压缩包转为gz.tar的方法
2018/10/18 Python
python爬取淘宝商品销量信息
2018/11/16 Python
十行代码使用Python写一个USB病毒
2019/06/21 Python
Python双链表原理与实现方法详解
2020/02/22 Python
HTML5移动端手机网站开发流程
2016/04/25 HTML / CSS
英国马匹装备和马术用品购物网站:Equine Superstore
2019/03/03 全球购物
婚鞋、新娘鞋、礼服鞋、童鞋:Nina Shoes
2019/09/04 全球购物
德国帽子专家:Hutshopping
2019/11/03 全球购物
指针和引用有什么区别
2013/01/13 面试题
应聘自荐信
2013/12/14 职场文书
建筑项目策划书
2014/01/13 职场文书
房地产促销活动方案
2014/03/01 职场文书
镇人大副主席民主生活会对照检查材料思想汇报
2014/10/01 职场文书
护士求职自荐信
2015/03/25 职场文书
信息技术国培研修日志
2015/11/13 职场文书
调解协议书范本
2016/03/21 职场文书