Python学习笔记__12.8章 contextlib

Posted 2020-11-05

# 这是学习廖雪峰老师python教程的学习笔记

1、概览

在Python中，读写文件这样的资源要特别注意，必须在使用完毕后正确关闭它们。正确关闭文件资源的一个方法是使用try...finally，还有一个方法就是with。

但并不是只有open()函数返回的fp对象才能使用with语句。实际上，任何对象，只要正确实现了上下文管理，就可以用于with语句。

1.1、实现上下文管理

实现上下文管理是通过__enter__和__exit__这两个方法实现的

class Query(object):

 

    def __init__(self, name):  #初始化实例

        self.name = name

 

    def __enter__(self): #程序运行前要做的，返回的是实例名

        print('Begin')

        return self

    # 程序结束后要做的，type是错误类型，vlaue是错误的值，traceback是追溯至错误处

    def __exit__(self, exc_type, exc_value, traceback):

        if exc_type: # 如果报错，打印Error

            print('Error')

        else:

            print('End')

 

    def query(self): # 要调用的函数

        print('Query info about %s...' % self.name)

# with语句调用

with Query('Bob') as q:  #定义name为Bob的实例

    q.query()  #调用query()方法

1.2、@contextmanager

编写__enter__和__exit__仍然很繁琐，因此Python的标准库contextlib提供了更简单的写法

from contextlib import contextmanager

 

class Query(object):

 

    def __init__(self, name):

        self.name = name

 

    def query(self):

        print('Query info about %s...' % self.name)

 

# @contextmanager这个decorator接受一个generator，用yield语句把with function as var输出出去，然后，with语句就可以正常地工作了

@contextmanager

def create_query(name):

    print('Begin')  # 相当于__enter__

    q = Query(name)

    yield q  #yield 语句将调用with 语句 内部的所有语句

    print('End')  # 相当于__exit__

# with 语句

with create_query('Bob') as q:

    q.query()

@contextmanager 也可被用来在某段代码执行前后自动执行特定代码。

 

@contextmanager和with语句的执行过程：

1）with语句首先执行yield之前的语句，会打印出"Begin"

2）yield调用会执行with语句内部的所有语句，会执行函数query()

3）最后执行yield之后的语句，会打印"End"

 

1.3、@closing

如果一个对象没有实现上下文，我们就不能把它用于with语句。这个时候，可以用closing()来把该对象变为上下文对象。它的作用就是把任意对象变为上下文对象，并支持with语句。

例如：用with语句使用urlopen()

from contextlib import closing

from urllib.request import urlopen

 

with closing(urlopen('https://www.python.org')) as page: #urlopen()函数用于实现对目标url的访问

    for line in page:

        print(line)

 

# closing实际上是一个经过@contextmanager装饰的generator

@contextmanager

def closing(thing):

    try:

        yield thing   # 执行with内部语句

    finally:

        thing.close()