82、Python之鸭子类型：一次搞懂with与上下文装饰器

南宫理的日知录

于 2024-09-27 06:15:00 发布

阅读量424

点赞数 15

分类专栏：好玩好用的Python 文章标签： python 开发语言学习编程学习

本文链接：https://blog.csdn.net/dqrcsc/article/details/142528894

版权

好玩好用的Python 专栏收录该内容

91 篇文章 0 订阅

订阅专栏

引言

在鸭子类型的理念的基础之上，从关注类型，转变到关注特性和行为。结合Python中的魔法函数的体系，我们可以将自定义的类型，像内置类型一样被使用。今天这篇文章中，接着该话题，继续聊一下with语法块，以及上下文管理器的概念。

本文的主要内容有：

1、什么是上下文管理器

2、with语句

3、利用魔法函数自定义上下文管理器

什么是上下文管理器

所谓“上下文管理器（Context Manager）”在Python中是一种用于管理资源的对象，其中定义了进入上下文和退出上下文的行为。

通过实现__enter__()和__exit__()两个魔术方法，上下文管理器可以更加简洁、安全地进行资源的管理。上下文管理器可以确保资源在使用完毕后被正确地释放，即便发生异常。

这种机制可以有效降低资源管理的复杂度，尤其是能够有效避免资源泄露和处理资源管理中的复杂异常场景等。

学习一个特性，首先必须要问的，一定是学这个东西有什么用。所以，接下来简单列举几个上下文管理器的使用场景：

1、文件操作：简化文件的打开、读写、关闭的操作流程，降低异常处理的复杂度，确保文件使用完毕后总能被正确关闭。

2、数据库连接：数据库连接也是比较昂贵的资源开销，上下文管理器同样可以确保数据库连接在使用完毕后被正确关闭，从而释放资源。

3、线程锁：在并发编程中，锁的获取和释放是很关键的，如果由于异常，导致锁未能正常释放，可能导致死锁或者无限期等待的发生。上下文管理器同样可以保证锁资源在使用完成后被正确地释放。

4、网络连接：网络连接需要在使用完毕后被关闭，以释放资源。

5、临时文件：有些场景中，需要创建临时文件，并在使用完成后，自动删除它，这时，也可以考虑使用上下文管理器，确保临时文件的正确删除。

6、计时器：通过上下文管理器，我们也可以实现代码执行时间的统计需求。

with语句

with语句的作用是简化上下文管理器的使用，确保资源能够被正确地管理和释放。它可以避免常见的资源管理的问题，比如由于异常导致的文件未能关闭或者锁资源未能正常释放等。

with语句的作用机制，是要集合上下文管理器的两个魔术方法来实现的。前面我们已经提及过，所有的魔术方法，本质上不需要我们手动调用，Python解释器在特定的场景中会自动调用相应的魔术方法。

简单描述一下with语句块的作用机制：

1、Python在执行到with语句时，会自动调用该上下文管理器的__enter__()方法，该方法通常用于资源的分配或者初始化。返回的对象会绑定到with语句的as子句后面的变量（如果有的话）。

2、当要离开with语句块时，Python解释器会自动调用该上下文管理器的__exit__()方法，该方法通常用于清理资源或者处理异常。如果在with语句块中发生了异常，这些异常信息也会传递给__exit__()方法。

利用魔法函数自定义上下文管理器

在鸭子类型理念的指导下，定义上下文管理器变得非常简单。只要一个对象具备了进入上下文的相应处理行为，以及退出上下文的相应处理行为。那么这个对象，就是一个上下文管理器。

接下来，结合前面列举的两个场景，以实际代码演示自定义上下文管理器：

1、临时文件

import os


class TempFile:
    def __init__(self, persist=False):
        self.persist = persist

    def __enter__(self):
        self.path = f'{hex(id(self))}.tmp'
        print(f'进入临时文件上下文，开始创建临时文件{self.path}')
        self.file = open(self.path, 'a+')
        return self

    def __exit__(self, exc_type, exc_val, exc_tb):
        print('准备退出临时文件上下文，开始清理资源')
        self.file.close()
        if not self.persist:
            os.remove(self.path)
            print(f'临时文件{self.path}被删除')

    def write(self, content):
        self.file.write(content)

    def read(self):
        return self.file.read()

    def seek(self, offset):
        self.file.seek(offset)


if __name__ == '__main__':
    # 不保存的临时文件
    with TempFile() as tf:
        tf.write('hello python')
        tf.seek(0)
        print(tf.read())
    # 保存的临时文件
    with TempFile(persist=True) as tf:
        tf.write('hello python')
        tf.seek(0)
        print(tf.read())

执行结果：

执行完成后，会发现第二个临时文件被保存了下来。

其实，Python中有现成的临时文件内置模块：tempfile，没必要我们自己来定义，通过代码简单演示一下：

import tempfile

# 删除的临时文件
with tempfile.NamedTemporaryFile('a+', delete=True) as tf:
    tf.write('hello python')
    tf.seek(0)
    print(tf.read())

# 保留的临时文件
with tempfile.NamedTemporaryFile('a+', delete=False) as tf:
    tf.write('hello python')
    tf.seek(0)
    print(tf.file.name)
    print(tf.read())

执行结果：

2、代码执行时间统计

import time


class Timer:
    def __enter__(self):
        print('开始执行')
        self.start = time.time()

    def __exit__(self, exc_type, exc_val, exc_tb):
        self.end = time.time()
        print('结束执行')
        print(f'总计耗时：{self.end - self.start:.2f}秒')


with Timer():
    print('假装在认真工作')
    time.sleep(2)

执行结果：