Python上下文管理器類和上下文管理器裝飾器contextmanager用法實例分析

更新時間：2019年11月07日 09:22:02 作者：weixin_42359464

這篇文章主要介紹了Python上下文管理器類和上下文管理器裝飾器contextmanager用法,結合實例形式分析了上下文管理器類定義、使用、sqlalchemy實現數據庫的自動提交和回滾相關操作技巧,需要的朋友可以參考下

一. 什么是上下文管理器

上下文管理器是在Python2.5之后加入的功能，可以在方便的需要的時候比較精確地分配和釋放資源, with便是上下文管理器的最廣泛的應用, 比如:

with open("test/test.txt","w") as f:
 f.write("hello")

這上會比使用try:...finally:f.close方便的多.

二. 自定義一個上下文管理器類:

class MyResource:
  # __enter__ 返回的對象會被with語句中as后的變量接受
  def __enter__(self):
    print('connect to resource')
    return self

  def __exit__(self, exc_type, exc_value, tb):
    print('close resource conection')

  def query(self):
    print('query data')

類中有兩個特殊的魔術方法:

__enter__: with語句中的代碼塊執(zhí)行前, 會執(zhí)行__enter__, 返回的值將賦值給with句中as后的變量.
__exit__: with語句中的代碼塊執(zhí)行結束或出錯, 會執(zhí)行_exit__

比如以下代碼:

with Myresource() as r:
  r.query()

的打印結果為:

connect to resource
query data
close resource conection

那么有沒有一個簡化定義的方法呢, python提供了一個裝飾器contextmanager

三. 使用contextmanager

from contextlib import contextmanager
class MyResource:
  def query(self):
    print('query data')
@contextmanager
def make_myresource():
  print('start to connect')
  yield MyResource()
  print('end connect')
  pass

被裝飾器裝飾的函數分為三部分:

with語句中的代碼塊執(zhí)行前執(zhí)行函數中yield之前代碼
yield返回的內容復制給as之后的變量
with代碼塊執(zhí)行完畢后執(zhí)行函數中yield之后的代碼

比如下方代碼:

with make_myresource() as r:
   r.query()

的結果為:

start to connect
query data
end connect

四. 一個例子, sqlalchemy: 數據庫的自動提交和回滾

在編程中如果頻繁的修改數據庫, 一味的使用類似try:... except..: rollback() raise e其實是不太好的.

比如某一段的代碼的是這樣的:

  try:
    gift = Gift()
    gift.isbn = isbn
    ... 
    db.session.add(gift)
    db.session.commit()
  except Exception as e:
    db.session.rollback()
    raise e

為了達到使用with語句的目的, 我們可以重寫db所屬的類:

from flask_sqlalchemy import SQLAlchemy as _SQLALchemy
class SQLAlchemy(_SQLALchemy):
  @contextmanager
  def auto_commit(self):
    try:
      yield
      self.session.commit()
    except Exception as e:
      db.session.rollback()
      raise e

這時候, 在執(zhí)行數據的修改的時候便可以:

 with db.auto_commit():
    gift = Gift()
    gift.isbn = isbndb.session.add(gift)
    db.session.add(gift)

with db.auto_commit():
  user = User()
  user.set_attrs(form.data)
  db.session.add(user)

關于Python相關內容感興趣的讀者可查看本站專題：《Python函數使用技巧總結》、《Python面向對象程序設計入門與進階教程》、《Python數據結構與算法教程》、《Python字符串操作技巧匯總》、《Python編碼操作技巧總結》及《Python入門與進階經典教程》

希望本文所述對大家Python程序設計有所幫助。

您可能感興趣的文章: