Mikaela
/
Limnoria
mirror of https://github.com/Mikaela/Limnoria.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Made pydoc accept methods on builtin classes.

This commit is contained in:
Jeremy Fincher 2003-10-20 06:43:59 +00:00
parent e760320ca0
commit 2d56e7257e
2 changed files with 36 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
plugins/Python.py
View File

@ -49,6 +49,7 @@ sys.stdout = StringIO()
import this import this
sys.stdout = sys.__stdout__ sys.stdout = sys.__stdout__
import debug
import utils import utils
import privmsgs import privmsgs
import callbacks import callbacks
@ -77,40 +78,52 @@ class Python(callbacks.Privmsg):
Returns the __doc__ string for a given Python function. Returns the __doc__ string for a given Python function.
""" """
def normalize(s):
return utils.normalizeWhitespace(s.replace('\n\n', '.'))
funcname = privmsgs.getArgs(args) funcname = privmsgs.getArgs(args)
if funcname.translate(string.ascii, self.modulechars) != '': if funcname.translate(string.ascii, self.modulechars) != '':
irc.error('That\'s not a valid module or function name.') irc.error('That\'s not a valid module or function name.')
return return
if '.' in funcname: if '.' in funcname:
parts = funcname.split('.') parts = funcname.split('.')
functionName = parts.pop() if len(parts) == 2 and parts[0] in __builtins__:
path = pythonPath (objectname, methodname) = parts
for name in parts: obj = __builtins__[objectname]
try: if hasattr(obj, methodname):
info = imp.find_module(name, path) obj = getattr(obj, methodname)
newmodule = imp.load_module(name, *info) if hasattr(obj, '__doc__'):
path = [os.path.dirname(newmodule.__file__)] irc.reply(msg, obj.__doc__)
info[0].close() else:
except ImportError: irc.reply(msg, '%s has no documentation' % funcname)
irc.error(msg, 'No such module %s exists.' % name)
return
if hasattr(newmodule, functionName):
f = getattr(newmodule, functionName)
if hasattr(f, '__doc__'):
s = f.__doc__.replace('\n\n', '. ')
s = utils.normalizeWhitespace(s)
irc.reply(msg, s)
else: else:
irc.error(msg, 'That function has no documentation.') irc.reply(msg, '%s has no method %s' % (parts[0],parts[1]))
else: else:
irc.error(msg, 'That function doesn\'t exist.') functionName = parts.pop()
path = pythonPath
for name in parts:
try:
info = imp.find_module(name, path)
newmodule = imp.load_module(name, *info)
path = [os.path.dirname(newmodule.__file__)]
info[0].close()
except ImportError:
irc.error(msg, 'No such module %s exists.' % name)
return
if hasattr(newmodule, functionName):
f = getattr(newmodule, functionName)
if hasattr(f, '__doc__'):
s = f.__doc__.replace('\n\n', '. ')
s = utils.normalizeWhitespace(s)
irc.reply(msg, s)
else:
irc.error(msg, 'That function has no documentation.')
else:
irc.error(msg, 'That function doesn\'t exist.')
else: else:
try: try:
f = __builtins__[funcname] f = __builtins__[funcname]
if hasattr(f, '__doc__'): if hasattr(f, '__doc__'):
s = f.__doc__.replace('\n\n', '. ') irc.reply(msg, normalize(f.__doc__))
s = utils.normalizeWhitespace(s)
irc.reply(msg, s)
else: else:
irc.error(msg, 'That function has no documentation.') irc.error(msg, 'That function has no documentation.')
except SyntaxError: except SyntaxError:

1
test/test_Python.py
View File

@ -39,6 +39,7 @@ class PythonTestCase(PluginTestCase, PluginDocumentation):
self.assertError('pydoc foobar') self.assertError('pydoc foobar')
self.assertError('pydoc assert') self.assertError('pydoc assert')
self.assertNotError('pydoc str') self.assertNotError('pydoc str')
self.assertNotError('pydoc list.reverse')
if os.name == 'posix': if os.name == 'posix':
self.assertNotRegexp('pydoc crypt.crypt', 'NameError') self.assertNotRegexp('pydoc crypt.crypt', 'NameError')
self.assertNotError('pydoc crypt.crypt') self.assertNotError('pydoc crypt.crypt')