Python  inspect 模块的简单使用及常用方法

 更新时间:2024年03月28日 08:57:10   作者:小菠萝测试笔记  
Python的inspect模块是一个强大的内省工具,允许开发者检查(inspect)活动对象和源代码,这篇文章主要介绍了Python inspect 模块的简单使用及常用方法,需要的朋友可以参考下

Python中的inspect模块解析

Python的inspect模块是一个强大的内省工具,允许开发者检查(inspect)活动对象和源代码。它提供了一系列函数,用于获取信息关于正在运行的程序和调用堆栈,非常适合进行调试和动态分析。本文将通过介绍inspect模块的关键功能,并结合实际案例代码,来探索其在日常开发中的应用。

常用方法

1. 获取当前执行的函数或方法名、文件路径【并不是调用方】

在日志记录或调试时,知道当前执行的函数名是非常有用的

import inspect
def who_am_i():
    # 输出当前文件绝对路径
    print(inspect.currentframe().f_code.co_filename)
    return inspect.currentframe().f_code.co_name
print(who_am_i())  # 输出: who_am_i

个人认为比较有用的就是 co_filename、co_name

2. 获取调用者信息

获取当前函数或方法的调用者信息

import inspect
def caller_info():
    frame = inspect.currentframe().f_back
    print(f调用者 {frame.f_code.co_filename} 调用行号 d{frame.f_lineno}")
def test():
    caller_info()  # 调用以获取调用者信息
test()

这个例子显示了如何获取调用当前函数的代码位置,非常有助于调试复杂的调用链

3. 查看函数参数

inspect模块可以用来检查函数或方法的参数,这对于动态分析和生成文档非常有用

import inspect
def sample_function(name, age=25):
    pass
sig = inspect.signature(sample_function)
print(sig)  # 输出: (name, age=25)

4. 获取源代码

inspect还可以用来获取函数、类或模块的源代码

import inspect
def my_function():
    """A simple function."""
    pass
print(inspect.getsource(my_function))

5. 检查类和实例

inspect模块提供了多种方式来检查类和实例,比如获取类的所有方法、属性等

class MyClass:
    def method_one(self):
        pass
    def method_two(self):
        pass
# 获取类的所有成员方法
methods = inspect.getmembers(MyClass, predicate=inspect.isfunction)
print(methods)  # 输出 MyClass 中定义的方法

实际案例:自动化场景下的应用

一个常见的使用场景是动态地调用函数或方法,并基于它们的签名自动生成文档。

def test():
    # 获取调用方
    frame = inspect.currentframe().f_back
    # 获取调用方文件绝对路径
    caller_file = inspect.getfile(frame)
    # 这种方式也可以
    caller_file = frame.f_code.co_filename
    ...
    params = [
        caller_file,
        "--env-data",
        env_data.json(),
        f"--count={count}",
        "-m",
        mark,
    ]

一个基于 Pytest 自动化测试项目

  • 每个 py 模块都会调用这个方法来执行 Pytest 命令来跑测试用例
  • 那怎么才能准确知道要跑哪个文件呢?
  • 通过第一、二行代码即可

到此这篇关于Python - inspect 模块的简单使用的文章就介绍到这了,更多相关Python  inspect 模块内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 深入理解python函数递归和生成器

    深入理解python函数递归和生成器

    下面小编就为大家带来一篇深入理解python函数递归和生成器。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-06-06
  • python之pyinstaller组件打包命令和异常解析实战

    python之pyinstaller组件打包命令和异常解析实战

    前段时间在制作小工具的时候,直接在命令行用pyinstaller工具打包成功后,启动exe可执行文件的时候各种报错, 今天,我们就分享一下踩坑经过,需要的朋友可以参考下
    2021-09-09
  • Python 实现驱动AI机器人

    Python 实现驱动AI机器人

    这篇文章主要介绍了Python 实现驱动AI机器人,下文围绕利用Python 实现驱动AI机器人的相关资料展开内容,需要的小伙伴可以参考一下
    2022-02-02
  • Python写的一个定时重跑获取数据库数据

    Python写的一个定时重跑获取数据库数据

    本文给大家分享基于python写的一个定时重跑获取数据库数据的方法,非常不错,具有参考借鉴价值,需要的朋友参考下
    2016-12-12
  • Python机器学习之KNN近邻算法

    Python机器学习之KNN近邻算法

    KNN可以说是最简单的分类算法之一,同时,它也是最常用的分类算法,文中非常详细的介绍了该算法,对正在学习python的小伙伴们有很好的帮助,需要的朋友可以参考下
    2021-05-05
  • Django框架教程之正则表达式URL误区详解

    Django框架教程之正则表达式URL误区详解

    正则表达式对大家来说应该都不陌生,下面这篇文章主要给大家介绍了关于Django框架教程之正则表达式URL误区的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考借鉴,下面随着小编来一起学习学习吧。
    2018-01-01
  • Python2与Python3的区别实例总结

    Python2与Python3的区别实例总结

    这篇文章主要介绍了Python2与Python3的区别,结合实例形式总结分析了Python2与Python3打印输出、编码、数值运算、异常处理等使用区别,需要的朋友可以参考下
    2019-04-04
  • Python实现softmax反向传播的示例代码

    Python实现softmax反向传播的示例代码

    这篇文章主要为大家详细介绍了Python实现softmax反向传播的相关资料,文中的示例代码讲解详细,具有一定的参考价值,感兴趣的可以了解一下
    2023-04-04
  • Django-xadmin+rule对象级权限的实现方式

    Django-xadmin+rule对象级权限的实现方式

    今天小编就为大家分享一篇Django-xadmin+rule对象级权限的实现方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-03-03
  • pytest框架之fixture详细使用详解

    pytest框架之fixture详细使用详解

    这篇文章主要介绍了pytest框架之fixture详细使用详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04

最新评论