Python中类的魔术方法之上下文管理

2024-08-24 13:48

本文主要是介绍Python中类的魔术方法之上下文管理,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • Python中类的魔术方法之上下文管理
    • 上下文管理
    • 上下文管理对象与管理的安全
    • 上下文应用场景
    • contextlib.countextmanager上下文管理装饰器

Python中类的魔术方法之上下文管理

上下文管理

文件IO操作可以对文件对象使用上下文管理,使用with…as语法。
示例:

with open("text") as f:pass

仿照上面例子写一个自己的类,实现上下文管理

class Point:passwith Point() as p: AttributeError:__exit__pass

提示属性错误,没有__exit__,看了需要这个属性
某些版本会显示没有__enter__

上下文管理对象与管理的安全

当一个对象同时实现了__enter__()__exit__()方法,它就属于上下文管理的对象

方法等价语法意义
__enter__(self)with obj() as c:pass进入语句块之前执行进入与此对象相关的上下文,如果存在该方法,with语法会把该方法的返回值绑定到as子句中指定的变量上
__exit__(self, exc_type, exc_value, traceback)with obj() as c:pass退出时执行退出与此对象相关的上下文。时执行

简单示例:

class Point:def __init__(self):print("init------------")def __enter__(self):print("enter~~~~~~~~~~~~")return "abc" #返回值决定了as 后面变量的值def __exit__(self,exc_type,exc_val,exc_tb):print("exit ================")with Point() as p:print("with in p = {}".format(p))

class5_001

  • 调用步骤:
    1. 先实例化with语句后面的对象obj。
    2. 调用对象obj中的__enter__(self)方法。如果有 as 语句将__enter__方法的返回值赋值该as后面的变量。
    3. 执行with下面面的语句体
    4. 离开with语句块的时候,调用__exit__(self,exc_type,exc_val,exc_tb)方法。如果with语句体内执行时发生异常,会被捕获并传入__exit__(self,exc_type,exc_val,exc_tb)的参数中。如果__exit__的返回值为等效于False表示不压制异常。反之压制异常。
  • 注意:with并不会开启一个新的作用域。
  • 方法参数
    1. __enter__(self)#方法没有其他参数。
    2. __exit__(self,exc_type,exc_value,exc_tb) #有3个参数
      • 如果没有异常,3个参数的值都为None,如果有异常,参数意义如下:
      • exc_type #异常类型
      • exc_value #异常的值
      • exc_tb #异常的追踪信息
      • 返回值:等效True的值为压制异常;否则,继续抛出异常

示例:演示异常

class Point:def __init__(self):print("init ----------")def __enter__(self):print("enter @@@@@@@@@@")return self #增加返回值def __exit__(self, exc_type, exc_val, exc_tb):print(1,exc_type)print(2,exc_val)print(3,exc_tb)print("exit ==============")# return ""return "a"with Point() as p:print("in with ------------")raise Exception("error")print("with over")print("执行完成。。。。")

class5_002

示例:用类来做装饰器,实现运行时间统计

import time,functools,datetimeclass Xdd_Timeit:"""时间统计类,也可以作为装饰器单独统计单个函数运行时长"""def __init__(self,fn):"""初始化方法:param fn: 需要统计的函数"""functools.update_wrapper(self,fn)self.fn = fnself.starttime = Noneself.stoptime = None#with语句开始时默认调用的方法def __enter__(self):self.starttime = datetime.datetime.now()return self#with语句结束后默认调用的方法def __exit__(self, exc_type, exc_val, exc_tb):self.stoptime = datetime.datetime.now()print("{} 总运行时长:{}".format(self.fn.__name__,(self.stoptime-self.starttime).total_seconds()))#使得类对象是个可调用函数def __call__(self, *args, **kwargs):start = datetime.datetime.now()sum = self.fn(*args, **kwargs)sound = datetime.datetime.now() - startprint("{} 运行时长:{}".format(self.fn.__name__,sound.total_seconds()))return sum@Xdd_Timeit
def add(x,y):time.sleep(1)return x+ywith Xdd_Timeit(add) as a:print(a(4,5),a(5,6),a(7,8))print(add(4,5),add(5,6),add(7,8))

class5_003

上下文应用场景

  1. 增强功能
    • 在代码执行的前后增加代码,以增强其功能。类似装饰器的功能。
  2. 资源管理
    • 打开了资源需要关闭,例如文件对象、网络连接、数据库连接等
  3. 权限验证
    • 在执行代码之前,做权限的验证,在 enter 中处理

contextlib.countextmanager上下文管理装饰器

  1. contextlib.contextmanager
    • 它是一个装饰器实现上下文管理,装饰一个函数,而不是像类一样实现__enter____exit__方法。
    • 对装饰的函数有要求:必须有yield,也就是这个函数必须返回一个生成器,且只有yield一个值。
from contextlib import contextmanager@contextmanager
def foo():print("enter") #相当于__enter__()yield 5  #yield 的值只能有一个,作为__enter__的返回值print("exit") #相当于__exit__()with foo() as f:print("with start-------")print(f)print("with stop----------")

class5_004

  • f接受yield的返回值。
  • 如果with中有异常,那么上面例子中不能保证exit的执行。需要在foo函数中增加try finally
from contextlib import contextmanager@contextmanager
def foo():print("enter")try:yield 5except :print("异常被捕获")finally:print("exit")with foo() as f:print(f)raise Exception()

class5_005

  1. 当yield发生处为生成器函数增加了上下文管理。这是为函数增加上下文机制的方式。
    • 把yield之前的当做__enter__方法执行
    • 把yield之后的当做__exit__方法执行
    • 把yield的值作为__enter__的返回值
  • 应用举例:实现时间统计
from contextlib import contextmanager
import datetime,time@contextmanager
def foo(fn):start = datetime.datetime.now()try:yield fnexcept:raisefinally:stop = (datetime.datetime.now()- start).total_seconds()print("运行时长:{}".format(stop))def add(x,y):time.sleep(1)return x+ywith foo(add) as a:print(a(2,3),a(1,2))print(add(4,5),add(5,6))

class5_006

  • 总结:
    如果业务逻辑简单可以使用函数加contextlib.contextmanager装饰器方式,如果业务复杂,用类的方式加 __enter____exit__ 方法方便

这篇关于Python中类的魔术方法之上下文管理的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1102654

相关文章

python常见环境管理工具超全解析

《python常见环境管理工具超全解析》在Python开发中,管理多个项目及其依赖项通常是一个挑战,下面:本文主要介绍python常见环境管理工具的相关资料,文中通过代码介绍的非常详细,需要的朋友... 目录1. conda2. pip3. uvuv 工具自动创建和管理环境的特点4. setup.py5.

Python常用命令提示符使用方法详解

《Python常用命令提示符使用方法详解》在学习python的过程中,我们需要用到命令提示符(CMD)进行环境的配置,:本文主要介绍Python常用命令提示符使用方法的相关资料,文中通过代码介绍的... 目录一、python环境基础命令【Windows】1、检查Python是否安装2、 查看Python的安

Python UV安装、升级、卸载详细步骤记录

《PythonUV安装、升级、卸载详细步骤记录》:本文主要介绍PythonUV安装、升级、卸载的详细步骤,uv是Astral推出的下一代Python包与项目管理器,主打单一可执行文件、极致性能... 目录安装检查升级设置自动补全卸载UV 命令总结 官方文档详见:https://docs.astral.sh/

Python并行处理实战之如何使用ProcessPoolExecutor加速计算

《Python并行处理实战之如何使用ProcessPoolExecutor加速计算》Python提供了多种并行处理的方式,其中concurrent.futures模块的ProcessPoolExecu... 目录简介完整代码示例代码解释1. 导入必要的模块2. 定义处理函数3. 主函数4. 生成数字列表5.

Python中help()和dir()函数的使用

《Python中help()和dir()函数的使用》我们经常需要查看某个对象(如模块、类、函数等)的属性和方法,Python提供了两个内置函数help()和dir(),它们可以帮助我们快速了解代... 目录1. 引言2. help() 函数2.1 作用2.2 使用方法2.3 示例(1) 查看内置函数的帮助(

Python虚拟环境与Conda使用指南分享

《Python虚拟环境与Conda使用指南分享》:本文主要介绍Python虚拟环境与Conda使用指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、python 虚拟环境概述1.1 什么是虚拟环境1.2 为什么需要虚拟环境二、Python 内置的虚拟环境工具

Python实例题之pygame开发打飞机游戏实例代码

《Python实例题之pygame开发打飞机游戏实例代码》对于python的学习者,能够写出一个飞机大战的程序代码,是不是感觉到非常的开心,:本文主要介绍Python实例题之pygame开发打飞机... 目录题目pygame-aircraft-game使用 Pygame 开发的打飞机游戏脚本代码解释初始化部

Python pip下载包及所有依赖到指定文件夹的步骤说明

《Pythonpip下载包及所有依赖到指定文件夹的步骤说明》为了方便开发和部署,我们常常需要将Python项目所依赖的第三方包导出到本地文件夹中,:本文主要介绍Pythonpip下载包及所有依... 目录步骤说明命令格式示例参数说明离线安装方法注意事项总结要使用pip下载包及其所有依赖到指定文件夹,请按照以

Python实现精准提取 PDF中的文本,表格与图片

《Python实现精准提取PDF中的文本,表格与图片》在实际的系统开发中,处理PDF文件不仅限于读取整页文本,还有提取文档中的表格数据,图片或特定区域的内容,下面我们来看看如何使用Python实... 目录安装 python 库提取 PDF 文本内容:获取整页文本与指定区域内容获取页面上的所有文本内容获取

基于Python实现一个Windows Tree命令工具

《基于Python实现一个WindowsTree命令工具》今天想要在Windows平台的CMD命令终端窗口中使用像Linux下的tree命令,打印一下目录结构层级树,然而还真有tree命令,但是发现... 目录引言实现代码使用说明可用选项示例用法功能特点添加到环境变量方法一:创建批处理文件并添加到PATH1