布同自制Python函数帮助查询小工具
程序员文章站
2023-10-31 16:18:10
比如在学习list、tuple、dict、str、os、sys等模组的时候，利用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文件进行，保存数据
#保存原始
tofind = self.inputstr.get()
if len(tofind)==0:
return
filename='s_'+tofind+'.ini'
fout = open(filename,'w')
fout.write(self.text.get(1.0, end).encode('utf-8'))
fout.close()
self.items.append(tofind)
self.items.sort()
self.config.add_section(tofind)
self.config.write(open('data.ini', 'r+'))
nindex = self.items.index(tofind)
self.box.delete(0,end)
self.box.insert(0, *self.items)
self.box.see(nindex)
self.box.selection_set(nindex)
self.savebtn.config(state=disabled)
def saveas(self):
#保存修改
index = self.box.curselection()
if index<0:
return
tofind = self.box.get(index)
if len(tofind)==0:
return
strinfo = self.text.get(1.0, end)
filename='s_'+tofind+'.ini'
fout = open(filename,'w')
fout.write(strinfo.encode("utf-8"))
fout.close()
self.saveasbtn.config(state=disabled)
def __init__(self):
frame.__init__(self)
self.option_add('*font', 'verdana 12 bold')
self.pack(expand=yes, fill=both)
self.master.title(u'python函数查询器')
self.master.iconname("calc1")
#左侧列表，放置已保存的条目，按照字母顺序排序
infof = frame(self)
infof.pack(side=left,expand=no, fill=both)
listf = frame(infof)
listf.pack(side=top,expand=yes, fill=both)
#获取项目
self.config = configparser.configparser()
self.config.read('data.ini')
self.items = self.config.sections()
self.items.sort()
self.box = listbox(listf,width=15,selectmode=single)
self.box.insert(0, *self.items)
self.box.bind('<buttonrelease-1>',self.selectioncommand)#使用鼠标释放消息
self.box.bind('<buttonrelease-3>',self.boxrightmenu)#使用右键菜单删除项目
self.popupmenu=menu(listf)
self.popupmenu.add_command(label=u'删除',command=self.deleteitem)
self.popupmenu.add_command(label=u'重命名',command=self.renameitem)
self.box.pack(side=left,expand=yes,fill=both)
self.slbar = scrollbar(listf, orient=vertical, command=self.box.yview)
self.slbar.pack(side=right, expand=no, fill=both)
self.box.configure(yscrollcommand=self.slbar.set)
btnf = frame(infof)
btnf.pack(side=bottom, fill=both)
self.savebtn = button(btnf, text=u'新建保存',state=disabled, command=self.save)
self.savebtn.pack(side=left, expand=yes, fill=both)
self.saveasbtn = button(btnf, text=u'保存修改',state=disabled, command=self.saveas)
self.saveasbtn.pack(side=right, expand=yes, fill=both)
#包括列表信息和显示信息
twof = frame(self)
twof.pack(side=bottom, expand=yes, fill=both)
#显示信息、滚动条
showf = frame(twof, relief=sunken)
self.text = text(showf,height=25, width =65)
self.text.insert(1.0,'information...')
self.text.pack(side=left, expand=yes, fill=both)
self.text.bind("<key>", self.modify)
self.text.bind("<double-button-1>", self.tomodify)
self.ismodified = false
showf.pack(side=top,expand=yes, fill=both)
self.scrollbar = scrollbar(showf, orient=vertical, command=self.text.yview)
self.scrollbar.pack(side=right, expand=no, fill=both)
self.text.configure(yscrollcommand=self.scrollbar.set)
#提供输入接口，和功能如：查找
inputf = frame(twof)
inputf.pack(side=bottom, fill=both)
self.inputstr = stringvar()
self.inputstr.set('')
self.info = stringvar()
self.info.set('infomation...')
self.entry = entry(inputf, relief=sunken, textvariable=self.inputstr)
self.entry.bind("<return>", self.inputreturn)
self.entry.pack(side=left, expand=yes, fill=both)
self.findbtn = button(inputf,text=u'查找',command=self.onfind)
self.findbtn.pack(side=left, expand=yes, fill=both)
self.helpbtn = button(inputf,text=u'帮助',command=self.onhelp)
self.helpbtn.pack(expand=no, fill=y)
def onhelp(self):
fp = open('readme.txt')
buff = fp.read()
fp.close()
self.text.delete(1.0, end)
self.text.insert(1.0, buff)
self.helpbtn.config(state=disabled)
def deleteitem(self):
#右键菜单, 删除功能
sels = self.box.curselection()
if len(sels) == 0:
pass #print 'no selection'
else:
sec = self.items[int(sels[0])]
self.config.remove_section(sec)
self.config.write(open('data.ini', 'w'))
self.box.delete(sels[0])
# self.items.remove(sels[0]) #是引用效果
self.text.delete(1.0, end)
self.text.insert(1.0,'delete success.')
def renameitem(self,event=none,en=none):
#邮件菜单, 重命名功能
retval = askstring("input",
"input the new name:")
if len(retval)==0:
return
sels = self.box.curselection()
if len(sels) == 0:
pass #print 'no selection'
else:
#数组/表/配置文件
sec = self.items[int(sels[0])]
self.box.delete(0, end)
self.items[int(sels[0])] = retval #数组
self.items.sort()
self.box.insert(0, *self.items) #表
self.config.remove_section(sec)
self.config.add_section(retval)
self.config.write(open('data.ini', 'w')) #配置文件
self.text.delete(1.0, end)
self.text.insert(1.0,'rename success.')
def boxrightmenu(self,event=none,en=none):
#弹出右键菜单
self.popupmenu.tk_popup(*self.winfo_pointerxy())
def tomodify(self,event=none,en=none):
if self.ismodified==true:
self.saveasbtn.config(state=disabled)
self.ismodified = false
else:
self.saveasbtn.config(state=normal)
self.ismodified = true
return true
def modify(self,event=none,en=none):
self.saveasbtn.config(state=normal)
return true
def inputreturn(self,event=none,en=none):
self.onfind()
return true
def selectioncommand(self,event=none,en=none):
# 选中列表时, 显示详细内容
sels = self.box.curselection()
if len(sels) == 0:
pass
else:
filename='s_'+self.box.get(sels[0])+'.ini'
fp = open(filename)
strinfo = fp.read()
fp.close()
self.text.delete(1.0, end)
self.text.insert(1.0,strinfo)
self.helpbtn.config(state=normal)
if __name__ == '__main__':
finder().mainloop()
注意事项，源代码文件如果想要正确执行，请自己建立一个readme.txt文件，和data.ini文件。否则将会因为这两个文件打不开而出错。为什么没有使用异常处理呢？我没有没有完善到那一步。现在这个版本已经可以使用了，所以大家不防试试看。
想要完整的所有文件，请点击：附件下载 进行下载。
【注意】：打开软件后，请输入list、tuple、dict等类型进行查询，点击新建保存即可保存到列表，供下次快速打开。
有的包在源代码中没有包括，如codecs。这个时候你需要手动的将这个包添加到源文件的开头，才能够查询到，如：import codecs。
如果你修改了显示框中的文本，请及时点击保存修改进行保存，以便下次打开还可以看到你修改的效果。
本版本并不完善，而且功能有限，本身基于python做的，所以其价值还是作为python开发应用实例为主。
有修改意见请留言。
2011-03-10 12:15:05
有网友反映不能够正确执行这个源代码。我思考之后认为，跟版本应该没有关系，这些都是很基本的函数和用法。你如果不能够执行，请你尝试正确安装pmw和wx这两个包。
1、pmw的安装方式为：
下载：pmw.1.3.2.tar.gz。这个东西很好找，请百度一下即可。下载之后就地解压，找到其中的“pmw”目录，将这个目录复制到你pyhton的安装目录下即可，不需要其他具体的目录。直接是c:\python27\下就可以，其他的python版本请相应的做出调整。
2、wx的安装方式为：
下载：wxpython2.8-win32-unicode-2.8.11.0-py27.exe。这个东西请百度一下，估计到wxpython的官方的英文网站下载最好，很多中文网站也提供了下载，所以找到不是难事。双击进行默认方式的安装即可，你不用改变目录或者其他。它会自动的安装到你的安装目录下，我的目录是：c:\python27\lib\site-packages\wx-2.8-msw-unicode。
3、tkinter库已经系统集成，不需要安装。主要是上面两个库即可。
4、如何检验是否安装正确？
安装之后，请到python的command line中输入：import wx或者import pmw尝试是否输入正确。没有提示信息就是正确的。你还可以进一步看看包中的信息，输入如：dir（wx）或者dir（pmw）。不推荐使用help（）函数，正如我上面所说，wx的信息多达10mb之多，你是显示不完的，不断刷屏的效果估计你不会喜欢。
但是，当你离开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文件进行，保存数据
#保存原始
tofind = self.inputstr.get()
if len(tofind)==0:
return
filename='s_'+tofind+'.ini'
fout = open(filename,'w')
fout.write(self.text.get(1.0, end).encode('utf-8'))
fout.close()
self.items.append(tofind)
self.items.sort()
self.config.add_section(tofind)
self.config.write(open('data.ini', 'r+'))
nindex = self.items.index(tofind)
self.box.delete(0,end)
self.box.insert(0, *self.items)
self.box.see(nindex)
self.box.selection_set(nindex)
self.savebtn.config(state=disabled)
def saveas(self):
#保存修改
index = self.box.curselection()
if index<0:
return
tofind = self.box.get(index)
if len(tofind)==0:
return
strinfo = self.text.get(1.0, end)
filename='s_'+tofind+'.ini'
fout = open(filename,'w')
fout.write(strinfo.encode("utf-8"))
fout.close()
self.saveasbtn.config(state=disabled)
def __init__(self):
frame.__init__(self)
self.option_add('*font', 'verdana 12 bold')
self.pack(expand=yes, fill=both)
self.master.title(u'python函数查询器')
self.master.iconname("calc1")
#左侧列表，放置已保存的条目，按照字母顺序排序
infof = frame(self)
infof.pack(side=left,expand=no, fill=both)
listf = frame(infof)
listf.pack(side=top,expand=yes, fill=both)
#获取项目
self.config = configparser.configparser()
self.config.read('data.ini')
self.items = self.config.sections()
self.items.sort()
self.box = listbox(listf,width=15,selectmode=single)
self.box.insert(0, *self.items)
self.box.bind('<buttonrelease-1>',self.selectioncommand)#使用鼠标释放消息
self.box.bind('<buttonrelease-3>',self.boxrightmenu)#使用右键菜单删除项目
self.popupmenu=menu(listf)
self.popupmenu.add_command(label=u'删除',command=self.deleteitem)
self.popupmenu.add_command(label=u'重命名',command=self.renameitem)
self.box.pack(side=left,expand=yes,fill=both)
self.slbar = scrollbar(listf, orient=vertical, command=self.box.yview)
self.slbar.pack(side=right, expand=no, fill=both)
self.box.configure(yscrollcommand=self.slbar.set)
btnf = frame(infof)
btnf.pack(side=bottom, fill=both)
self.savebtn = button(btnf, text=u'新建保存',state=disabled, command=self.save)
self.savebtn.pack(side=left, expand=yes, fill=both)
self.saveasbtn = button(btnf, text=u'保存修改',state=disabled, command=self.saveas)
self.saveasbtn.pack(side=right, expand=yes, fill=both)
#包括列表信息和显示信息
twof = frame(self)
twof.pack(side=bottom, expand=yes, fill=both)
#显示信息、滚动条
showf = frame(twof, relief=sunken)
self.text = text(showf,height=25, width =65)
self.text.insert(1.0,'information...')
self.text.pack(side=left, expand=yes, fill=both)
self.text.bind("<key>", self.modify)
self.text.bind("<double-button-1>", self.tomodify)
self.ismodified = false
showf.pack(side=top,expand=yes, fill=both)
self.scrollbar = scrollbar(showf, orient=vertical, command=self.text.yview)
self.scrollbar.pack(side=right, expand=no, fill=both)
self.text.configure(yscrollcommand=self.scrollbar.set)
#提供输入接口，和功能如：查找
inputf = frame(twof)
inputf.pack(side=bottom, fill=both)
self.inputstr = stringvar()
self.inputstr.set('')
self.info = stringvar()
self.info.set('infomation...')
self.entry = entry(inputf, relief=sunken, textvariable=self.inputstr)
self.entry.bind("<return>", self.inputreturn)
self.entry.pack(side=left, expand=yes, fill=both)
self.findbtn = button(inputf,text=u'查找',command=self.onfind)
self.findbtn.pack(side=left, expand=yes, fill=both)
self.helpbtn = button(inputf,text=u'帮助',command=self.onhelp)
self.helpbtn.pack(expand=no, fill=y)
def onhelp(self):
fp = open('readme.txt')
buff = fp.read()
fp.close()
self.text.delete(1.0, end)
self.text.insert(1.0, buff)
self.helpbtn.config(state=disabled)
def deleteitem(self):
#右键菜单, 删除功能
sels = self.box.curselection()
if len(sels) == 0:
pass #print 'no selection'
else:
sec = self.items[int(sels[0])]
self.config.remove_section(sec)
self.config.write(open('data.ini', 'w'))
self.box.delete(sels[0])
# self.items.remove(sels[0]) #是引用效果
self.text.delete(1.0, end)
self.text.insert(1.0,'delete success.')
def renameitem(self,event=none,en=none):
#邮件菜单, 重命名功能
retval = askstring("input",
"input the new name:")
if len(retval)==0:
return
sels = self.box.curselection()
if len(sels) == 0:
pass #print 'no selection'
else:
#数组/表/配置文件
sec = self.items[int(sels[0])]
self.box.delete(0, end)
self.items[int(sels[0])] = retval #数组
self.items.sort()
self.box.insert(0, *self.items) #表
self.config.remove_section(sec)
self.config.add_section(retval)
self.config.write(open('data.ini', 'w')) #配置文件
self.text.delete(1.0, end)
self.text.insert(1.0,'rename success.')
def boxrightmenu(self,event=none,en=none):
#弹出右键菜单
self.popupmenu.tk_popup(*self.winfo_pointerxy())
def tomodify(self,event=none,en=none):
if self.ismodified==true:
self.saveasbtn.config(state=disabled)
self.ismodified = false
else:
self.saveasbtn.config(state=normal)
self.ismodified = true
return true
def modify(self,event=none,en=none):
self.saveasbtn.config(state=normal)
return true
def inputreturn(self,event=none,en=none):
self.onfind()
return true
def selectioncommand(self,event=none,en=none):
# 选中列表时, 显示详细内容
sels = self.box.curselection()
if len(sels) == 0:
pass
else:
filename='s_'+self.box.get(sels[0])+'.ini'
fp = open(filename)
strinfo = fp.read()
fp.close()
self.text.delete(1.0, end)
self.text.insert(1.0,strinfo)
self.helpbtn.config(state=normal)
if __name__ == '__main__':
finder().mainloop()
注意事项，源代码文件如果想要正确执行，请自己建立一个readme.txt文件，和data.ini文件。否则将会因为这两个文件打不开而出错。为什么没有使用异常处理呢？我没有没有完善到那一步。现在这个版本已经可以使用了，所以大家不防试试看。
想要完整的所有文件，请点击：附件下载 进行下载。
【注意】：打开软件后，请输入list、tuple、dict等类型进行查询，点击新建保存即可保存到列表，供下次快速打开。
有的包在源代码中没有包括，如codecs。这个时候你需要手动的将这个包添加到源文件的开头，才能够查询到，如：import codecs。
如果你修改了显示框中的文本，请及时点击保存修改进行保存，以便下次打开还可以看到你修改的效果。
本版本并不完善，而且功能有限，本身基于python做的，所以其价值还是作为python开发应用实例为主。
有修改意见请留言。
2011-03-10 12:15:05
有网友反映不能够正确执行这个源代码。我思考之后认为，跟版本应该没有关系，这些都是很基本的函数和用法。你如果不能够执行，请你尝试正确安装pmw和wx这两个包。
1、pmw的安装方式为：
下载：pmw.1.3.2.tar.gz。这个东西很好找，请百度一下即可。下载之后就地解压，找到其中的“pmw”目录，将这个目录复制到你pyhton的安装目录下即可，不需要其他具体的目录。直接是c:\python27\下就可以，其他的python版本请相应的做出调整。
2、wx的安装方式为：
下载：wxpython2.8-win32-unicode-2.8.11.0-py27.exe。这个东西请百度一下，估计到wxpython的官方的英文网站下载最好，很多中文网站也提供了下载，所以找到不是难事。双击进行默认方式的安装即可，你不用改变目录或者其他。它会自动的安装到你的安装目录下，我的目录是：c:\python27\lib\site-packages\wx-2.8-msw-unicode。
3、tkinter库已经系统集成，不需要安装。主要是上面两个库即可。
4、如何检验是否安装正确？
安装之后，请到python的command line中输入：import wx或者import pmw尝试是否输入正确。没有提示信息就是正确的。你还可以进一步看看包中的信息，输入如：dir（wx）或者dir（pmw）。不推荐使用help（）函数，正如我上面所说，wx的信息多达10mb之多，你是显示不完的，不断刷屏的效果估计你不会喜欢。