探索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字符串拼接、截取及替换方法总结分析
Apr 13 Python
Python学习入门之区块链详解
Jul 25 Python
Django如何配置mysql数据库
May 04 Python
解决Djang2.0.1中的reverse导入失败的问题
Aug 16 Python
在python image 中安装中文字体的实现方法
Aug 22 Python
django-rest-swagger对API接口注释的方法
Aug 29 Python
python函数装饰器之带参数的函数和带参数的装饰器用法示例
Nov 06 Python
pytorch获取模型某一层参数名及参数值方式
Dec 30 Python
Python如何爬取qq音乐歌词到本地
Jun 01 Python
使用Python快速打开一个百万行级别的超大Excel文件的方法
Mar 02 Python
Python趣味挑战之教你用pygame画进度条
May 31 Python
告别网页搜索!教你用python实现一款属于自己的翻译词典软件
Jun 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
模仿OSO的论坛(四)
2006/10/09 PHP
PHP无敌近乎加密方式!
2010/07/17 PHP
php实现利用phpexcel导出数据
2013/08/24 PHP
php示例详解Constructor Prototype Pattern 原型模式
2015/10/15 PHP
php使用number_format函数截取小数的方法分析
2016/05/27 PHP
理解JSON:3分钟课程
2011/10/28 Javascript
JavaScript中:表达式和语句的区别[译]
2012/09/17 Javascript
php对mongodb的扩展(初识如故)
2012/11/11 Javascript
html dom节点操作(获取/修改/添加或删除)
2014/01/23 Javascript
jquery中get和post的简单实例
2014/02/04 Javascript
jQuery实现鼠标滚轮动态改变样式或效果
2015/01/05 Javascript
JavaScript中的条件判断语句使用详解
2015/06/03 Javascript
Javascript函数的参数
2015/07/16 Javascript
BootstrapTable与KnockoutJS相结合实现增删改查功能【二】
2016/05/10 Javascript
有关JavaScript中call()和apply() 的一些理解
2016/05/20 Javascript
PHP获取当前页面完整URL的方法
2016/12/02 Javascript
详解vue2.0 使用动态组件实现 Tab 标签页切换效果(vue-cli)
2017/08/30 Javascript
vue滚动轴插件better-scroll使用详解
2017/10/17 Javascript
JS交互点击WKWebView中的图片实现预览效果
2018/01/05 Javascript
JavaScript中click和onclick本质区别与用法分析
2018/06/07 Javascript
react 移动端实现列表左滑删除的示例代码
2019/07/04 Javascript
layui问题之模拟table表格中的选中按钮选中事件的方法
2019/09/20 Javascript
vue设置全局访问接口API地址操作
2020/08/14 Javascript
vue实现移动端返回顶部
2020/10/12 Javascript
Python字符串、元组、列表、字典互相转换的方法
2016/01/23 Python
python整合ffmpeg实现视频文件的批量转换
2019/05/31 Python
将自己的数据集制作成TFRecord格式教程
2020/02/17 Python
Python运行提示缺少模块问题解决方案
2020/04/02 Python
python 统计list中各个元素出现的次数的几种方法
2021/02/20 Python
蒙蒂塞罗商店:Monticello Shop
2018/11/25 全球购物
加拿大户外探险购物网站:SAIL
2020/06/27 全球购物
C和C++经典笔试题附答案解析
2014/08/18 面试题
电子商务专员岗位职责
2013/12/11 职场文书
企业宣传口号
2014/06/12 职场文书
电话客服专员岗位职责
2014/06/28 职场文书
swagger如何返回map字段注释
2021/07/03 Java/Android