Python 基础教程

Python 高级教程

Python 相关应用

Python 笔记

Python as 关键字

Python 关键字 Python 关键字


Python中as保留字主要是两种用法,分别与import和with搭配使用。

import ... as ...

假如你嫌弃引入的包名称(模块)太长, 想要给它取个别名,以后每次用到它的时候都用它的别名代替它,这时就需要用到 import ... as ... ,例如:

import numpy as np

print(np.__version__)

with ... as ...

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

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

这里有两个问题。

  1. 可能忘记关闭文件句柄;
  2. 文件读取数据发生异常,没有进行任何处理;

下面是处理异常的加强版本:

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

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

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

with是如何工作的?

基本思想是with所求值的对象必须有一个__enter__()方法,一个__exit__()方法。

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

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

class Sample:
    def __enter__(self):
        print("In __enter__()")
        return "with ... as ..."

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


def get_sample():
    return Sample()


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

运行代码,输出如下:

In __enter__()
sample: with ... as ...
In __exit__()

具体的执行步骤如下:

  1. __enter__()方法被执行;
  2. __enter__()方法返回的值,这个例子中是 "with ... as ..." 赋值给变量 'sample';
  3. 执行代码块,打印变量"sample"的值为 "with ... as ...";
  4. __exit__()方法被调用;

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

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
        print(bar + 10)


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

代码执行后:

type: <class 'ZeroDivisionError'>
value: division by zero
trace: <traceback object at 0x10aa18548>
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: division 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关键字的用法如下:

with expression as variable:
  with block

该代码快的执行过程是:

  1. 先执行expression,然后执行该表达式返回的对象实例的__enter__函数,然后将该函数的返回值赋给as后面的变量。(注意,是将__enter__函数的返回值赋给变量);
  2. 然后执行with block代码块,不论成功,错误,异常,在with block执行结束后,会执行第一步中的实例的__exit__函数;