Python新增功能详解上下文管理器(1)

文章由Byrx.net分享于2019-03-21 06:03:30评论（448）

Python新增功能详解上下文管理器(1)

这篇文章是关于什么的？

什么是Python中的上下文管理器
怎么使用上下文管理器
如何创建自己的上下文管理器
关于Python上下文库(contextlib)

1. 上下文管理器是什么？

举个例子，你在写Python代码的时候经常将一系列操作放在一个语句块中：

当某条件为真 – 执行这个语句块

当某条件为真 – 循环执行这个语句块

有时候我们需要在当程序在语句块中运行时保持某种状态，并且在离开语句块后结束这种状态。

所以，事实上上下文管理器的任务是 – 代码块执行前准备，代码块执行后收拾。

上下文管理器是在Python2.5加入的功能，它能够让你的代码可读性更强并且错误更少。接下来，让我们来看看该如何使用。

context1

2. 如何使用上下文管理器？

看代码是最好的学习方式，来看看我们通常是如何打开一个文件并写入”Hello World”？

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

1-2行，我们指明文件名以及打开方式(写入)。

第3行，打开文件，4-5行写入“Hello world”，第6行关闭文件。

这样不就行了，为什么还需要上下文管理器？但是我们忽略了一个很小但是很重要的细节：如果我们没有机会到达第6行关闭文件，那会怎样？

举个例子，磁盘已满，因此我们在第4行尝试写入文件时就会抛出异常，而第6行则根本没有机会执行。

当然，我们可以使用try-finally语句块来进行包装：

writer = open(filename, mode)  
try:  
    writer.write('Hello ')  
    writer.write('World')  
finally:  
    writer.close()

finally语句块中的代码无论try语句块中发生了什么都会执行。因此可以保证文件一定会关闭。这么做有什么问题么？当然没有，但当我们进行一些比写入“Hello world”更复杂的事情时，try-finally语句就会变得丑陋无比。例如我们要打开两个文件，一个读一个写，两个文件之间进行拷贝操作，那么通过with语句能够保证两者能够同时被关闭。

OK，让我们把事情分解一下：

首先，创建一个名为“writer”的文件变量。

然后，对writer执行一些操作。

最后，关闭writer。

这样是不是优雅多了？

with open(filename, mode) as writer:  
    writer.write('Hello ')   
    writer.write('World')

让我们深入一点，“with”是一个新关键词，并且总是伴随着上下文管理器出现。“open(filename, mode)”曾经在之前的代码中出现。“as”是另一个关键词，它指代了从“open”函数返回的内容，并且把它赋值给了一个新的变量。“writer”是一个新的变量名。

2-3行，缩进开启一个新的代码块。在这个代码块中，我们能够对writer做任意操作。这样我们就使用了“open”上下文管理器，它保证我们的代码既优雅又安全。它出色的完成了try-finally的任务。

open函数既能够当做一个简单的函数使用，又能够作为上下文管理器。这是因为open函数返回了一个文件类型(file type)变量，而这个文件类型实现了我们之前用到的write方法，但是想要作为上下文管理器还必须实现一些特殊的方法，我会在接下来的小节中介绍。

3. 自定义上下文管理器

让我们来写一个“open”上下文管理器。

要实现上下文管理器，必须实现两个方法 – 一个负责进入语句块的准备操作，另一个负责离开语句块的善后操作。同时，我们需要两个参数：文件名和打开方式。

Python类包含两个特殊的方法，分别名为：__enter__以及__exit__(双下划线作为前缀及后缀)。

当一个对象被用作上下文管理器时：

__enter__ 方法将在进入代码块前被调用。

__exit__ 方法则在离开代码块之后被调用(即使在代码块中遇到了异常)。

下面是上下文管理器的一个例子，它分别进入和离开代码块时进行打印。

class PypixContextManagerDemo:  
   
    def __enter__(self):  
        print 'Entering the block' 
   
    def __exit__(self, *unused):  
        print 'Exiting the block' 
   
with PypixContextManagerDemo():  
    print 'In the block' 
   
#Output:  
#Entering the block  
#In the block  
#Exiting the block

注意一些东西：

没有传递任何参数。
在此没有使用“as”关键词。
稍后我们将讨论__exit__方法的参数设置。

我们如何给一个类传递参数？其实在任何类中，都可以使用__init__方法，在此我们将重写它以接收两个必要参数(filename, mode)。

当我们进入语句块时，将会使用open函数，正如第一个例子中那样。而当我们离开语句块时，将关闭一切在__enter__函数中打开的东西。

以下是我们的代码：

class PypixOpen:  
   
    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()  
   
with PypixOpen(filename, mode) as writer:  
    writer.write("Hello World from our new Context Manager!")

来看看有哪些变化：

3-5行，通过__init__接收了两个参数。

7-9行，打开文件并返回。

12行，当离开语句块时关闭文件。

14-15行，模仿open使用我们自己的上下文管理器。

热门文章：

Python新增功能详解上下文管理器(1)