Python本地查询工具：自定义函数解决IDE帮助查找难题

75 浏览量更新于2024-08-29 收藏 97KB PDF 举报

本文主要讨论的是在使用Python编程过程中，尤其是在非命令行环境如IDLE或Komodo Edit进行“段式编程”时，查阅大型库如wx库的官方帮助文档遇到的困难。Python的内置文档虽然方便快捷，但在非交互式环境下查阅效率低下，尤其是面对大体积文档时。文章作者提出了两种解决方案： 1. 使用ModuleDocs工具：这是IDE自带的一种查询帮助文件的方式，它通过网页形式展示所有函数及其分类，但缺乏搜索功能，且生成的网页文件过大，对内存消耗较大，不利于频繁使用。 2. 自制Python函数帮助查询小工具：作者因为发现现有的工具不能满足需求，如wxPython API的英文文档描述不清晰，缺乏实用指导，因此决定自行开发一个查询工具。这个小工具的目标是提供一个简洁、易用的界面，允许用户快速查找Python模块和函数，包括详细的参数列表。作者分享了初级级别的源代码，鼓励其他人参与改进，并承诺会不断更新和完善，未来可能会有封装后的版本发布。通过这篇文章，读者可以了解到在Python学习和开发过程中，如何解决在非命令行环境中高效查阅API文档的问题，以及作者的亲身经验和技术分享，这对于Python开发者来说是一个实用的参考。

布同自制布同自制Python函数帮助查询小工具函数帮助查询小工具

比如在学习list、tuple、dict、str、os、sys等模组的时候，利用Python的自带文档可以很快速的全面的学到那些处理的函数。

所以这个自带文档功能能够给出学者带来很大的方便之处，进行简短的开发是再好不过的。

　　但是，当你离开CMD，要利用IDLE或者要用Komodo Edit等软件进行“段式编程”的时候，就有些捉襟见肘了。例如，wx

库非常之大，帮助文件有10MB之多，如果你在CMD中打开，你可以想想你需要多少时间才能够查看到你想要的帮助信息。大

规模的熟悉Python的各种API之后，你会发现，这个并不是想象的那么好用。不断的按任意键进行翻页，同时页面内能够容纳

的页面也有限。所以表现出非常大的不便之处。

　　这里大概有两种方法解决。

　　第一，使用　第一，使用Module Docs工具工具

　　这个工具是Python GUI IDLE自带的一个查询帮助文件的方法。在里面可以利用网页的形式，利用本机的本地功能，提供

一个模拟在线的一个查询方法。它可以打开一个网页，上面可以显示出所有的函数，并带有规范的分类，比较清楚，但是使用

起来还是不方便，毕竟没有搜索功能。如果将查到的网页内容保存链接，那么是不可以持续使用的。所以这个就有很大的问

题，同时，其生成的网页文件巨大，内存太小是会给系统带来压力。所以这个方法并不是一个可以很方便使用的方法。

　　第二，自己开发工具　　第二，自己开发工具

　　其实我也不愿意自己开发工具，因为这个毕竟需要时间，几天时间或者几个周的时间说少也少，说多也多，而且给自己的

内心产生的压力也不小，毕竟需要分心不少来做这个事情。我在网上找了很长时间，都没有找到，对于wx，我找到一个

wxPython API的英文文档，上面介绍的很不清楚，非常模糊，直接列出了函数和具体的参数，如何使用基本很少提及，而且

很多控件的各种style也没有详细列举出来。所以是很不好用的，如果是名字忘掉了，那还可以查一下完整的单词和详细的参

数列表。其他的功能就完全很少涉及到了。

　　鉴于此，我决定自己做一个小工具，花费较小的系统代价来方便的查询各种函数和模组的功能。这里只给出一个能使用的

版本。开放源代码给大家，代码风格和控件设计可供初学者模仿。高手愿意来批评我，我洗耳恭听。后续版本也会发布在这

里，到时候可能就先封装之后在发布，现在发布的这个是源代码文件，大家都知道，Python的源代码文件双击即可执行。

复制代码代码如下:

#coding=utf-8

#功能介绍：本软件最初只用于模块和函数用法的查询，进行快速的显示

#扩展功能：可以将查询成功的结果保存到本地，

# 将里面的部分函数使用汉语进行注释之后的结果保存下来

# 以保存的关键字放于右侧列表

#深度扩展：使用数据库保存结果，并提供增删查改的接口

from Tkinter import *

from StringIO import StringIO

from tkSimpleDialog import *

import sys

import Pmw

import ConfigParser

import os

import wx

class Finder(Frame):

def OnFind(self):

#执行，并获取结果

info = self.inputStr.get()

if len(info)==0:

return True

buff =StringIO()

temp = sys.stdout #保存标准I/O流

sys.stdout = buff #将标准I/O流重定向到buff对象

self.text.delete(1.0, END)

try:

fmt = ‘help(‘+info+’)’

result = eval(fmt)

self.text.insert(1.0, buff.getvalue())

self.savebtn.config(state=NORMAL)

except:

try:

__import__(info)

fmt = ‘help(‘+self.inputStr.get()+’)’

result = eval(fmt)

self.text.insert(1.0, buff.getvalue())

except:

self.text.insert(1.0,”ERROR.”)

sys.stdout =temp #恢复标准I/O流buff.getvaue()

self.helpbtn.config(state=NORMAL)

def save(self):

#搜索，如果没有找到就保存，使用ini文件进行，保存数据

下载后可阅读完整内容，剩余3页未读，立即下载

weixin_38641764

粉丝: 3
资源: 921

Python本地查询工具：自定义函数解决IDE帮助查找难题

Python函数速查表.zip

布同 Python中文问题解决方法（总结了多位前人经验，初学者必看）

布同 统计英文单词的个数的python代码

rip宣告网段选择版本

基于springboot+vue的学生选课系统（Java毕业设计，附源码，部署教程）.zip

基于BP神经网络的电力负荷预测-基于BP神经网络的短期电力负荷预测源码

基于springboot+vue的常规应急物资管理系统（Java毕业设计，附源码，部署教程）.zip

网站系统渗透测试报告.doc

I型NPC三电平逆变器 仿真 有三相逆变器参数设计，SVPWM，直流均压控制，双闭环控制说明文档（可加好友另算） SVPWM调制 中点电位平衡控制，LCL型滤波器 直流电压1200V，交流侧输出线电

燕山大学EDA综合实训实验报告.doc

最新资源

布同统计英文单词的个数的python代码

I型NPC三电平逆变器仿真有三相逆变器参数设计，SVPWM，直流均压控制，双闭环控制说明文档（可加好友另算） SVPWM调制中点电位平衡控制，LCL型滤波器直流电压1200V，交流侧输出线电