python __enter__ 与 __exit__的作用,以及与 with 语句的关系

本文深入探讨了Python中with语句的工作原理,解释了其如何简化资源管理和异常处理过程,尤其是在文件操作等需要预处理和后处理的场景下。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

转载自:http://linbo.github.io/2013/01/08/python-with/ 

With语句是什么?

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

如果不用with语句,代码如下:

file = open("/tmp/foo.txt")
data = file.read()
file.close()

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

file = open("/tmp/foo.txt")
try:
    data = file.read()
finally:
    file.close()

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

with open("/tmp /foo.txt") as file:
    data = file.read()

with如何工作?

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

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

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

#!/usr/bin/env python
# with_example01.py

class Sample:
    def __enter__(self):
        print "In __enter__()"
        return "Foo"

    def __exit__(self, type, value, trace):
        print "In __exit__()"


def get_sample():
    return Sample()


with get_sample() as sample:
    print "sample:", sample

输出如下

bash-3.2$ ./with_example01.py
In __enter__()
sample: Foo
In __exit__()

正如你看到的,

__enter__()方法被执行
__enter__()方法返回的值 - 这个例子中是"Foo",赋值给变量'sample'
执行代码块,打印变量"sample"的值为 "Foo"
__exit__()方法被调用

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

#!/usr/bin/env python
# with_example02.py


class Sample:
    def __enter__(self):
        return self

    def __exit__(self, type, value, trace):
        print "type:", type
        print "value:", value
        print "trace:", trace

    def do_something(self):
        bar = 1/0
        return bar + 10

with Sample() as sample:
    sample.do_something()

这个例子中,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_somet hing()
  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语句是提供一个有效的机制,让代码更简练,同时在异常产生时,清理工作更简单。

`__enter__`和`__exit__`是Python中用于上下文管理器的特殊方法。 `__enter__`方法在进入上下文管理器时被调用,它返回一个值,该值将被赋给`as`关键字后面的变量。通常,在`__enter__`方法中,我们会执行一些准备工作,例如打开文件、建立数据库连接等。 `__exit__`方法在离开上下文管理器时被调用,它接收三个参数:异常类型、异常值和追溯信息。如果在上下文中没有发生异常,那么这三个参数都为None。如果在上下文中发生了异常,那么这三个参数将包含异常的相关信息。在`__exit__`方法中,我们可以执行一些清理工作,例如关闭文件、断开数据库连接等。 下面是一个使用上下文管理器的示例: ```python class MyContextManager: def __enter__(self): print("Entering the context") return "Hello" def __exit__(self, exc_type, exc_value, traceback): print("Exiting the context") if exc_type is not None: print(f"Exception: {exc_type}, {exc_value}") with MyContextManager() as value: print(value) ``` 输出结果为: ``` Entering the context Hello Exiting the context ``` 在这个示例中,`MyContextManager`是一个自定义的上下文管理器类。在`__enter__`方法中,我们打印了进入上下文的消息,并返回了一个字符串"Hello"。在`__exit__`方法中,我们打印了离开上下文的消息,并检查是否有异常发生。 在`with`语句中,我们创建了一个`MyContextManager`的实例,并将其赋值给`value`变量。在进入上下文时,`__enter__`方法被调用,打印了"Entering the context",并返回了"Hello"。然后,我们打印了`value`的值,即"Hello"。最后,在离开上下文时,`__exit__`方法被调用,打印了"Exiting the context"。 通过使用上下文管理器,我们可以确保在进入和离开上下文时执行必要的操作,并且可以处理可能发生的异常。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值