python语言中with as的用法使用详解

￡神魔★判官ぃ 2023-10-08 08:48 122阅读 0赞

本篇文章主要介绍了python语言中with as的用法使用详解，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

**With语句是什么？**

有一些任务，可能事先需要设置，事后做清理工作。对于这种场景，Python的with语句提供了一种非常方便的处理方式。一个很好的例子是文件处理，你需要获取一个文件句柄，从文件中读取数据，然后关闭文件句柄。  
如果不用with语句，代码如下：

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>file</code> <code>=</code> <code>open</code><code>(</code><code>"/tmp/foo.txt"</code><code>)</code> <code>data </code><code>=</code> <code>file</code><code>.read()</code> <code>file</code><code>.close()</code> </td> 
 </tr> 
 </tbody> 
</table>

这里有两个问题。一是可能忘记关闭文件句柄；二是文件读取数据发生异常，没有进行任何处理。下面是处理异常的加强版本：

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>file</code> <code>=</code> <code>open</code><code>(</code><code>"/tmp/foo.txt"</code><code>)</code> <code>try</code><code>:</code> <code>&nbsp;&nbsp;</code><code>data </code><code>=</code> <code>file</code><code>.read()</code> <code>finally</code><code>:</code> <code>&nbsp;&nbsp;</code><code>file</code><code>.close()</code> </td> 
 </tr> 
 </tbody> 
</table>

虽然这段代码运行良好，但是太冗长了。这时候就是with一展身手的时候了。除了有更优雅的语法，with还可以很好的处理上下文环境产生的异常。下面是with版本的代码：

[?][Link 1]

**with如何工作？**

这看起来充满魔法，但不仅仅是魔法，Python对with的处理还很聪明。基本思想是with所求值的对象必须有一个\_\_enter\_\_()方法，一个\_\_exit\_\_()方法。

紧跟with后面的语句被求值后，返回对象的\_\_enter\_\_()方法被调用，这个方法的返回值将被赋值给as后面的变量。当with后面的代码块全部被执行完之后，将调用前面返回对象的\_\_exit\_\_()方法。

下面例子可以具体说明with如何工作：

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> <code>#!/usr/bin/env python</code> <code># with_example01.py</code> <code>&nbsp;</code>&nbsp; <code>class</code> <code>Sample:</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>__enter__(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code> <code>"In __enter__()"</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>"Foo"</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;</code><code>def</code> <code>__exit__(</code><code>self</code><code>, </code><code>type</code><code>, value, trace):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code> <code>"In __exit__()"</code> <code>&nbsp;</code>&nbsp; <code>def</code> <code>get_sample():</code> <code>&nbsp;&nbsp;</code><code>return</code> <code>Sample()</code> <code>&nbsp;</code>&nbsp; <code>with get_sample() as sample:</code> <code>&nbsp;&nbsp;</code><code>print</code> <code>"sample:"</code><code>, sample</code> </td> 
 </tr> 
 </tbody> 
</table>

运行代码，输出如下

> In \_\_enter\_\_()  
> sample: Foo  
> In \_\_exit\_\_()

正如你看到的，

1. \_\_enter\_\_()方法被执行

2. \_\_enter\_\_()方法返回的值 - 这个例子中是"Foo"，赋值给变量'sample'

3. 执行代码块，打印变量"sample"的值为 "Foo"

4. \_\_exit\_\_()方法被调用

with真正强大之处是它可以处理异常。可能你已经注意到Sample类的\_\_exit\_\_方法有三个参数- val, type 和 trace。 这些参数在异常处理中相当有用。我们来改一下代码，看看具体如何工作的。

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> <code>#!/usr/bin/env python</code> <code># with_example02.py</code> <code>class</code> <code>Sample:</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>__enter__(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>self</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;</code><code>def</code> <code>__exit__(</code><code>self</code><code>, </code><code>type</code><code>, value, trace):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code> <code>"type:"</code><code>, </code><code>type</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code> <code>"value:"</code><code>, value</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code> <code>"trace:"</code><code>, trace</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;</code><code>def</code> <code>do_something(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>bar </code><code>=</code> <code>1</code><code>/</code><code>0</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>bar </code><code>+</code> <code>10</code> <code>&nbsp;</code>&nbsp; <code>with Sample() as sample:</code> <code>&nbsp;&nbsp;</code><code>sample.do_something()</code> </td> 
 </tr> 
 </tbody> 
</table>

这个例子中，with后面的get\_sample()变成了Sample()。这没有任何关系，只要紧跟with后面的语句所返回的对象有\_\_enter\_\_()和\_\_exit\_\_()方法即可。此例中，Sample()的\_\_enter\_\_()方法返回新创建的Sample对象，并赋值给变量sample。

代码执行后：

> bash-3.2$ ./with\_example02.py 
> type: <type 'exceptions.ZeroDivisionError'> 
> value: integer division or modulo by zero 
> trace: <traceback object at 0x1004a8128> 
> Traceback (most recent call last): 
> File "./with\_example02.py", line 19, in <module> 
> sample.do\_something() 
> File "./with\_example02.py", line 15, in do\_something 
> bar = 1/0 
> ZeroDivisionError: integer division or modulo by zero

实际上，在with后面的代码块抛出任何异常时，\_\_exit\_\_()方法被执行。正如例子所示，异常抛出时，与之关联的type，value和stack trace传给\_\_exit\_\_()方法，因此抛出的ZeroDivisionError异常被打印出来了。开发库时，清理资源，关闭文件等等操作，都可以放在\_\_exit\_\_方法当中。

因此，Python的with语句是提供一个有效的机制，让代码更简练，同时在异常产生时，清理工作更简单。

**with-as语句**

从python2.6开始，with就成为默认关键字了。With是一个控制流语句，跟if for while try之类的是一类，with可以用来简化try-finally代码，看起来比try finally更清晰，所以说with用很优雅的方式处理上下文环境产生的异常。with关键字的用法如下：

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>with expression as variable:</code> <code>&nbsp;&nbsp;</code><code>with block</code> </td> 
 </tr> 
 </tbody> 
</table>

该代码快的执行过程是：

1.先执行expression，然后执行该表达式返回的对象实例的\_\_enter\_\_函数，然后将该函数的返回值赋给as后面的变量。(注意，是将\_\_enter\_\_函数的返回值赋给变量)

2.然后执行with block代码块，不论成功，错误，异常，在with block执行结束后，会执行第一步中的实例的\_\_exit\_\_函数

**with-as语句使用举例**

（1）打开文件的例子

with-as语句最常见的一个用法是打开文件的操作，如下：

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>with </code><code>open</code><code>(</code><code>"decorator.py"</code><code>) as </code><code>file</code><code>:</code> <code>&nbsp;&nbsp;</code><code>print</code> <code>file</code><code>.readlines()</code> </td> 
 </tr> 
 </tbody> 
</table>

（2）自定义

with语句后面的对象必须要有\_\_enter\_\_和\_\_exit\_\_方法，如下是一个自定义的例子：

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 </td> 
 <td> <code>class</code> <code>WithTest():</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>__init__(</code><code>self</code><code>,name):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.name </code><code>=</code> <code>name</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>pass</code> &nbsp; <code>&nbsp;&nbsp;</code><code>def</code> <code>__enter__(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code> <code>"This is enter function"</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>self</code> &nbsp; <code>&nbsp;&nbsp;</code><code>def</code> <code>__exit__(</code><code>self</code><code>,e_t,e_v,t_b):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code> <code>"Now, you are exit"</code> &nbsp; <code>&nbsp;&nbsp;</code><code>def</code> <code>playNow(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code> <code>"Now, I am playing"</code> &nbsp; <code>print</code> <code>"**********"</code> <code>with WithTest(</code><code>"coolboy"</code><code>) as test:</code> <code>&nbsp;&nbsp;</code><code>print</code> <code>type</code><code>(test)</code> <code>&nbsp;&nbsp;</code><code>test.playNow() </code> <code>&nbsp;&nbsp;</code><code>print</code> <code>test.name</code> <code>print</code> <code>"**********"</code> </td> 
 </tr> 
 </tbody> 
</table>

上述代码运行的结果如下：

> \*\*\*\*\*\*\*\*\*\* 
> This is enter function 
> <type 'instance'> 
> Now, I am playing 
> coolboy 
> Now, you are exit 
> \*\*\*\*\*\*\*\*\*\*

分析以上代码： 一二行，执行open函数，该函数返回一个文件对象的实例，然后执行了该实例的\_\_enter\_\_函数，该函数返回此实例本身，最后赋值给file变量。从456句可以印证。

自定义的类WithTest，重载了\_\_enter\_\_和\_\_exit\_\_函数，就可以实现with这样的语法了，注意在\_\_enter\_\_函数中，返回了self，在\_\_exit\_\_函数中，可以通过\_\_exit\_\_的返回值来指示with-block部分发生的异常是否需要reraise，如果返回false，则会reraise with block异常，如果返回ture，则就像什么也没发生。

**上下文管理器contextlib模块对with-as的支持**

contextlib 模块提供了3个对象：装饰器 contextmanager、函数 nested 和上下文管理器 closing。使用这些对象，可以对已有的生成器函数或者对象进行包装，加入对上下文管理协议的支持，避免了专门编写上下文管理器来支持 with 语句。

以contextlib的closing来说，closing帮助实现了\_\_enter\_\_和\_\_exit\_\_方法，用户不需要自己再实现这两个方法，但是被closing分装的对象必须提供close方法。contextlib.closing类的实现代码如下：

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>class</code> <code>closing(</code><code>object</code><code>):</code> <code>&nbsp;&nbsp;</code><code># help doc here</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>__init__(</code><code>self</code><code>, thing):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.thing </code><code>=</code> <code>thing</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>__enter__(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>self</code><code>.thing</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>__exit__(</code><code>self</code><code>, </code><code>*</code><code>exc_info):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.thing.close()</code> </td> 
 </tr> 
 </tbody> 
</table>

下面是一个使用contextlib.closing的例子：

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>import</code> <code>contextlib</code> <code>request_url </code><code>=</code> <code>(</code><code>'<a href="http://www.sina.com.cn/" rel="nofollow">http://www.sina.com.cn/</a>'</code><code>)</code> <code>with contextlib.closing(urlopen(request_url)) as response:</code> <code>&nbsp;&nbsp;</code><code>return</code> <code>response.read().decode(</code><code>'utf-8'</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

来源:[https://www.jb51.net/article/135285.htm][https_www.jb51.net_article_135285.htm]

[Link 1]: https://www.jb51.net/article/135285.htm#
[https_www.jb51.net_article_135285.htm]: https://www.jb51.net/article/135285.htm