Python基础小知识问答系列-模块中函数名与doc

1. 问题:

        为了使用方便,将函数的相关信息写在文档字符串中,需要根据函数名,将使用信息自动生

成帮助信息提供给其他模块使用,该如何实现?

2. 解决方法:

        先获取模块中的函数名称,再根据函数名称获取对应的文档字符串。

  • 示例:
# 函数所在文件:demotest.py

import ast
import os


def test_demo_1():
    '''字符串文档: 样例函数1'''
    print("样例函数1--")


def test_demo_2():
    '''字符串文档: 样例函数2'''
    print("样例函数2--")


def get_function_doc(python_file_path):
    '''获取文档字符内容函数'''
    with open(python_file_path, 'r', encoding='utf-8') as file:
        content = file.read()
    tree = ast.parse(content)
    function_names = [node.name for node in ast.walk(tree) if isinstance(node, ast.FunctionDef)]
    function_doc = [globals()[item].__doc__ for item in function_names]
    return function_doc

# 使用文件
if __name__ == '__main__':
    print(get_function_doc(r"D:\codestore\practiseProject\demotest.py"))
  • 示例结果:

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值