Python上下文管理器与with语句

什么是上下文管理器

上下文管理器顾名思义是管理上下文的,也就是负责冲锋和垫后,而让主人专心完成自己的事情。我们在编写程序的时候,通常会将一系列操作放到一个语句块中,当某一条件为真时执行该语句快。有时候,我们需要再执行一个语句块时保持某种状态,并且在离开语句块后结束这种状态。例如对文件的操作,我们在打开一个文件进行读写操作时需要保持文件处于打开状态,而等操作完成之后要将文件关闭。所以,上下文管理器的任务是:代码块执行前准备,代码块执行后收拾。上下文管理器是在Python2.5加入的功能,它能够让你的代码可读性更强并且错误更少。

需求的产生

在正常的管理各种系统资源(文件、锁定和连接),在涉及到异常时通常是个棘手的问题。异常很可能导致控制流跳过负责释放关键资源的语句。例如打开一个文件进行操作时,如果意外情况发生(磁盘已满、特殊的终端信号让其终止等),就会抛出异常,这样可能最后的文件关闭操作就不会执行。如果这样的问题频繁出现,则可能耗尽系统资源。

是的,这样的问题并不是不可避免。在没有接触到上下文管理器之前,我们可以用“try/finally”语句来解决这样的问题。或许在有些人看来,“try/finally”语句显得有些繁琐。上下文管理器就是被设计用来简化“try/finally”语句的,这样可以让程序更加简洁。

With语句

With语句用于执行上下文操作,它也是复合语句的一种,其基本语法如下所示:

with context_expr [as var]:
    with_suite

With 语句仅能工作于支持上下文管理协议(context management protocol)的对象。也就是说只有内建了"上下文管理"的对象才能和 with 一起工作。Python内置了一些支持该协议的对象,如下所列是一个简短列表:

  • file
  • decimal.Context
  • thread.LockType
  • threading.Lock
  • threading.RLock
  • threading.Condition
  • threading.Semaphore
  • threading.BoundedSemaphore

由以上列表可以看出,file 是已经内置了对上下文管理协议的支持。所以我们可以用下边的方法来操作文件:

with open(‘/etc/passwd‘, ‘r‘) as f:
    for eachLine in f:
        # ...do stuff with eachLine or f...

上边的代码试图打开一个文件,如果一切正常,把文件对象赋值给 f。然后用迭代器遍历文件中的每一行,当 完成时,关闭文件。无论是在这一段代码的开始,中间,还是结束时发生异常,会执行清理的代码,此 外文件仍会被自动的关闭。

自定义上下文管理器

要实现上下文管理器,必须实现两个方法:一个负责进入语句块的准备操作,另一个负责离开语句块的善后操作。Python类包含两个特殊的方法,分别名为:__enter____exit__

  • enter: 该方法进入运行时上下文环境,并返回自身或另一个与运行时上下文相关的对象。返回值会赋给 as 从句后面的变量,as 从句是可选的。
  • exit: 该方法退出当前运行时上下文并返回一个布尔值,该布尔值标明了“如果 with_suit 的退出是由异常引发的,该异常是否须要被忽略”。如果 exit() 的返回值等于 False,那么这个异常将被重新引发一次;如果 exit() 的返回值等于 True,那么这个异常就被无视掉,继续执行后面的代码。

With 语句的实际执行流程是这样的:

1. 执行 context_exp 以获取上下文管理器
2. 加载上下文管理器的 exit() 方法以备稍后调用
3. 调用上下文管理器的 enter() 方法
4. 如果有 as var 从句,则将 enter() 方法的返回值赋给 var
5. 执行子代码块 with_suit
6. 调用上下文管理器的 exit() 方法,如果 with_suit 的退出是由异常引发的,那么该异常的 type、value 和 traceback 会作为参数传给 exit(),否则传三个 None
7. 如果 with_suit 的退出由异常引发,并且 exit() 的返回值等于 False,那么这个异常将被重新引发一次;如果 exit() 的返回值等于 True,那么这个异常就被无视掉,继续执行后面的代码

下面我们自己来实现一个支持上下文管理协议的文件操作:

#! /usr/bin/env python
# -*- coding: utf-8 -*-

# *************************************************************
#     Filename @  contextfile.py
#       Author @  Huoty
#  Create date @  2015-08-08 17:02:13
#  Description @
# *************************************************************

filename = ‘my_file.txt‘
mode = ‘w‘ # Mode that allows to write to the file
writer = open(filename, mode)

class PypixOpen(object):
    def __init__(self, filename, mode):
        self.filename = filename
        self.mode = mode

    def __enter__(self):
        self.openedFile = open(self.filename, self.mode)
        return self.openedFile

    def __exit__(self, *unused):
        self.openedFile.close()

# Script starts from here

with PypixOpen(filename, mode) as writer:
    writer.write("Hello World from our new Context Manager!")

更加优雅的上下文管理(contextlib模块)

contextlib模块提供更易用的上下文管理器。

contextlib.closing

contextlib.closing 方法在语句块结束后调用对象的 close 方法。

from contextlib import closing
import urllib

with closing(urllib.urlopen(‘http://www.python.org‘)) as page:
    for line in page:
        print line

contextlib.nested

contextlib.nested 方法用于替换嵌套的 with 语句。例如,有两个文件,一个读一个写,即进行拷贝。以下是不提倡的用法:

with open(‘toReadFile‘, ‘r‘) as reader:
    with open(‘toWriteFile‘, ‘w‘) as writer:
        writer.writer(reader.read())

这里可以用 contextlib.nested 进行优化:

with contextlib.nested(open(‘fileToRead.txt‘, ‘r‘),            open(‘fileToWrite.txt‘, ‘w‘)) as (reader, writer):
    writer.write(reader.read())

contextlib.contextmanager

contextlib.contextmanager 是一个装饰器,它可以用来装饰被 yield 语句分割成两部分的函数,以此进行上下文管理。任何在yield之前的内容都可以看做在代码块执行前的操作,而任何yield之后的操作都可以看做是代码块结束后要做的操作。如果希望在上下文管理器中使用 “as” 关键字,那么就用 yield 返回你需要的值,它将通过 as 关键字赋值给新的变量。

from contextlib import contextmanager

@contextmanager
def tag(name):
    print "<%s>" % name
    yield
    print "</%s>" % name

使用 contextlib.contextmanager 时,可以大致套用如下的框架:

from contextlib import contextmanager

@contextmanager
def closing(thing):
    try:
        yield thing
    finally:
        thing.close()

原文地址:https://www.cnblogs.com/paisenpython/p/10339478.html

时间: 2024-10-07 02:45:42

Python上下文管理器与with语句的相关文章

python上下文管理器及with语句

with语句支持在一个叫上下文管理器的对象的控制下执行一系列语句,语法大概如下: with context as var: statements 其中的context必须是个上下文管理器,它实现了两个方法__enter__,__exit__. 1.需求是怎么产生的 在正常的管理各种系统资源(文件.锁定和连接),在涉及到异常时通常是个棘手的问题.异常很可能导致控制流跳过负责释放关键资源的语句. 看一段简单的文件写入代码: filename = 'my_file.txt' f = open(file

python上下文管理器ContextLib及with语句

http://blog.csdn.net/pipisorry/article/details/50444736 with语句 with语句是从 Python 2.5 开始引入的一种与异常处理相关的功能(2.5 版本中要通过 from __future__ import with_statement 导入后才可以使用),从 2.6 版本开始缺省可用(参考 What's new in Python 2.6? 中 with 语句相关部分介绍).with 语句适用于对资源进行访问的场合,确保不管使用过程

Python核心技术与实战——二一|巧用上下文管理器和with语句精简代码

我们在Python中对于with的语句应该是不陌生的,特别是在文件的输入输出操作中,那在具体的使用过程中,是有什么引伸的含义呢?与之密切相关的上下文管理器(context manager)又是什么呢? 什么是上下文管理器 在任何一种编程语言里,文件的输入输出.数据库的建立连接和断开等操作,都是很常见的资源管理操作.但是资源是有限的,在写程序的时候,我们必须保证这些资源在使用后得到释放,不然就容易造成资源泄漏,轻者系统处理缓慢,重则系统崩溃. 我们看一个例子: for i in range(100

Python上下文管理器

上下文管理器 在使用Python编程中,可以会经常碰到这种情况:有一个特殊的语句块,在执行这个语句块之前需要先执行一些准备动作:当语句块执行完成后,需要继续执行一些收尾动作. 例如:当需要操作文件或数据库的时候,首先需要获取文件句柄或者数据库连接对象,当执行完相应的操作后,需要执行释放文件句柄或者关闭数据库连接的动作. 又如,当多线程程序需要访问临界资源的时候,线程首先需要获取互斥锁,当执行完成并准备退出临界区的时候,需要释放互斥锁. 对于这些情况,Python中提供了上下文管理器(Contex

Python 上下文管理器和else块

最终,上下文管理器可能几乎与子程序(subroutine)本身一样重要.目前,我们只了解了上下文管理器的皮毛--Basic 语言有with 语句,而且很多语言都有.但是,在各种语言中 with 语句的作用不同,而且做的都是简单的事,虽然可以避免不断使用点号查找属性,但是不会做事前准备和事后清理.不要觉得名字一样,就意味着作用也一样.with 语句是非常了不起的特性.  --Raymond Hettinger 雄辩的 Python 布道者 先做这个,再做那个:if语句之外的else块 这个语言特性

python --上下文管理器

转自:http://www.cnblogs.com/vamei/archive/2012/11/23/2772445.html 上下文管理器(context manager)是Python2.5开始支持的一种语法,用于规定某个对象的使用范围.一旦进入或者离开该使用范围,会有特殊操作被调用 (比如为对象分配或者释放内存).它的语法形式是with...as... 关闭文件 我们会进行这样的操作:打开文件,读写,关闭文件.程序员经常会忘记关闭文件.上下文管理器可以在不需要文件的时候,自动关闭文件. 下

Python上下文管理器(Context managers)

上下文管理器(Context managers) 上下文管理器允许你在有需要的时候,精确地分配和释放资源. 使用上下文管理器最广泛的案例就是with语句了.想象下你有两个需要结对执行的相关操作,然后还要在它们中间放置一段代码.上下文管理器就是专门让你做这种事情的.举个例子: with open('some_file', 'w') as opened_file: opened_file.write('Hola!') 上面这段代码打开了一个文件,往里面写入了一些数据,然后关闭该文件.如果在往文件写数

Python 上下文管理器模块--contextlib

在 Python 处理文件的时候我们使用 with 关键词来进行文件的资源关闭,但是并不是只有文件操作才能使用 with 语句.今天就让我们一起学习 Python 中的上下文管理 contextlib. 上下文管理器 上下文,简而言之,就是程式所执行的环境状态,或者说程式运行的情景.既然提及上下文,就不可避免的涉及 Python 中关于上下文的魔法.上下文管理器(context manager)是 Python2.5 开始支持的一种语法,用于规定某个对象的使用范围.一旦进入或者离开该使用范围,会

吃透Python上下文管理器

什么是上下文管理器? 我们常见的with open操作文件,就是一个上下文管理器.如: with open(file, 'rb') as f: text = f.read() 那上下文管理器具体的定义是什么呢? 上下文管理器:是指在一段代码执行之前执行一段代码,用于一些预处理工作:执行之后再执行一段代码,用于一些清理工作. 比如刚提到的文件操作,打开文件进行读写,读写完之后需要将文件关闭.很明显用到了上下文管理器.主要依靠__enter__.__exit__这两个"魔术方法"实现. _